Package com.commercetools.api.client
Class ByProjectKeyRecurringOrdersPost
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<ByProjectKeyRecurringOrdersPost,RecurringOrder,RecurringOrderDraft>
com.commercetools.api.client.ByProjectKeyRecurringOrdersPost
- All Implemented Interfaces:
ConflictingTrait<ByProjectKeyRecurringOrdersPost>
,Deprecatable201Trait<ByProjectKeyRecurringOrdersPost>
,ErrorableTrait<ByProjectKeyRecurringOrdersPost>
,ExpandableTrait<ByProjectKeyRecurringOrdersPost>
,ClientRequestCommand<RecurringOrder>
,CreateHttpRequestCommand
,HttpRequestCommand<RecurringOrder>
,RequestCommand<RecurringOrder>
public class ByProjectKeyRecurringOrdersPost
extends TypeBodyApiMethod<ByProjectKeyRecurringOrdersPost,RecurringOrder,RecurringOrderDraft>
implements ConflictingTrait<ByProjectKeyRecurringOrdersPost>, ExpandableTrait<ByProjectKeyRecurringOrdersPost>, Deprecatable201Trait<ByProjectKeyRecurringOrdersPost>, ErrorableTrait<ByProjectKeyRecurringOrdersPost>
Creates a Recurring Order in the Project. Produces the RecurringOrderCreated message.
The Cart is validated to ensure that it is convertible to an Order. If the validation fails, an error is returned. If the expiration date has been reached when the Recurring Order is processed, its RecurringOrderState will be updated to Expired
, and no Order will be created.
If a server-side problem occurs, indicated by a 500 Internal Server Error HTTP response, the Recurring Order creation may still successfully complete after the error is returned. If you receive this error, you should verify the status of the Recurring Order by querying a unique identifier supplied during the creation request, such as the key.
CompletableFuture<ApiHttpResponse<com.commercetools.api.models.recurring_order.RecurringOrder>> result = apiRoot
.withProjectKey("{projectKey}")
.recurringOrders()
.post(null)
.execute()
-
Nested Class Summary
Nested classes/interfaces inherited from class io.vrap.rmf.base.client.ApiMethod
ApiMethod.ParamEntry<K,
V> -
Constructor Summary
ConstructorsConstructorDescriptionByProjectKeyRecurringOrdersPost
(ApiHttpClient apiHttpClient, String projectKey, RecurringOrderDraft recurringOrderDraft) -
Method Summary
Modifier and TypeMethodDescription<TValue> ByProjectKeyRecurringOrdersPost
addExpand
(Collection<TValue> expand) add additional expand query parametersadd additional expand query parameteradd additional expand query parameter<TValue> ByProjectKeyRecurringOrdersPost
addExpand
(TValue expand) add additional expand query parameterboolean
execute
(ApiHttpClient client) executeBlocking
(ApiHttpClient client, Duration timeout) getBody()
int
hashCode()
int
com.fasterxml.jackson.core.type.TypeReference<RecurringOrder>
void
setProjectKey
(String projectKey) toString()
withBody
(RecurringOrderDraft recurringOrderDraft) <TValue> ByProjectKeyRecurringOrdersPost
withExpand
(Collection<TValue> expand) set expand with the specified valuesset expand with the specified valuewithExpand
(Supplier<String> supplier) set expand with the specified value<TValue> ByProjectKeyRecurringOrdersPost
withExpand
(TValue expand) set expand with the specified valueMethods 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 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.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
-
ByProjectKeyRecurringOrdersPost
public ByProjectKeyRecurringOrdersPost(ApiHttpClient apiHttpClient, String projectKey, RecurringOrderDraft recurringOrderDraft) -
ByProjectKeyRecurringOrdersPost
-
-
Method Details
-
resultType
- Specified by:
resultType
in interfaceHttpRequestCommand<RecurringOrder>
-
executeBlocking
- Specified by:
executeBlocking
in interfaceClientRequestCommand<RecurringOrder>
- Specified by:
executeBlocking
in classApiMethod<ByProjectKeyRecurringOrdersPost,
RecurringOrder>
-
execute
- Specified by:
execute
in interfaceClientRequestCommand<RecurringOrder>
- Specified by:
execute
in classApiMethod<ByProjectKeyRecurringOrdersPost,
RecurringOrder>
-
getProjectKey
-
getExpand
- Specified by:
getExpand
in interfaceExpandableTrait<ByProjectKeyRecurringOrdersPost>
-
setProjectKey
-
withExpand
set expand with the specified value- Specified by:
withExpand
in interfaceExpandableTrait<ByProjectKeyRecurringOrdersPost>
- Type Parameters:
TValue
- value type- Parameters:
expand
- value to be set- Returns:
- ByProjectKeyRecurringOrdersPost
-
addExpand
add additional expand query parameter- Specified by:
addExpand
in interfaceExpandableTrait<ByProjectKeyRecurringOrdersPost>
- Type Parameters:
TValue
- value type- Parameters:
expand
- value to be added- Returns:
- ByProjectKeyRecurringOrdersPost
-
withExpand
set expand with the specified value- Parameters:
supplier
- supplier for the value to be set- Returns:
- ByProjectKeyRecurringOrdersPost
-
addExpand
add additional expand query parameter- Parameters:
supplier
- supplier for the value to be added- Returns:
- ByProjectKeyRecurringOrdersPost
-
withExpand
set expand with the specified value- Parameters:
op
- builder for the value to be set- Returns:
- ByProjectKeyRecurringOrdersPost
-
addExpand
add additional expand query parameter- Parameters:
op
- builder for the value to be added- Returns:
- ByProjectKeyRecurringOrdersPost
-
withExpand
set expand with the specified values- Type Parameters:
TValue
- value type- Parameters:
expand
- values to be set- Returns:
- ByProjectKeyRecurringOrdersPost
-
addExpand
add additional expand query parameters- Type Parameters:
TValue
- value type- Parameters:
expand
- values to be added- Returns:
- ByProjectKeyRecurringOrdersPost
-
getBody
- Overrides:
getBody
in classTypeBodyApiMethod<ByProjectKeyRecurringOrdersPost,
RecurringOrder, RecurringOrderDraft>
-
withBody
- Overrides:
withBody
in classTypeBodyApiMethod<ByProjectKeyRecurringOrdersPost,
RecurringOrder, RecurringOrderDraft>
-
equals
-
hashCode
public int hashCode() -
toString
-
reflectionHashCode
public int reflectionHashCode()
-