Package com.commercetools.api.client

Class ByProjectKeyOrdersEditsPostString

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<ByProjectKeyOrdersEditsPostString,OrderEdit>

com.commercetools.api.client.ByProjectKeyOrdersEditsPostString

All Implemented Interfaces:

Deprecatable201Trait<ByProjectKeyOrdersEditsPostString>, ErrorableTrait<ByProjectKeyOrdersEditsPostString>, ExpandableTrait<ByProjectKeyOrdersEditsPostString>, ClientRequestCommand<OrderEdit>, CreateHttpRequestCommand, HttpRequestCommand<OrderEdit>, RequestCommand<OrderEdit>

public class ByProjectKeyOrdersEditsPostString
extends StringBodyApiMethod<ByProjectKeyOrdersEditsPostString,OrderEdit>
implements ExpandableTrait<ByProjectKeyOrdersEditsPostString>, Deprecatable201Trait<ByProjectKeyOrdersEditsPostString>, ErrorableTrait<ByProjectKeyOrdersEditsPostString>

You can either create multiple Order Edits for an Order and apply them sequentially to an Order, or create multiple Order Edits parallelly (as alternatives to each other) and apply one of them to the Order.

You can only create an Order Edit if the InventoryMode of the Order and its LineItems is None.

   CompletableFuture<ApiHttpResponse<com.commercetools.api.models.order_edit.OrderEdit>> result = apiRoot
            .withProjectKey("{projectKey}")
            .orders()
            .edits()
            .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
ByProjectKeyOrdersEditsPostString(ByProjectKeyOrdersEditsPostString t)
ByProjectKeyOrdersEditsPostString(ApiHttpClient apiHttpClient, String projectKey, String orderEditDraft)

Method Summary

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

ByProjectKeyOrdersEditsPostString

public ByProjectKeyOrdersEditsPostString(ApiHttpClient apiHttpClient,
 String projectKey,
 String orderEditDraft)

ByProjectKeyOrdersEditsPostString

public ByProjectKeyOrdersEditsPostString(ByProjectKeyOrdersEditsPostString t)

Method Details

resultType

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

Specified by:

resultType in interface HttpRequestCommand<OrderEdit>

executeBlocking

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

Specified by:

executeBlocking in interface ClientRequestCommand<OrderEdit>

Specified by:

executeBlocking in class ApiMethod<ByProjectKeyOrdersEditsPostString,OrderEdit>

execute

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

Specified by:

execute in interface ClientRequestCommand<OrderEdit>

Specified by:

execute in class ApiMethod<ByProjectKeyOrdersEditsPostString,OrderEdit>

getProjectKey

public String getProjectKey()

getExpand

public List<String> getExpand()

Specified by:

getExpand in interface ExpandableTrait<ByProjectKeyOrdersEditsPostString>

setProjectKey

public void setProjectKey(String projectKey)

withExpand

public <TValue> ByProjectKeyOrdersEditsPostString withExpand(TValue expand)

set expand with the specified value

Specified by:

withExpand in interface ExpandableTrait<ByProjectKeyOrdersEditsPostString>

Type Parameters:

TValue - value type

Parameters:

expand - value to be set

Returns:

ByProjectKeyOrdersEditsPostString

addExpand

public <TValue> ByProjectKeyOrdersEditsPostString addExpand(TValue expand)

add additional expand query parameter

Specified by:

addExpand in interface ExpandableTrait<ByProjectKeyOrdersEditsPostString>

Type Parameters:

TValue - value type

Parameters:

expand - value to be added

Returns:

ByProjectKeyOrdersEditsPostString

withExpand

public ByProjectKeyOrdersEditsPostString withExpand(Supplier<String> supplier)

set expand with the specified value

Parameters:

supplier - supplier for the value to be set

Returns:

ByProjectKeyOrdersEditsPostString

addExpand

public ByProjectKeyOrdersEditsPostString addExpand(Supplier<String> supplier)

add additional expand query parameter

Parameters:

supplier - supplier for the value to be added

Returns:

ByProjectKeyOrdersEditsPostString

withExpand

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

set expand with the specified value

Parameters:

op - builder for the value to be set

Returns:

ByProjectKeyOrdersEditsPostString

addExpand

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

add additional expand query parameter

Parameters:

op - builder for the value to be added

Returns:

ByProjectKeyOrdersEditsPostString

withExpand

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

set expand with the specified values

Type Parameters:

TValue - value type

Parameters:

expand - values to be set

Returns:

ByProjectKeyOrdersEditsPostString

addExpand

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

add additional expand query parameters

Type Parameters:

TValue - value type

Parameters:

expand - values to be added

Returns:

ByProjectKeyOrdersEditsPostString

getBody

public String getBody()

Overrides:

getBody in class StringBodyApiMethod<ByProjectKeyOrdersEditsPostString,OrderEdit>

withBody

public ByProjectKeyOrdersEditsPostString withBody(String orderEditDraft)

Overrides:

withBody in class StringBodyApiMethod<ByProjectKeyOrdersEditsPostString,OrderEdit>

equals

public boolean equals(Object o)

hashCode

public int hashCode()

toString

public String toString()

Overrides:

toString in class Object

reflectionHashCode

public int reflectionHashCode()