Package com.commercetools.api.client
Class ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartGet
java.lang.Object
io.vrap.rmf.base.client.ApiMethod<T,TResult>
io.vrap.rmf.base.client.TypeApiMethod<ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartGet,ShippingMethodPagedQueryResponse>
com.commercetools.api.client.ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartGet
- All Implemented Interfaces:
Deprecatable200Trait<ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartGet>
,ErrorableTrait<ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartGet>
,ExpandableTrait<ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartGet>
,ClientRequestCommand<ShippingMethodPagedQueryResponse>
,CreateHttpRequestCommand
,HttpRequestCommand<ShippingMethodPagedQueryResponse>
,RequestCommand<ShippingMethodPagedQueryResponse>
public class ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartGet
extends TypeApiMethod<ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartGet,ShippingMethodPagedQueryResponse>
implements ExpandableTrait<ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartGet>, ErrorableTrait<ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartGet>, Deprecatable200Trait<ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartGet>
Retrieves all the active ShippingMethods that can ship to the shipping address of the given Cart in a given Store. Each ShippingMethod contains exactly one ShippingRate with the flag isMatching
set to true
. This ShippingRate is used when the ShippingMethod is added to the Cart.
CompletableFuture<ApiHttpResponse<com.commercetools.api.models.shipping_method.ShippingMethodPagedQueryResponse>> result = apiRoot
.withProjectKey("{projectKey}")
.inStoreKeyWithStoreKeyValue("{storeKey}")
.shippingMethods()
.matchingCart()
.get()
.withCartId(cartId)
.execute()
-
Nested Class Summary
Nested classes/interfaces inherited from class io.vrap.rmf.base.client.ApiMethod
ApiMethod.ParamEntry<K,
V> -
Constructor Summary
ConstructorDescriptionByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartGet
(ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartGet t) ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartGet
(ApiHttpClient apiHttpClient, String projectKey, String storeKey) -
Method Summary
Modifier and TypeMethodDescriptionaddCartId
(Collection<TValue> cartId) add additional cartId query parametersadd additional cartId query parameteradd additional cartId query parameteraddCartId
(TValue cartId) add additional cartId query parameteraddExpand
(Collection<TValue> expand) add additional expand query parametersadd additional expand query parameteradd additional expand query parameteraddExpand
(TValue expand) add additional expand query parameterboolean
execute
(ApiHttpClient client) executeBlocking
(ApiHttpClient client, Duration timeout) int
hashCode()
int
com.fasterxml.jackson.core.type.TypeReference<ShippingMethodPagedQueryResponse>
void
setProjectKey
(String projectKey) void
setStoreKey
(String storeKey) toString()
withCartId
(Collection<TValue> cartId) set cartId with the specified valuesset cartId with the specified valuewithCartId
(Supplier<String> supplier) set cartId with the specified valuewithCartId
(TValue cartId) set cartId with the specified valuewithExpand
(Collection<TValue> expand) set expand with the specified valuesset expand with the specified valuewithExpand
(Supplier<String> supplier) set expand with the specified valuewithExpand
(TValue expand) set expand with the specified valueMethods inherited from class io.vrap.rmf.base.client.ApiMethod
addHeader, addQueryParam, addQueryParams, contentType, createHttpRequest, execute, execute, execute, execute, execute, execute, execute, executeBlocking, executeBlocking, executeBlocking, executeBlocking, executeBlocking, executeBlocking, executeBlocking, executeBlocking, executeBlocking, executeBlocking, executeBlocking, executeBlocking, executeBlocking, getFirstQueryParam, getHeaders, getQueryParam, getQueryParams, getQueryParamUriString, getQueryParamUriStrings, send, sendBlocking, sendBlocking, with, with, withHeader, withHeaders, withHttpRequest, withoutHeader, withoutQueryParam, withQueryParam, withQueryParams
Methods inherited from interface io.vrap.rmf.base.client.ClientRequestCommand
executeBlocking
Methods inherited from interface io.vrap.rmf.base.client.CreateHttpRequestCommand
createHttpRequest
Methods inherited from interface com.commercetools.api.client.Deprecatable200Trait
asDeprecatable200Trait, asDeprecatable200TraitToBaseType
Methods inherited from interface com.commercetools.api.client.ErrorableTrait
asErrorableTrait, asErrorableTraitToBaseType
Methods inherited from interface com.commercetools.api.client.ExpandableTrait
asExpandableTrait, asExpandableTraitToBaseType
Methods inherited from interface io.vrap.rmf.base.client.RequestCommand
executeBlocking
-
Constructor Details
-
ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartGet
public ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartGet(ApiHttpClient apiHttpClient, String projectKey, String storeKey) -
ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartGet
public ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartGet(ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartGet t)
-
-
Method Details
-
resultType
- Specified by:
resultType
in interfaceHttpRequestCommand<ShippingMethodPagedQueryResponse>
-
executeBlocking
public ApiHttpResponse<ShippingMethodPagedQueryResponse> executeBlocking(ApiHttpClient client, Duration timeout) - Specified by:
executeBlocking
in interfaceClientRequestCommand<ShippingMethodPagedQueryResponse>
- Specified by:
executeBlocking
in classApiMethod<ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartGet,
ShippingMethodPagedQueryResponse>
-
execute
public CompletableFuture<ApiHttpResponse<ShippingMethodPagedQueryResponse>> execute(ApiHttpClient client) - Specified by:
execute
in interfaceClientRequestCommand<ShippingMethodPagedQueryResponse>
- Specified by:
execute
in classApiMethod<ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartGet,
ShippingMethodPagedQueryResponse>
-
getProjectKey
-
getStoreKey
-
getCartId
-
getExpand
- Specified by:
getExpand
in interfaceExpandableTrait<ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartGet>
-
setProjectKey
-
setStoreKey
-
withCartId
public <TValue> ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartGet withCartId(TValue cartId) set cartId with the specified value- Type Parameters:
TValue
- value type- Parameters:
cartId
- value to be set- Returns:
- ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartGet
-
addCartId
public <TValue> ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartGet addCartId(TValue cartId) add additional cartId query parameter- Type Parameters:
TValue
- value type- Parameters:
cartId
- value to be added- Returns:
- ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartGet
-
withCartId
public ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartGet withCartId(Supplier<String> supplier) set cartId with the specified value- Parameters:
supplier
- supplier for the value to be set- Returns:
- ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartGet
-
addCartId
public ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartGet addCartId(Supplier<String> supplier) add additional cartId query parameter- Parameters:
supplier
- supplier for the value to be added- Returns:
- ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartGet
-
withCartId
public ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartGet withCartId(Function<StringBuilder, StringBuilder> op) set cartId with the specified value- Parameters:
op
- builder for the value to be set- Returns:
- ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartGet
-
addCartId
public ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartGet addCartId(Function<StringBuilder, StringBuilder> op) add additional cartId query parameter- Parameters:
op
- builder for the value to be added- Returns:
- ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartGet
-
withCartId
public <TValue> ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartGet withCartId(Collection<TValue> cartId) set cartId with the specified values- Type Parameters:
TValue
- value type- Parameters:
cartId
- values to be set- Returns:
- ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartGet
-
addCartId
public <TValue> ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartGet addCartId(Collection<TValue> cartId) add additional cartId query parameters- Type Parameters:
TValue
- value type- Parameters:
cartId
- values to be added- Returns:
- ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartGet
-
withExpand
public <TValue> ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartGet withExpand(TValue expand) set expand with the specified value- Specified by:
withExpand
in interfaceExpandableTrait<ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartGet>
- Type Parameters:
TValue
- value type- Parameters:
expand
- value to be set- Returns:
- ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartGet
-
addExpand
public <TValue> ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartGet addExpand(TValue expand) add additional expand query parameter- Specified by:
addExpand
in interfaceExpandableTrait<ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartGet>
- Type Parameters:
TValue
- value type- Parameters:
expand
- value to be added- Returns:
- ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartGet
-
withExpand
public ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartGet withExpand(Supplier<String> supplier) set expand with the specified value- Parameters:
supplier
- supplier for the value to be set- Returns:
- ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartGet
-
addExpand
public ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartGet addExpand(Supplier<String> supplier) add additional expand query parameter- Parameters:
supplier
- supplier for the value to be added- Returns:
- ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartGet
-
withExpand
public ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartGet withExpand(Function<StringBuilder, StringBuilder> op) set expand with the specified value- Parameters:
op
- builder for the value to be set- Returns:
- ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartGet
-
addExpand
public ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartGet addExpand(Function<StringBuilder, StringBuilder> op) add additional expand query parameter- Parameters:
op
- builder for the value to be added- Returns:
- ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartGet
-
withExpand
public <TValue> ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartGet withExpand(Collection<TValue> expand) set expand with the specified values- Type Parameters:
TValue
- value type- Parameters:
expand
- values to be set- Returns:
- ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartGet
-
addExpand
public <TValue> ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartGet addExpand(Collection<TValue> expand) add additional expand query parameters- Type Parameters:
TValue
- value type- Parameters:
expand
- values to be added- Returns:
- ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartGet
-
equals
-
hashCode
public int hashCode() -
toString
-
reflectionHashCode
public int reflectionHashCode()
-