Package com.commercetools.api.client

Class ByProjectKeyCustomersPostString

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<ByProjectKeyCustomersPostString,CustomerSignInResult>

com.commercetools.api.client.ByProjectKeyCustomersPostString

All Implemented Interfaces:

Deprecatable201Trait<ByProjectKeyCustomersPostString>, ErrorableTrait<ByProjectKeyCustomersPostString>, ExpandableTrait<ByProjectKeyCustomersPostString>, ClientRequestCommand<CustomerSignInResult>, CreateHttpRequestCommand, HttpRequestCommand<CustomerSignInResult>, RequestCommand<CustomerSignInResult>

public class ByProjectKeyCustomersPostString
extends StringBodyApiMethod<ByProjectKeyCustomersPostString,CustomerSignInResult>
implements ExpandableTrait<ByProjectKeyCustomersPostString>, Deprecatable201Trait<ByProjectKeyCustomersPostString>, ErrorableTrait<ByProjectKeyCustomersPostString>

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("")
            .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
ByProjectKeyCustomersPostString(ByProjectKeyCustomersPostString t)
ByProjectKeyCustomersPostString(ApiHttpClient apiHttpClient, String projectKey, String customerDraft)

Method Summary

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

ByProjectKeyCustomersPostString

public ByProjectKeyCustomersPostString(ApiHttpClient apiHttpClient,
 String projectKey,
 String customerDraft)

ByProjectKeyCustomersPostString

public ByProjectKeyCustomersPostString(ByProjectKeyCustomersPostString t)

Method Details

resultType

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

Specified by:

resultType in interface HttpRequestCommand<CustomerSignInResult>

executeBlocking

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

Specified by:

executeBlocking in interface ClientRequestCommand<CustomerSignInResult>

Specified by:

executeBlocking in class ApiMethod<ByProjectKeyCustomersPostString,CustomerSignInResult>

execute

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

Specified by:

execute in interface ClientRequestCommand<CustomerSignInResult>

Specified by:

execute in class ApiMethod<ByProjectKeyCustomersPostString,CustomerSignInResult>

getProjectKey

public String getProjectKey()

getExpand

public List<String> getExpand()

Specified by:

getExpand in interface ExpandableTrait<ByProjectKeyCustomersPostString>

setProjectKey

public void setProjectKey(String projectKey)

withExpand

public <TValue> ByProjectKeyCustomersPostString withExpand(TValue expand)

set expand with the specified value

Specified by:

withExpand in interface ExpandableTrait<ByProjectKeyCustomersPostString>

Type Parameters:

TValue - value type

Parameters:

expand - value to be set

Returns:

ByProjectKeyCustomersPostString

addExpand

public <TValue> ByProjectKeyCustomersPostString addExpand(TValue expand)

add additional expand query parameter

Specified by:

addExpand in interface ExpandableTrait<ByProjectKeyCustomersPostString>

Type Parameters:

TValue - value type

Parameters:

expand - value to be added

Returns:

ByProjectKeyCustomersPostString

withExpand

public ByProjectKeyCustomersPostString withExpand(Supplier<String> supplier)

set expand with the specified value

Parameters:

supplier - supplier for the value to be set

Returns:

ByProjectKeyCustomersPostString

addExpand

public ByProjectKeyCustomersPostString addExpand(Supplier<String> supplier)

add additional expand query parameter

Parameters:

supplier - supplier for the value to be added

Returns:

ByProjectKeyCustomersPostString

withExpand

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

set expand with the specified value

Parameters:

op - builder for the value to be set

Returns:

ByProjectKeyCustomersPostString

addExpand

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

add additional expand query parameter

Parameters:

op - builder for the value to be added

Returns:

ByProjectKeyCustomersPostString

withExpand

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

set expand with the specified values

Type Parameters:

TValue - value type

Parameters:

expand - values to be set

Returns:

ByProjectKeyCustomersPostString

addExpand

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

add additional expand query parameters

Type Parameters:

TValue - value type

Parameters:

expand - values to be added

Returns:

ByProjectKeyCustomersPostString

getBody

public String getBody()

Overrides:

getBody in class StringBodyApiMethod<ByProjectKeyCustomersPostString,CustomerSignInResult>

withBody

public ByProjectKeyCustomersPostString withBody(String customerDraft)

Overrides:

withBody in class StringBodyApiMethod<ByProjectKeyCustomersPostString,CustomerSignInResult>

equals

public boolean equals(Object o)

hashCode

public int hashCode()

toString

public String toString()

Overrides:

toString in class Object

reflectionHashCode

public int reflectionHashCode()