Package com.commercetools.api.client

Class ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsKeyByKeyPost

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<ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsKeyByKeyPost,ShoppingList,ShoppingListUpdate>

com.commercetools.api.client.ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsKeyByKeyPost

All Implemented Interfaces:

ConflictingTrait<ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsKeyByKeyPost>, Deprecatable200Trait<ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsKeyByKeyPost>, ErrorableTrait<ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsKeyByKeyPost>, ExpandableTrait<ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsKeyByKeyPost>, ClientRequestCommand<ShoppingList>, CreateHttpRequestCommand, HttpRequestCommand<ShoppingList>, RequestCommand<ShoppingList>

public class ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsKeyByKeyPost
extends TypeBodyApiMethod<ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsKeyByKeyPost,ShoppingList,ShoppingListUpdate>
implements ConflictingTrait<ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsKeyByKeyPost>, ExpandableTrait<ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsKeyByKeyPost>, Deprecatable200Trait<ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsKeyByKeyPost>, ErrorableTrait<ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsKeyByKeyPost>

If the Shopping List exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.

   CompletableFuture<ApiHttpResponse<com.commercetools.api.models.shopping_list.ShoppingList>> result = apiRoot
            .withProjectKey("{projectKey}")
            .asAssociate()
            .withAssociateIdValue("{associateId}")
            .inBusinessUnitKeyWithBusinessUnitKeyValue("{businessUnitKey}")
            .shoppingLists()
            .withKey("{key}")
            .post(null)
            .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
ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsKeyByKeyPost(ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsKeyByKeyPost t)
ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsKeyByKeyPost(ApiHttpClient apiHttpClient, String projectKey, String associateId, String businessUnitKey, String key, ShoppingListUpdate shoppingListUpdate)

Method Summary

Modifier and Type	Method	Description
<TValue> ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsKeyByKeyPost	addExpand(Collection<TValue> expand)	add additional expand query parameters
ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsKeyByKeyPost	addExpand(Function<StringBuilder,StringBuilder> op)	add additional expand query parameter
ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsKeyByKeyPost	addExpand(Supplier<String> supplier)	add additional expand query parameter
<TValue> ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsKeyByKeyPost	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	getAssociateId()
ShoppingListUpdate	getBody()
String	getBusinessUnitKey()
List<String>	getExpand()
String	getKey()
String	getProjectKey()
int	hashCode()
int	reflectionHashCode()
com.fasterxml.jackson.core.type.TypeReference<ShoppingList>	resultType()
void	setAssociateId(String associateId)
void	setBusinessUnitKey(String businessUnitKey)
void	setKey(String key)
void	setProjectKey(String projectKey)
String	toString()
ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsKeyByKeyPost	withBody(ShoppingListUpdate shoppingListUpdate)
<TValue> ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsKeyByKeyPost	withExpand(Collection<TValue> expand)	set expand with the specified values
ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsKeyByKeyPost	withExpand(Function<StringBuilder,StringBuilder> op)	set expand with the specified value
ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsKeyByKeyPost	withExpand(Supplier<String> supplier)	set expand with the specified value
<TValue> ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsKeyByKeyPost	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 com.commercetools.api.client.ConflictingTrait

asConflictingTrait, asConflictingTraitToBaseType

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

ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsKeyByKeyPost

public ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsKeyByKeyPost(ApiHttpClient apiHttpClient,
 String projectKey,
 String associateId,
 String businessUnitKey,
 String key,
 ShoppingListUpdate shoppingListUpdate)

ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsKeyByKeyPost

public ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsKeyByKeyPost(ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsKeyByKeyPost 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<ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsKeyByKeyPost,ShoppingList>

execute

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

Specified by:

execute in interface ClientRequestCommand<ShoppingList>

Specified by:

execute in class ApiMethod<ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsKeyByKeyPost,ShoppingList>

getProjectKey

public String getProjectKey()

getAssociateId

public String getAssociateId()

getBusinessUnitKey

public String getBusinessUnitKey()

getKey

public String getKey()

getExpand

public List<String> getExpand()

Specified by:

getExpand in interface ExpandableTrait<ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsKeyByKeyPost>

setProjectKey

public void setProjectKey(String projectKey)

setAssociateId

public void setAssociateId(String associateId)

setBusinessUnitKey

public void setBusinessUnitKey(String businessUnitKey)

setKey

public void setKey(String key)

withExpand

public <TValue>
ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsKeyByKeyPost withExpand(TValue expand)

set expand with the specified value

Specified by:

withExpand in interface ExpandableTrait<ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsKeyByKeyPost>

Type Parameters:

TValue - value type

Parameters:

expand - value to be set

Returns:

ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsKeyByKeyPost

addExpand

public <TValue>
ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsKeyByKeyPost addExpand(TValue expand)

add additional expand query parameter

Specified by:

addExpand in interface ExpandableTrait<ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsKeyByKeyPost>

Type Parameters:

TValue - value type

Parameters:

expand - value to be added

Returns:

ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsKeyByKeyPost

withExpand

public ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsKeyByKeyPost withExpand(Supplier<String> supplier)

set expand with the specified value

Parameters:

supplier - supplier for the value to be set

Returns:

ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsKeyByKeyPost

addExpand

public ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsKeyByKeyPost addExpand(Supplier<String> supplier)

add additional expand query parameter

Parameters:

supplier - supplier for the value to be added

Returns:

ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsKeyByKeyPost

withExpand

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

set expand with the specified value

Parameters:

op - builder for the value to be set

Returns:

ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsKeyByKeyPost

addExpand

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

add additional expand query parameter

Parameters:

op - builder for the value to be added

Returns:

ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsKeyByKeyPost

withExpand

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

set expand with the specified values

Type Parameters:

TValue - value type

Parameters:

expand - values to be set

Returns:

ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsKeyByKeyPost

addExpand

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

add additional expand query parameters

Type Parameters:

TValue - value type

Parameters:

expand - values to be added

Returns:

ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsKeyByKeyPost

getBody

public ShoppingListUpdate getBody()

Overrides:

getBody in class TypeBodyApiMethod<ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsKeyByKeyPost,ShoppingList,ShoppingListUpdate>

withBody

public ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsKeyByKeyPost withBody(ShoppingListUpdate shoppingListUpdate)

Overrides:

withBody in class TypeBodyApiMethod<ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsKeyByKeyPost,ShoppingList,ShoppingListUpdate>

equals

public boolean equals(Object o)

hashCode

public int hashCode()

toString

public String toString()

Overrides:

toString in class Object

reflectionHashCode

public int reflectionHashCode()