Package com.commercetools.api.client

Class ByProjectKeyLoginPostString

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

com.commercetools.api.client.ByProjectKeyLoginPostString

All Implemented Interfaces:

ErrorableTrait<ByProjectKeyLoginPostString>, ClientRequestCommand<CustomerSignInResult>, CreateHttpRequestCommand, HttpRequestCommand<CustomerSignInResult>, RequestCommand<CustomerSignInResult>

public class ByProjectKeyLoginPostString
extends StringBodyApiMethod<ByProjectKeyLoginPostString,CustomerSignInResult>
implements ErrorableTrait<ByProjectKeyLoginPostString>

Authenticates a global Customer.

Allows merging items from an anonymous Cart into the most recently modified active Cart of a Customer. If no active Cart exists, the anonymous Cart becomes the Customer's active Cart. If the Customer has multiple active Carts, the anonymous Cart is merged into the most recently modified active Cart.

The anonymous Cart is not merged in any of the following cases:

• The referenced Shipping Method is not active.
• The referenced Shipping Method is scoped to a Store that differs from the Cart's Store.
• The referenced Shipping Method is scoped to a Store, but the Cart does not belong to a Store.

If an account with the given credentials is not found, an InvalidCredentials error is returned.

   CompletableFuture<ApiHttpResponse<com.commercetools.api.models.customer.CustomerSignInResult>> result = apiRoot
            .withProjectKey("{projectKey}")
            .login()
            .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
ByProjectKeyLoginPostString(ByProjectKeyLoginPostString t)
ByProjectKeyLoginPostString(ApiHttpClient apiHttpClient, String projectKey, String customerSignin)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
CompletableFuture<ApiHttpResponse<CustomerSignInResult>>	execute(ApiHttpClient client)
ApiHttpResponse<CustomerSignInResult>	executeBlocking(ApiHttpClient client, Duration timeout)
String	getBody()
String	getProjectKey()
int	hashCode()
int	reflectionHashCode()
tools.jackson.core.type.TypeReference<CustomerSignInResult>	resultType()
void	setProjectKey(String projectKey)
String	toString()
ByProjectKeyLoginPostString	withBody(String customerSignin)

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.ErrorableTrait

asErrorableTrait, asErrorableTraitToBaseType

Methods inherited from interface io.vrap.rmf.base.client.RequestCommand

executeBlocking

Constructor Details

ByProjectKeyLoginPostString

public ByProjectKeyLoginPostString(ApiHttpClient apiHttpClient,
 String projectKey,
 String customerSignin)

ByProjectKeyLoginPostString

public ByProjectKeyLoginPostString(ByProjectKeyLoginPostString t)

Method Details

resultType

public tools.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<ByProjectKeyLoginPostString,CustomerSignInResult>

execute

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

Specified by:

execute in interface ClientRequestCommand<CustomerSignInResult>

Specified by:

execute in class ApiMethod<ByProjectKeyLoginPostString,CustomerSignInResult>

getProjectKey

public String getProjectKey()

setProjectKey

public void setProjectKey(String projectKey)

getBody

public String getBody()

Overrides:

getBody in class StringBodyApiMethod<ByProjectKeyLoginPostString,CustomerSignInResult>

withBody

public ByProjectKeyLoginPostString withBody(String customerSignin)

Overrides:

withBody in class StringBodyApiMethod<ByProjectKeyLoginPostString,CustomerSignInResult>

equals

public boolean equals(Object o)

hashCode

public int hashCode()

toString

public String toString()

Overrides:

toString in class Object

reflectionHashCode

public int reflectionHashCode()