Package com.commercetools.api.client
Class ByProjectKeyCustomersPost
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<ByProjectKeyCustomersPost,CustomerSignInResult,CustomerDraft>
com.commercetools.api.client.ByProjectKeyCustomersPost
- All Implemented Interfaces:
Deprecatable201Trait<ByProjectKeyCustomersPost>
,ErrorableTrait<ByProjectKeyCustomersPost>
,ExpandableTrait<ByProjectKeyCustomersPost>
,ClientRequestCommand<CustomerSignInResult>
,CreateHttpRequestCommand
,HttpRequestCommand<CustomerSignInResult>
,RequestCommand<CustomerSignInResult>
public class ByProjectKeyCustomersPost
extends TypeBodyApiMethod<ByProjectKeyCustomersPost,CustomerSignInResult,CustomerDraft>
implements ExpandableTrait<ByProjectKeyCustomersPost>, Deprecatable201Trait<ByProjectKeyCustomersPost>, ErrorableTrait<ByProjectKeyCustomersPost>
If the anonymousCart
field is set on the CustomerDraft, then the newly created Customer will be assigned to that Cart. Similarly, if the anonymousId
field is set, the Customer will be set on all Carts, Orders, ShoppingLists and Payments with the same anonymousId
.
Creating a Customer produces the CustomerCreated Message. Simultaneously creating two Customers with the same email address can return a LockedField error.
CompletableFuture<ApiHttpResponse<com.commercetools.api.models.customer.CustomerSignInResult>> result = apiRoot
.withProjectKey("{projectKey}")
.customers()
.post(null)
.execute()
-
Nested Class Summary
Nested classes/interfaces inherited from class io.vrap.rmf.base.client.ApiMethod
ApiMethod.ParamEntry<K,
V> -
Constructor Summary
ConstructorDescriptionByProjectKeyCustomersPost
(ApiHttpClient apiHttpClient, String projectKey, CustomerDraft customerDraft) -
Method Summary
Modifier and TypeMethodDescription<TValue> ByProjectKeyCustomersPost
addExpand
(Collection<TValue> expand) add additional expand query parametersadd additional expand query parameteradd additional expand query parameter<TValue> ByProjectKeyCustomersPost
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<CustomerSignInResult>
void
setProjectKey
(String projectKey) toString()
withBody
(CustomerDraft customerDraft) <TValue> ByProjectKeyCustomersPost
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> ByProjectKeyCustomersPost
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 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
-
ByProjectKeyCustomersPost
public ByProjectKeyCustomersPost(ApiHttpClient apiHttpClient, String projectKey, CustomerDraft customerDraft) -
ByProjectKeyCustomersPost
-
-
Method Details
-
resultType
- Specified by:
resultType
in interfaceHttpRequestCommand<CustomerSignInResult>
-
executeBlocking
public ApiHttpResponse<CustomerSignInResult> executeBlocking(ApiHttpClient client, Duration timeout) - Specified by:
executeBlocking
in interfaceClientRequestCommand<CustomerSignInResult>
- Specified by:
executeBlocking
in classApiMethod<ByProjectKeyCustomersPost,
CustomerSignInResult>
-
execute
- Specified by:
execute
in interfaceClientRequestCommand<CustomerSignInResult>
- Specified by:
execute
in classApiMethod<ByProjectKeyCustomersPost,
CustomerSignInResult>
-
getProjectKey
-
getExpand
- Specified by:
getExpand
in interfaceExpandableTrait<ByProjectKeyCustomersPost>
-
setProjectKey
-
withExpand
set expand with the specified value- Specified by:
withExpand
in interfaceExpandableTrait<ByProjectKeyCustomersPost>
- Type Parameters:
TValue
- value type- Parameters:
expand
- value to be set- Returns:
- ByProjectKeyCustomersPost
-
addExpand
add additional expand query parameter- Specified by:
addExpand
in interfaceExpandableTrait<ByProjectKeyCustomersPost>
- Type Parameters:
TValue
- value type- Parameters:
expand
- value to be added- Returns:
- ByProjectKeyCustomersPost
-
withExpand
set expand with the specified value- Parameters:
supplier
- supplier for the value to be set- Returns:
- ByProjectKeyCustomersPost
-
addExpand
add additional expand query parameter- Parameters:
supplier
- supplier for the value to be added- Returns:
- ByProjectKeyCustomersPost
-
withExpand
set expand with the specified value- Parameters:
op
- builder for the value to be set- Returns:
- ByProjectKeyCustomersPost
-
addExpand
add additional expand query parameter- Parameters:
op
- builder for the value to be added- Returns:
- ByProjectKeyCustomersPost
-
withExpand
set expand with the specified values- Type Parameters:
TValue
- value type- Parameters:
expand
- values to be set- Returns:
- ByProjectKeyCustomersPost
-
addExpand
add additional expand query parameters- Type Parameters:
TValue
- value type- Parameters:
expand
- values to be added- Returns:
- ByProjectKeyCustomersPost
-
getBody
- Overrides:
getBody
in classTypeBodyApiMethod<ByProjectKeyCustomersPost,
CustomerSignInResult, CustomerDraft>
-
withBody
- Overrides:
withBody
in classTypeBodyApiMethod<ByProjectKeyCustomersPost,
CustomerSignInResult, CustomerDraft>
-
equals
-
hashCode
public int hashCode() -
toString
-
reflectionHashCode
public int reflectionHashCode()
-