Package com.commercetools.api.client

Class ByProjectKeyShippingMethodsMatchingCartGet

java.lang.Object

io.vrap.rmf.base.client.ApiMethod<T,TResult>

io.vrap.rmf.base.client.TypeApiMethod<ByProjectKeyShippingMethodsMatchingCartGet,ShippingMethodPagedQueryResponse>

com.commercetools.api.client.ByProjectKeyShippingMethodsMatchingCartGet

All Implemented Interfaces:

Deprecatable200Trait<ByProjectKeyShippingMethodsMatchingCartGet>, ErrorableTrait<ByProjectKeyShippingMethodsMatchingCartGet>, ExpandableTrait<ByProjectKeyShippingMethodsMatchingCartGet>, ClientRequestCommand<ShippingMethodPagedQueryResponse>, CreateHttpRequestCommand, HttpRequestCommand<ShippingMethodPagedQueryResponse>, RequestCommand<ShippingMethodPagedQueryResponse>

public class ByProjectKeyShippingMethodsMatchingCartGet
extends TypeApiMethod<ByProjectKeyShippingMethodsMatchingCartGet,ShippingMethodPagedQueryResponse>
implements ExpandableTrait<ByProjectKeyShippingMethodsMatchingCartGet>, ErrorableTrait<ByProjectKeyShippingMethodsMatchingCartGet>, Deprecatable200Trait<ByProjectKeyShippingMethodsMatchingCartGet>

Retrieves all the active ShippingMethods that can ship to the shipping address of the given Cart. 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}")
            .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

Constructors

Constructor	Description
ByProjectKeyShippingMethodsMatchingCartGet(ByProjectKeyShippingMethodsMatchingCartGet t)
ByProjectKeyShippingMethodsMatchingCartGet(ApiHttpClient apiHttpClient, String projectKey)

Method Summary

Modifier and Type	Method	Description
<TValue> ByProjectKeyShippingMethodsMatchingCartGet	addCartId(Collection<TValue> cartId)	add additional cartId query parameters
ByProjectKeyShippingMethodsMatchingCartGet	addCartId(Function<StringBuilder,StringBuilder> op)	add additional cartId query parameter
ByProjectKeyShippingMethodsMatchingCartGet	addCartId(Supplier<String> supplier)	add additional cartId query parameter
<TValue> ByProjectKeyShippingMethodsMatchingCartGet	addCartId(TValue cartId)	add additional cartId query parameter
<TValue> ByProjectKeyShippingMethodsMatchingCartGet	addExpand(Collection<TValue> expand)	add additional expand query parameters
ByProjectKeyShippingMethodsMatchingCartGet	addExpand(Function<StringBuilder,StringBuilder> op)	add additional expand query parameter
ByProjectKeyShippingMethodsMatchingCartGet	addExpand(Supplier<String> supplier)	add additional expand query parameter
<TValue> ByProjectKeyShippingMethodsMatchingCartGet	addExpand(TValue expand)	add additional expand query parameter
boolean	equals(Object o)
CompletableFuture<ApiHttpResponse<ShippingMethodPagedQueryResponse>>	execute(ApiHttpClient client)
ApiHttpResponse<ShippingMethodPagedQueryResponse>	executeBlocking(ApiHttpClient client, Duration timeout)
List<String>	getCartId()
List<String>	getExpand()
String	getProjectKey()
int	hashCode()
int	reflectionHashCode()
com.fasterxml.jackson.core.type.TypeReference<ShippingMethodPagedQueryResponse>	resultType()
void	setProjectKey(String projectKey)
String	toString()
<TValue> ByProjectKeyShippingMethodsMatchingCartGet	withCartId(Collection<TValue> cartId)	set cartId with the specified values
ByProjectKeyShippingMethodsMatchingCartGet	withCartId(Function<StringBuilder,StringBuilder> op)	set cartId with the specified value
ByProjectKeyShippingMethodsMatchingCartGet	withCartId(Supplier<String> supplier)	set cartId with the specified value
<TValue> ByProjectKeyShippingMethodsMatchingCartGet	withCartId(TValue cartId)	set cartId with the specified value
<TValue> ByProjectKeyShippingMethodsMatchingCartGet	withExpand(Collection<TValue> expand)	set expand with the specified values
ByProjectKeyShippingMethodsMatchingCartGet	withExpand(Function<StringBuilder,StringBuilder> op)	set expand with the specified value
ByProjectKeyShippingMethodsMatchingCartGet	withExpand(Supplier<String> supplier)	set expand with the specified value
<TValue> ByProjectKeyShippingMethodsMatchingCartGet	withExpand(TValue expand)	set expand with the specified value

Methods 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 class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

ByProjectKeyShippingMethodsMatchingCartGet

public ByProjectKeyShippingMethodsMatchingCartGet(ApiHttpClient apiHttpClient,
 String projectKey)

ByProjectKeyShippingMethodsMatchingCartGet

public ByProjectKeyShippingMethodsMatchingCartGet(ByProjectKeyShippingMethodsMatchingCartGet t)

Method Details

resultType

public com.fasterxml.jackson.core.type.TypeReference<ShippingMethodPagedQueryResponse> resultType()

Specified by:

resultType in interface HttpRequestCommand<ShippingMethodPagedQueryResponse>

executeBlocking

public ApiHttpResponse<ShippingMethodPagedQueryResponse> executeBlocking(ApiHttpClient client,
 Duration timeout)

Specified by:

executeBlocking in interface ClientRequestCommand<ShippingMethodPagedQueryResponse>

Specified by:

executeBlocking in class ApiMethod<ByProjectKeyShippingMethodsMatchingCartGet,ShippingMethodPagedQueryResponse>

execute

public CompletableFuture<ApiHttpResponse<ShippingMethodPagedQueryResponse>> execute(ApiHttpClient client)

Specified by:

execute in interface ClientRequestCommand<ShippingMethodPagedQueryResponse>

Specified by:

execute in class ApiMethod<ByProjectKeyShippingMethodsMatchingCartGet,ShippingMethodPagedQueryResponse>

getProjectKey

public String getProjectKey()

getCartId

public List<String> getCartId()

getExpand

public List<String> getExpand()

Specified by:

getExpand in interface ExpandableTrait<ByProjectKeyShippingMethodsMatchingCartGet>

setProjectKey

public void setProjectKey(String projectKey)

withCartId

public <TValue>
ByProjectKeyShippingMethodsMatchingCartGet withCartId(TValue cartId)

set cartId with the specified value

Type Parameters:

TValue - value type

Parameters:

cartId - value to be set

Returns:

ByProjectKeyShippingMethodsMatchingCartGet

addCartId

public <TValue>
ByProjectKeyShippingMethodsMatchingCartGet addCartId(TValue cartId)

add additional cartId query parameter

Type Parameters:

TValue - value type

Parameters:

cartId - value to be added

Returns:

ByProjectKeyShippingMethodsMatchingCartGet

withCartId

public ByProjectKeyShippingMethodsMatchingCartGet withCartId(Supplier<String> supplier)

set cartId with the specified value

Parameters:

supplier - supplier for the value to be set

Returns:

ByProjectKeyShippingMethodsMatchingCartGet

addCartId

public ByProjectKeyShippingMethodsMatchingCartGet addCartId(Supplier<String> supplier)

add additional cartId query parameter

Parameters:

supplier - supplier for the value to be added

Returns:

ByProjectKeyShippingMethodsMatchingCartGet

withCartId

public ByProjectKeyShippingMethodsMatchingCartGet withCartId(Function<StringBuilder,StringBuilder> op)

set cartId with the specified value

Parameters:

op - builder for the value to be set

Returns:

ByProjectKeyShippingMethodsMatchingCartGet

addCartId

public ByProjectKeyShippingMethodsMatchingCartGet addCartId(Function<StringBuilder,StringBuilder> op)

add additional cartId query parameter

Parameters:

op - builder for the value to be added

Returns:

ByProjectKeyShippingMethodsMatchingCartGet

withCartId

public <TValue>
ByProjectKeyShippingMethodsMatchingCartGet withCartId(Collection<TValue> cartId)

set cartId with the specified values

Type Parameters:

TValue - value type

Parameters:

cartId - values to be set

Returns:

ByProjectKeyShippingMethodsMatchingCartGet

addCartId

public <TValue>
ByProjectKeyShippingMethodsMatchingCartGet addCartId(Collection<TValue> cartId)

add additional cartId query parameters

Type Parameters:

TValue - value type

Parameters:

cartId - values to be added

Returns:

ByProjectKeyShippingMethodsMatchingCartGet

withExpand

public <TValue>
ByProjectKeyShippingMethodsMatchingCartGet withExpand(TValue expand)

set expand with the specified value

Specified by:

withExpand in interface ExpandableTrait<ByProjectKeyShippingMethodsMatchingCartGet>

Type Parameters:

TValue - value type

Parameters:

expand - value to be set

Returns:

ByProjectKeyShippingMethodsMatchingCartGet

addExpand

public <TValue>
ByProjectKeyShippingMethodsMatchingCartGet addExpand(TValue expand)

add additional expand query parameter

Specified by:

addExpand in interface ExpandableTrait<ByProjectKeyShippingMethodsMatchingCartGet>

Type Parameters:

TValue - value type

Parameters:

expand - value to be added

Returns:

ByProjectKeyShippingMethodsMatchingCartGet

withExpand

public ByProjectKeyShippingMethodsMatchingCartGet withExpand(Supplier<String> supplier)

set expand with the specified value

Parameters:

supplier - supplier for the value to be set

Returns:

ByProjectKeyShippingMethodsMatchingCartGet

addExpand

public ByProjectKeyShippingMethodsMatchingCartGet addExpand(Supplier<String> supplier)

add additional expand query parameter

Parameters:

supplier - supplier for the value to be added

Returns:

ByProjectKeyShippingMethodsMatchingCartGet

withExpand

public ByProjectKeyShippingMethodsMatchingCartGet withExpand(Function<StringBuilder,StringBuilder> op)

set expand with the specified value

Parameters:

op - builder for the value to be set

Returns:

ByProjectKeyShippingMethodsMatchingCartGet

addExpand

public ByProjectKeyShippingMethodsMatchingCartGet addExpand(Function<StringBuilder,StringBuilder> op)

add additional expand query parameter

Parameters:

op - builder for the value to be added

Returns:

ByProjectKeyShippingMethodsMatchingCartGet

withExpand

public <TValue>
ByProjectKeyShippingMethodsMatchingCartGet withExpand(Collection<TValue> expand)

set expand with the specified values

Type Parameters:

TValue - value type

Parameters:

expand - values to be set

Returns:

ByProjectKeyShippingMethodsMatchingCartGet

addExpand

public <TValue>
ByProjectKeyShippingMethodsMatchingCartGet addExpand(Collection<TValue> expand)

add additional expand query parameters

Type Parameters:

TValue - value type

Parameters:

expand - values to be added

Returns:

ByProjectKeyShippingMethodsMatchingCartGet

equals

public boolean equals(Object o)

hashCode

public int hashCode()

toString

public String toString()

Overrides:

toString in class Object

reflectionHashCode

public int reflectionHashCode()