Inheritance diagram for Commercetools\Api\Models\ShoppingList\ShoppingListDraft:

Public Member Functions
	getName ()

	getSlug ()

	getCustomer ()

	getKey ()

	getDescription ()

	getAnonymousId ()

	getDeleteDaysAfterLastModification ()

	getLineItems ()

	getTextLineItems ()

	getStore ()

	getCustom ()

	setName (?LocalizedString $name)

	setSlug (?LocalizedString $slug)

	setCustomer (?CustomerResourceIdentifier $customer)

	setKey (?string $key)

	setDescription (?LocalizedString $description)

	setAnonymousId (?string $anonymousId)

	setDeleteDaysAfterLastModification (?int $deleteDaysAfterLastModification)

	setLineItems (?ShoppingListLineItemDraftCollection $lineItems)

	setTextLineItems (?TextLineItemDraftCollection $textLineItems)

	setStore (?StoreResourceIdentifier $store)

	setCustom (?CustomFieldsDraft $custom)

Public Member Functions inherited from Commercetools\Base\JsonObject
	get (string $field)

	with (callable $callable=null)

Public Attributes
const	FIELD_NAME = 'name'

const	FIELD_SLUG = 'slug'

const	FIELD_CUSTOMER = 'customer'

const	FIELD_KEY = 'key'

const	FIELD_DESCRIPTION = 'description'

const	FIELD_ANONYMOUS_ID = 'anonymousId'

const	FIELD_DELETE_DAYS_AFTER_LAST_MODIFICATION = 'deleteDaysAfterLastModification'

const	FIELD_LINE_ITEMS = 'lineItems'

const	FIELD_TEXT_LINE_ITEMS = 'textLineItems'

const	FIELD_STORE = 'store'

const	FIELD_CUSTOM = 'custom'

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 18 of file ShoppingListDraft.php.

Member Function Documentation

◆ getAnonymousId()

Commercetools\Api\Models\ShoppingList\ShoppingListDraft::getAnonymousId ( )

Identifies ShoppingLists belonging to an anonymous session.

Returns: null|string

Implemented in Commercetools\Api\Models\ShoppingList\ShoppingListDraftModel.

◆ getCustom()

Commercetools\Api\Models\ShoppingList\ShoppingListDraft::getCustom ( )

Custom Fields defined for the ShoppingList.

Returns: null|CustomFieldsDraft

Implemented in Commercetools\Api\Models\ShoppingList\ShoppingListDraftModel.

◆ getCustomer()

Commercetools\Api\Models\ShoppingList\ShoppingListDraft::getCustomer ( )

The Customer the ShoppingList should be associated to.

Returns: null|CustomerResourceIdentifier

Implemented in Commercetools\Api\Models\ShoppingList\ShoppingListDraftModel.

◆ getDeleteDaysAfterLastModification()

Commercetools\Api\Models\ShoppingList\ShoppingListDraft::getDeleteDaysAfterLastModification ( )

Number of days after which the ShoppingList will be automatically deleted if it has not been modified. If not set, the default value configured in the Project is used.

Returns: null|int

Implemented in Commercetools\Api\Models\ShoppingList\ShoppingListDraftModel.

◆ getDescription()

Commercetools\Api\Models\ShoppingList\ShoppingListDraft::getDescription ( )

Description of the ShoppingList.

Returns: null|LocalizedString

Implemented in Commercetools\Api\Models\ShoppingList\ShoppingListDraftModel.

◆ getKey()

Commercetools\Api\Models\ShoppingList\ShoppingListDraft::getKey ( )

User-defined unique identifier for the ShoppingList.

Returns: null|string

Implemented in Commercetools\Api\Models\ShoppingList\ShoppingListDraftModel.

◆ getLineItems()

Commercetools\Api\Models\ShoppingList\ShoppingListDraft::getLineItems ( )

Line Items (containing Products) to add to the ShoppingList.

Returns: null|ShoppingListLineItemDraftCollection

Implemented in Commercetools\Api\Models\ShoppingList\ShoppingListDraftModel.

◆ getName()

Commercetools\Api\Models\ShoppingList\ShoppingListDraft::getName ( )

Name of the ShoppingList.

Returns: null|LocalizedString

Implemented in Commercetools\Api\Models\ShoppingList\ShoppingListDraftModel.

◆ getSlug()

Commercetools\Api\Models\ShoppingList\ShoppingListDraft::getSlug ( )

Human-readable identifiers usually used as deep-link URL to the related ShoppingList. Each slug is unique across a Project, but a ShoppingList can have the same slug for different languages. The slug must match the pattern [a-zA-Z0-9_-]{2,256}.

Returns: null|LocalizedString

Implemented in Commercetools\Api\Models\ShoppingList\ShoppingListDraftModel.

◆ getStore()

Commercetools\Api\Models\ShoppingList\ShoppingListDraft::getStore ( )

Assigns the new ShoppingList to the Store.

Returns: null|StoreResourceIdentifier

Implemented in Commercetools\Api\Models\ShoppingList\ShoppingListDraftModel.

◆ getTextLineItems()

Commercetools\Api\Models\ShoppingList\ShoppingListDraft::getTextLineItems ( )

Line Items (containing text values) to add to the ShoppingList.

Returns: null|TextLineItemDraftCollection

Implemented in Commercetools\Api\Models\ShoppingList\ShoppingListDraftModel.

◆ setAnonymousId()

Commercetools\Api\Models\ShoppingList\ShoppingListDraft::setAnonymousId ( ?string $anonymousId )

Parameters

?string $anonymousId

Implemented in Commercetools\Api\Models\ShoppingList\ShoppingListDraftModel.

◆ setCustom()

Commercetools\Api\Models\ShoppingList\ShoppingListDraft::setCustom ( ?CustomFieldsDraft $custom )

Parameters

?CustomFieldsDraft $custom

Implemented in Commercetools\Api\Models\ShoppingList\ShoppingListDraftModel.

◆ setCustomer()

Commercetools\Api\Models\ShoppingList\ShoppingListDraft::setCustomer ( ?CustomerResourceIdentifier $customer )

Parameters

?CustomerResourceIdentifier $customer

Implemented in Commercetools\Api\Models\ShoppingList\ShoppingListDraftModel.

◆ setDeleteDaysAfterLastModification()

Commercetools\Api\Models\ShoppingList\ShoppingListDraft::setDeleteDaysAfterLastModification ( ?int $deleteDaysAfterLastModification )

Parameters

?int	$deleteDaysAfterLastModification

Implemented in Commercetools\Api\Models\ShoppingList\ShoppingListDraftModel.

◆ setDescription()

Commercetools\Api\Models\ShoppingList\ShoppingListDraft::setDescription ( ?LocalizedString $description )

Parameters

?LocalizedString $description

Implemented in Commercetools\Api\Models\ShoppingList\ShoppingListDraftModel.

◆ setKey()

Commercetools\Api\Models\ShoppingList\ShoppingListDraft::setKey ( ?string $key )

Parameters

?string $key

Implemented in Commercetools\Api\Models\ShoppingList\ShoppingListDraftModel.

◆ setLineItems()

Commercetools\Api\Models\ShoppingList\ShoppingListDraft::setLineItems ( ?ShoppingListLineItemDraftCollection $lineItems )

Parameters

?ShoppingListLineItemDraftCollection $lineItems

Implemented in Commercetools\Api\Models\ShoppingList\ShoppingListDraftModel.

◆ setName()

Commercetools\Api\Models\ShoppingList\ShoppingListDraft::setName ( ?LocalizedString $name )

Parameters

?LocalizedString $name

Implemented in Commercetools\Api\Models\ShoppingList\ShoppingListDraftModel.

◆ setSlug()

Commercetools\Api\Models\ShoppingList\ShoppingListDraft::setSlug ( ?LocalizedString $slug )

Parameters

?LocalizedString $slug

Implemented in Commercetools\Api\Models\ShoppingList\ShoppingListDraftModel.

◆ setStore()

Commercetools\Api\Models\ShoppingList\ShoppingListDraft::setStore ( ?StoreResourceIdentifier $store )

Parameters

?StoreResourceIdentifier $store

Implemented in Commercetools\Api\Models\ShoppingList\ShoppingListDraftModel.

◆ setTextLineItems()

Commercetools\Api\Models\ShoppingList\ShoppingListDraft::setTextLineItems ( ?TextLineItemDraftCollection $textLineItems )

Parameters

?TextLineItemDraftCollection $textLineItems

Implemented in Commercetools\Api\Models\ShoppingList\ShoppingListDraftModel.

Member Data Documentation

◆ FIELD_ANONYMOUS_ID

const Commercetools\Api\Models\ShoppingList\ShoppingListDraft::FIELD_ANONYMOUS_ID = 'anonymousId'

Definition at line 25 of file ShoppingListDraft.php.

◆ FIELD_CUSTOM

const Commercetools\Api\Models\ShoppingList\ShoppingListDraft::FIELD_CUSTOM = 'custom'

Definition at line 30 of file ShoppingListDraft.php.

◆ FIELD_CUSTOMER

const Commercetools\Api\Models\ShoppingList\ShoppingListDraft::FIELD_CUSTOMER = 'customer'

Definition at line 22 of file ShoppingListDraft.php.

◆ FIELD_DELETE_DAYS_AFTER_LAST_MODIFICATION

const Commercetools\Api\Models\ShoppingList\ShoppingListDraft::FIELD_DELETE_DAYS_AFTER_LAST_MODIFICATION = 'deleteDaysAfterLastModification'

Definition at line 26 of file ShoppingListDraft.php.

◆ FIELD_DESCRIPTION

const Commercetools\Api\Models\ShoppingList\ShoppingListDraft::FIELD_DESCRIPTION = 'description'

Definition at line 24 of file ShoppingListDraft.php.

◆ FIELD_KEY

const Commercetools\Api\Models\ShoppingList\ShoppingListDraft::FIELD_KEY = 'key'

Definition at line 23 of file ShoppingListDraft.php.

◆ FIELD_LINE_ITEMS

const Commercetools\Api\Models\ShoppingList\ShoppingListDraft::FIELD_LINE_ITEMS = 'lineItems'

Definition at line 27 of file ShoppingListDraft.php.

◆ FIELD_NAME

const Commercetools\Api\Models\ShoppingList\ShoppingListDraft::FIELD_NAME = 'name'

Definition at line 20 of file ShoppingListDraft.php.

◆ FIELD_SLUG

const Commercetools\Api\Models\ShoppingList\ShoppingListDraft::FIELD_SLUG = 'slug'

Definition at line 21 of file ShoppingListDraft.php.

◆ FIELD_STORE

const Commercetools\Api\Models\ShoppingList\ShoppingListDraft::FIELD_STORE = 'store'

Definition at line 29 of file ShoppingListDraft.php.

◆ FIELD_TEXT_LINE_ITEMS

const Commercetools\Api\Models\ShoppingList\ShoppingListDraft::FIELD_TEXT_LINE_ITEMS = 'textLineItems'

Definition at line 28 of file ShoppingListDraft.php.

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

lib/commercetools-api/src/Models/ShoppingList/ShoppingListDraft.php

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getAnonymousId()

◆ getCustom()

◆ getCustomer()

◆ getDeleteDaysAfterLastModification()

◆ getDescription()

◆ getKey()

◆ getLineItems()

◆ getName()

◆ getSlug()

◆ getStore()

◆ getTextLineItems()

◆ setAnonymousId()

◆ setCustom()

◆ setCustomer()

◆ setDeleteDaysAfterLastModification()

◆ setDescription()

◆ setKey()

◆ setLineItems()

◆ setName()

◆ setSlug()

◆ setStore()

◆ setTextLineItems()

Member Data Documentation

◆ FIELD_ANONYMOUS_ID

◆ FIELD_CUSTOM

◆ FIELD_CUSTOMER

◆ FIELD_DELETE_DAYS_AFTER_LAST_MODIFICATION

◆ FIELD_DESCRIPTION

◆ FIELD_KEY

◆ FIELD_LINE_ITEMS

◆ FIELD_NAME

◆ FIELD_SLUG

◆ FIELD_STORE

◆ FIELD_TEXT_LINE_ITEMS