Package com.commercetools.api.client

Class ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsByIDPostString

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<ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsByIDPostString,ShoppingList>

com.commercetools.api.client.ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsByIDPostString

All Implemented Interfaces:

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

public class ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsByIDPostString
extends StringBodyApiMethod<ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsByIDPostString,ShoppingList>
implements ConflictingTrait<ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsByIDPostString>, ExpandableTrait<ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsByIDPostString>, Deprecatable200Trait<ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsByIDPostString>, ErrorableTrait<ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsByIDPostString>

If the ShoppingList 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()
            .withId("{ID}")
            .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
ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsByIDPostString(ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsByIDPostString t)
ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsByIDPostString(ApiHttpClient apiHttpClient, String projectKey, String associateId, String businessUnitKey, String ID, String shoppingListUpdate)

Method Summary

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

ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsByIDPostString

public ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsByIDPostString(ApiHttpClient apiHttpClient,
 String projectKey,
 String associateId,
 String businessUnitKey,
 String ID,
 String shoppingListUpdate)

ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsByIDPostString

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

execute

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

Specified by:

execute in interface ClientRequestCommand<ShoppingList>

Specified by:

execute in class ApiMethod<ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsByIDPostString,ShoppingList>

getProjectKey

public String getProjectKey()

getAssociateId

public String getAssociateId()

getBusinessUnitKey

public String getBusinessUnitKey()

getID

public String getID()

getExpand

public List<String> getExpand()

Specified by:

getExpand in interface ExpandableTrait<ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsByIDPostString>

setProjectKey

public void setProjectKey(String projectKey)

setAssociateId

public void setAssociateId(String associateId)

setBusinessUnitKey

public void setBusinessUnitKey(String businessUnitKey)

setID

public void setID(String ID)

withExpand

public <TValue>
ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsByIDPostString withExpand(TValue expand)

set expand with the specified value

Specified by:

withExpand in interface ExpandableTrait<ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsByIDPostString>

Type Parameters:

TValue - value type

Parameters:

expand - value to be set

Returns:

ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsByIDPostString

addExpand

public <TValue>
ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsByIDPostString addExpand(TValue expand)

add additional expand query parameter

Specified by:

addExpand in interface ExpandableTrait<ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsByIDPostString>

Type Parameters:

TValue - value type

Parameters:

expand - value to be added

Returns:

ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsByIDPostString

withExpand

public ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsByIDPostString withExpand(Supplier<String> supplier)

set expand with the specified value

Parameters:

supplier - supplier for the value to be set

Returns:

ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsByIDPostString

addExpand

public ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsByIDPostString addExpand(Supplier<String> supplier)

add additional expand query parameter

Parameters:

supplier - supplier for the value to be added

Returns:

ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsByIDPostString

withExpand

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

set expand with the specified value

Parameters:

op - builder for the value to be set

Returns:

ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsByIDPostString

addExpand

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

add additional expand query parameter

Parameters:

op - builder for the value to be added

Returns:

ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsByIDPostString

withExpand

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

set expand with the specified values

Type Parameters:

TValue - value type

Parameters:

expand - values to be set

Returns:

ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsByIDPostString

addExpand

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

add additional expand query parameters

Type Parameters:

TValue - value type

Parameters:

expand - values to be added

Returns:

ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsByIDPostString

getBody

public String getBody()

Overrides:

getBody in class StringBodyApiMethod<ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsByIDPostString,ShoppingList>

withBody

public ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsByIDPostString withBody(String shoppingListUpdate)

Overrides:

withBody in class StringBodyApiMethod<ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyShoppingListsByIDPostString,ShoppingList>

equals

public boolean equals(Object o)

hashCode

public int hashCode()

toString

public String toString()

Overrides:

toString in class Object

reflectionHashCode

public int reflectionHashCode()