Commercetools\Api\Models\Customer\CustomerSignin Interface Reference

Inheritance diagram for Commercetools\Api\Models\Customer\CustomerSignin:

Public Member Functions
	getEmail ()
	getPassword ()
	getAnonymousCartId ()
	getAnonymousCart ()
	getAnonymousCartSignInMode ()
	getAnonymousId ()
	getUpdateProductData ()
	setEmail (?string $email)
	setPassword (?string $password)
	setAnonymousCartId (?string $anonymousCartId)
	setAnonymousCart (?CartResourceIdentifier $anonymousCart)
	setAnonymousCartSignInMode (?string $anonymousCartSignInMode)
	setAnonymousId (?string $anonymousId)
	setUpdateProductData (?bool $updateProductData)
Public Member Functions inherited from Commercetools\Base\JsonObject
	get (string $field)
	with (callable $callable=null)

Public Attributes
const	FIELD_EMAIL = 'email'
const	FIELD_PASSWORD = 'password'
const	FIELD_ANONYMOUS_CART_ID = 'anonymousCartId'
const	FIELD_ANONYMOUS_CART = 'anonymousCart'
const	FIELD_ANONYMOUS_CART_SIGN_IN_MODE = 'anonymousCartSignInMode'
const	FIELD_ANONYMOUS_ID = 'anonymousId'
const	FIELD_UPDATE_PRODUCT_DATA = 'updateProductData'

Additional Inherited Members
Static Public Member Functions inherited from Commercetools\Base\JsonObject
static	of ($data=null)
static	fromArray (array $data=[])
static	fromStdClass (stdClass $data=null)

Detailed Description

Definition at line 15 of file CustomerSignin.php.

Member Function Documentation

getAnonymousCart()

Commercetools\Api\Models\Customer\CustomerSignin::getAnonymousCart

(

)

Identifies a Cart that will be assigned to the Customer.

Returns

null|CartResourceIdentifier

Implemented in Commercetools\Api\Models\Customer\CustomerSigninModel.

getAnonymousCartId()

Commercetools\Api\Models\Customer\CustomerSignin::getAnonymousCartId

(

)

Deprecated since it is now possible to identify an anonymous cart by using its id or external key.

Deprecated:

Returns

null|string

Implemented in Commercetools\Api\Models\Customer\CustomerSigninModel.

getAnonymousCartSignInMode()

Commercetools\Api\Models\Customer\CustomerSignin::getAnonymousCartSignInMode

(

)

• Set to MergeWithExistingCustomerCart if LineItems of the anonymous Cart should be merged with the active Customer Cart that has been modified most recently.
• Set to UseAsNewActiveCustomerCart if the anonymous Cart should be used as the new active Customer Cart and no LineItems are to be merged.

Returns

null|string

Implemented in Commercetools\Api\Models\Customer\CustomerSigninModel.

getAnonymousId()

Commercetools\Api\Models\Customer\CustomerSignin::getAnonymousId

(

)

If both anonymousCart and anonymousId are provided, the anonymousId on the CustomerSignin must match that of the anonymous Cart. Otherwise a 400 Bad Request Invalid Operation error is returned with the message: "Cart with the ID cart-id does not have the expected anonymousId.".

Returns

null|string

Implemented in Commercetools\Api\Models\Customer\CustomerSigninModel.

getEmail()

Commercetools\Api\Models\Customer\CustomerSignin::getEmail

(

)

Email address of the Customer treated as case-insensitive.

Returns

null|string

Implemented in Commercetools\Api\Models\Customer\CustomerSigninModel.

getPassword()

Commercetools\Api\Models\Customer\CustomerSignin::getPassword

(

)

Password of the Customer.

Returns

null|string

Implemented in Commercetools\Api\Models\Customer\CustomerSigninModel.

getUpdateProductData()

Commercetools\Api\Models\Customer\CustomerSignin::getUpdateProductData

(

)

• If true, the LineItem Product data (name, variant, and productType) of the returned Cart will be updated.
• If false, only the prices, discounts, and tax rates will be updated.

Returns

null|bool

Implemented in Commercetools\Api\Models\Customer\CustomerSigninModel.

setAnonymousCart()

Commercetools\Api\Models\Customer\CustomerSignin::setAnonymousCart

(

?CartResourceIdentifier

$anonymousCart

)

Parameters

?CartResourceIdentifier

$anonymousCart

Implemented in Commercetools\Api\Models\Customer\CustomerSigninModel.

setAnonymousCartId()

Commercetools\Api\Models\Customer\CustomerSignin::setAnonymousCartId

(

?string

$anonymousCartId

)

Parameters

?string

$anonymousCartId

Implemented in Commercetools\Api\Models\Customer\CustomerSigninModel.

setAnonymousCartSignInMode()

Commercetools\Api\Models\Customer\CustomerSignin::setAnonymousCartSignInMode

(

?string

$anonymousCartSignInMode

)

Parameters

?string

$anonymousCartSignInMode

Implemented in Commercetools\Api\Models\Customer\CustomerSigninModel.

setAnonymousId()

Commercetools\Api\Models\Customer\CustomerSignin::setAnonymousId

(

?string

$anonymousId

)

Parameters

?string

$anonymousId

Implemented in Commercetools\Api\Models\Customer\CustomerSigninModel.

setEmail()

Commercetools\Api\Models\Customer\CustomerSignin::setEmail

(

?string

$email

)

Parameters

?string

$email

Implemented in Commercetools\Api\Models\Customer\CustomerSigninModel.

setPassword()

Commercetools\Api\Models\Customer\CustomerSignin::setPassword

(

?string

$password

)

Parameters

?string

$password

Implemented in Commercetools\Api\Models\Customer\CustomerSigninModel.

setUpdateProductData()

Commercetools\Api\Models\Customer\CustomerSignin::setUpdateProductData

(

?bool

$updateProductData

)

Parameters

?bool

$updateProductData

Implemented in Commercetools\Api\Models\Customer\CustomerSigninModel.

Member Data Documentation

FIELD_ANONYMOUS_CART

const Commercetools\Api\Models\Customer\CustomerSignin::FIELD_ANONYMOUS_CART = 'anonymousCart'

Definition at line 20 of file CustomerSignin.php.

FIELD_ANONYMOUS_CART_ID

const Commercetools\Api\Models\Customer\CustomerSignin::FIELD_ANONYMOUS_CART_ID = 'anonymousCartId'

Definition at line 19 of file CustomerSignin.php.

FIELD_ANONYMOUS_CART_SIGN_IN_MODE

const Commercetools\Api\Models\Customer\CustomerSignin::FIELD_ANONYMOUS_CART_SIGN_IN_MODE = 'anonymousCartSignInMode'

Definition at line 21 of file CustomerSignin.php.

FIELD_ANONYMOUS_ID

const Commercetools\Api\Models\Customer\CustomerSignin::FIELD_ANONYMOUS_ID = 'anonymousId'

Definition at line 22 of file CustomerSignin.php.

FIELD_EMAIL

const Commercetools\Api\Models\Customer\CustomerSignin::FIELD_EMAIL = 'email'

Definition at line 17 of file CustomerSignin.php.

FIELD_PASSWORD

const Commercetools\Api\Models\Customer\CustomerSignin::FIELD_PASSWORD = 'password'

Definition at line 18 of file CustomerSignin.php.

FIELD_UPDATE_PRODUCT_DATA

const Commercetools\Api\Models\Customer\CustomerSignin::FIELD_UPDATE_PRODUCT_DATA = 'updateProductData'

Definition at line 23 of file CustomerSignin.php.

---

The documentation for this interface was generated from the following file:

• lib/commercetools-api/src/Models/Customer/CustomerSignin.php