Package com.commercetools.api.client

Class ByProjectKeyOrdersEditsPost

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<ByProjectKeyOrdersEditsPost,OrderEdit,OrderEditDraft>

com.commercetools.api.client.ByProjectKeyOrdersEditsPost

All Implemented Interfaces:

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

public class ByProjectKeyOrdersEditsPost
extends TypeBodyApiMethod<ByProjectKeyOrdersEditsPost,OrderEdit,OrderEditDraft>
implements ExpandableTrait<ByProjectKeyOrdersEditsPost>, Deprecatable201Trait<ByProjectKeyOrdersEditsPost>, ErrorableTrait<ByProjectKeyOrdersEditsPost>

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(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
ByProjectKeyOrdersEditsPost(ByProjectKeyOrdersEditsPost t)
ByProjectKeyOrdersEditsPost(ApiHttpClient apiHttpClient, String projectKey, OrderEditDraft orderEditDraft)

Method Summary

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

ByProjectKeyOrdersEditsPost

public ByProjectKeyOrdersEditsPost(ApiHttpClient apiHttpClient,
 String projectKey,
 OrderEditDraft orderEditDraft)

ByProjectKeyOrdersEditsPost

public ByProjectKeyOrdersEditsPost(ByProjectKeyOrdersEditsPost 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<ByProjectKeyOrdersEditsPost,OrderEdit>

execute

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

Specified by:

execute in interface ClientRequestCommand<OrderEdit>

Specified by:

execute in class ApiMethod<ByProjectKeyOrdersEditsPost,OrderEdit>

getProjectKey

public String getProjectKey()

getExpand

public List<String> getExpand()

Specified by:

getExpand in interface ExpandableTrait<ByProjectKeyOrdersEditsPost>

setProjectKey

public void setProjectKey(String projectKey)

withExpand

public <TValue> ByProjectKeyOrdersEditsPost withExpand(TValue expand)

set expand with the specified value

Specified by:

withExpand in interface ExpandableTrait<ByProjectKeyOrdersEditsPost>

Type Parameters:

TValue - value type

Parameters:

expand - value to be set

Returns:

ByProjectKeyOrdersEditsPost

addExpand

public <TValue> ByProjectKeyOrdersEditsPost addExpand(TValue expand)

add additional expand query parameter

Specified by:

addExpand in interface ExpandableTrait<ByProjectKeyOrdersEditsPost>

Type Parameters:

TValue - value type

Parameters:

expand - value to be added

Returns:

ByProjectKeyOrdersEditsPost

withExpand

public ByProjectKeyOrdersEditsPost withExpand(Supplier<String> supplier)

set expand with the specified value

Parameters:

supplier - supplier for the value to be set

Returns:

ByProjectKeyOrdersEditsPost

addExpand

public ByProjectKeyOrdersEditsPost addExpand(Supplier<String> supplier)

add additional expand query parameter

Parameters:

supplier - supplier for the value to be added

Returns:

ByProjectKeyOrdersEditsPost

withExpand

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

set expand with the specified value

Parameters:

op - builder for the value to be set

Returns:

ByProjectKeyOrdersEditsPost

addExpand

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

add additional expand query parameter

Parameters:

op - builder for the value to be added

Returns:

ByProjectKeyOrdersEditsPost

withExpand

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

set expand with the specified values

Type Parameters:

TValue - value type

Parameters:

expand - values to be set

Returns:

ByProjectKeyOrdersEditsPost

addExpand

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

add additional expand query parameters

Type Parameters:

TValue - value type

Parameters:

expand - values to be added

Returns:

ByProjectKeyOrdersEditsPost

getBody

public OrderEditDraft getBody()

Overrides:

getBody in class TypeBodyApiMethod<ByProjectKeyOrdersEditsPost,OrderEdit,OrderEditDraft>

withBody

public ByProjectKeyOrdersEditsPost withBody(OrderEditDraft orderEditDraft)

Overrides:

withBody in class TypeBodyApiMethod<ByProjectKeyOrdersEditsPost,OrderEdit,OrderEditDraft>

equals

public boolean equals(Object o)

hashCode

public int hashCode()

toString

public String toString()

Overrides:

toString in class Object

reflectionHashCode

public int reflectionHashCode()