Package com.commercetools.api.client

Class ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsPostString

java.lang.Object

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

io.vrap.rmf.base.client.BodyApiMethod<T,TResult,TBody>

io.vrap.rmf.base.client.TypeBodyApiMethod<T,TResult,String>

io.vrap.rmf.base.client.StringBodyApiMethod<ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsPostString,ShoppingList>

com.commercetools.api.client.ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsPostString

All Implemented Interfaces:

Deprecatable201Trait<ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsPostString>, ErrorableTrait<ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsPostString>, ExpandableTrait<ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsPostString>, ClientRequestCommand<ShoppingList>, CreateHttpRequestCommand, HttpRequestCommand<ShoppingList>, RequestCommand<ShoppingList>

public class ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsPostString
extends StringBodyApiMethod<ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsPostString,ShoppingList>
implements ExpandableTrait<ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsPostString>, Deprecatable201Trait<ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsPostString>, ErrorableTrait<ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsPostString>

Creates a ShoppingList in a Store for a Customer or anonymous user. The customer or anonymousId field on the ShoppingList is automatically set based on the given customer:{id} or anonymous_id:{id} scope.

When using this endpoint, the store field of a ShoppingList is always set to the Store specified in the path parameter.

   CompletableFuture<ApiHttpResponse<com.commercetools.api.models.shopping_list.ShoppingList>> result = apiRoot
            .withProjectKey("{projectKey}")
            .inStoreKeyWithStoreKeyValue("{storeKey}")
            .me()
            .shoppingLists()
            .post("")
            .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
ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsPostString(ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsPostString t)
ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsPostString(ApiHttpClient apiHttpClient, String projectKey, String storeKey, String myShoppingListDraft)

Method Summary

Modifier and Type	Method	Description
<TValue> ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsPostString	addExpand(Collection<TValue> expand)	add additional expand query parameters
ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsPostString	addExpand(Function<StringBuilder,StringBuilder> op)	add additional expand query parameter
ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsPostString	addExpand(Supplier<String> supplier)	add additional expand query parameter
<TValue> ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsPostString	addExpand(TValue expand)	add additional expand query parameter
boolean	equals(Object o)
CompletableFuture<ApiHttpResponse<ShoppingList>>	execute(ApiHttpClient client)
ApiHttpResponse<ShoppingList>	executeBlocking(ApiHttpClient client, Duration timeout)
String	getBody()
List<String>	getExpand()
String	getProjectKey()
String	getStoreKey()
int	hashCode()
int	reflectionHashCode()
com.fasterxml.jackson.core.type.TypeReference<ShoppingList>	resultType()
void	setProjectKey(String projectKey)
void	setStoreKey(String storeKey)
String	toString()
ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsPostString	withBody(String myShoppingListDraft)
<TValue> ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsPostString	withExpand(Collection<TValue> expand)	set expand with the specified values
ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsPostString	withExpand(Function<StringBuilder,StringBuilder> op)	set expand with the specified value
ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsPostString	withExpand(Supplier<String> supplier)	set expand with the specified value
<TValue> ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsPostString	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.Deprecatable201Trait

asDeprecatable201Trait, asDeprecatable201TraitToBaseType

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

ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsPostString

public ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsPostString(ApiHttpClient apiHttpClient,
 String projectKey,
 String storeKey,
 String myShoppingListDraft)

ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsPostString

public ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsPostString(ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsPostString t)

Method Details

resultType

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

Specified by:

resultType in interface HttpRequestCommand<ShoppingList>

executeBlocking

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

Specified by:

executeBlocking in interface ClientRequestCommand<ShoppingList>

Specified by:

executeBlocking in class ApiMethod<ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsPostString,ShoppingList>

execute

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

Specified by:

execute in interface ClientRequestCommand<ShoppingList>

Specified by:

execute in class ApiMethod<ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsPostString,ShoppingList>

getProjectKey

public String getProjectKey()

getStoreKey

public String getStoreKey()

getExpand

public List<String> getExpand()

Specified by:

getExpand in interface ExpandableTrait<ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsPostString>

setProjectKey

public void setProjectKey(String projectKey)

setStoreKey

public void setStoreKey(String storeKey)

withExpand

public <TValue>
ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsPostString withExpand(TValue expand)

set expand with the specified value

Specified by:

withExpand in interface ExpandableTrait<ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsPostString>

Type Parameters:

TValue - value type

Parameters:

expand - value to be set

Returns:

ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsPostString

addExpand

public <TValue>
ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsPostString addExpand(TValue expand)

add additional expand query parameter

Specified by:

addExpand in interface ExpandableTrait<ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsPostString>

Type Parameters:

TValue - value type

Parameters:

expand - value to be added

Returns:

ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsPostString

withExpand

public ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsPostString withExpand(Supplier<String> supplier)

set expand with the specified value

Parameters:

supplier - supplier for the value to be set

Returns:

ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsPostString

addExpand

public ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsPostString addExpand(Supplier<String> supplier)

add additional expand query parameter

Parameters:

supplier - supplier for the value to be added

Returns:

ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsPostString

withExpand

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

set expand with the specified value

Parameters:

op - builder for the value to be set

Returns:

ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsPostString

addExpand

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

add additional expand query parameter

Parameters:

op - builder for the value to be added

Returns:

ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsPostString

withExpand

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

set expand with the specified values

Type Parameters:

TValue - value type

Parameters:

expand - values to be set

Returns:

ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsPostString

addExpand

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

add additional expand query parameters

Type Parameters:

TValue - value type

Parameters:

expand - values to be added

Returns:

ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsPostString

getBody

public String getBody()

Overrides:

getBody in class StringBodyApiMethod<ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsPostString,ShoppingList>

withBody

public ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsPostString withBody(String myShoppingListDraft)

Overrides:

withBody in class StringBodyApiMethod<ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsPostString,ShoppingList>

equals

public boolean equals(Object o)

hashCode

public int hashCode()

toString

public String toString()

Overrides:

toString in class Object

reflectionHashCode

public int reflectionHashCode()