commercetools-sdk-php-v2  master
The platform, import-api and ml-api PHP sdks generated from our api reference.
Public Member Functions | Public Attributes | List of all members
Commercetools\Api\Models\Project\Project Interface Reference
Inheritance diagram for Commercetools\Api\Models\Project\Project:
Commercetools\Base\JsonObject Commercetools\Api\Models\Project\ProjectModel

Public Member Functions

 getVersion ()
 
 getKey ()
 
 getName ()
 
 getCountries ()
 
 getCurrencies ()
 
 getLanguages ()
 
 getCreatedAt ()
 
 getTrialUntil ()
 
 getMessages ()
 
 getCarts ()
 
 getShoppingLists ()
 
 getShippingRateInputType ()
 
 getExternalOAuth ()
 
 getSearchIndexing ()
 
 getBusinessUnits ()
 
 setVersion (?int $version)
 
 setKey (?string $key)
 
 setName (?string $name)
 
 setCountries (?array $countries)
 
 setCurrencies (?array $currencies)
 
 setLanguages (?array $languages)
 
 setCreatedAt (?DateTimeImmutable $createdAt)
 
 setTrialUntil (?string $trialUntil)
 
 setMessages (?MessagesConfiguration $messages)
 
 setCarts (?CartsConfiguration $carts)
 
 setShoppingLists (?ShoppingListsConfiguration $shoppingLists)
 
 setShippingRateInputType (?ShippingRateInputType $shippingRateInputType)
 
 setExternalOAuth (?ExternalOAuth $externalOAuth)
 
 setSearchIndexing (?SearchIndexingConfiguration $searchIndexing)
 
 setBusinessUnits (?BusinessUnitConfiguration $businessUnits)
 
- Public Member Functions inherited from Commercetools\Base\JsonObject
 get (string $field)
 
 with (callable $callable=null)
 

Public Attributes

const FIELD_VERSION = 'version'
 
const FIELD_KEY = 'key'
 
const FIELD_NAME = 'name'
 
const FIELD_COUNTRIES = 'countries'
 
const FIELD_CURRENCIES = 'currencies'
 
const FIELD_LANGUAGES = 'languages'
 
const FIELD_CREATED_AT = 'createdAt'
 
const FIELD_TRIAL_UNTIL = 'trialUntil'
 
const FIELD_MESSAGES = 'messages'
 
const FIELD_CARTS = 'carts'
 
const FIELD_SHOPPING_LISTS = 'shoppingLists'
 
const FIELD_SHIPPING_RATE_INPUT_TYPE = 'shippingRateInputType'
 
const FIELD_EXTERNAL_O_AUTH = 'externalOAuth'
 
const FIELD_SEARCH_INDEXING = 'searchIndexing'
 
const FIELD_BUSINESS_UNITS = 'businessUnits'
 

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 16 of file Project.php.

Member Function Documentation

◆ getBusinessUnits()

Commercetools\Api\Models\Project\Project::getBusinessUnits ( )

Holds configuration specific to Business Units.

Returns
null|BusinessUnitConfiguration

Implemented in Commercetools\Api\Models\Project\ProjectModel.

◆ getCarts()

Commercetools\Api\Models\Project\Project::getCarts ( )

Holds the configuration for the Carts feature.

Returns
null|CartsConfiguration

Implemented in Commercetools\Api\Models\Project\ProjectModel.

◆ getCountries()

Commercetools\Api\Models\Project\Project::getCountries ( )

Country code of the geographic location.

Returns
null|array

Implemented in Commercetools\Api\Models\Project\ProjectModel.

◆ getCreatedAt()

Commercetools\Api\Models\Project\Project::getCreatedAt ( )

Date and time (UTC) the Project was initially created.

Returns
null|DateTimeImmutable

Implemented in Commercetools\Api\Models\Project\ProjectModel.

◆ getCurrencies()

Commercetools\Api\Models\Project\Project::getCurrencies ( )

Currency code of the country. A Project must have at least one currency.

Returns
null|array

Implemented in Commercetools\Api\Models\Project\ProjectModel.

◆ getExternalOAuth()

Commercetools\Api\Models\Project\Project::getExternalOAuth ( )

Represents a RFC 7662 compliant OAuth 2.0 Token Introspection endpoint.

Returns
null|ExternalOAuth

Implemented in Commercetools\Api\Models\Project\ProjectModel.

◆ getKey()

Commercetools\Api\Models\Project\Project::getKey ( )

User-defined unique identifier of the Project.

Returns
null|string

Implemented in Commercetools\Api\Models\Project\ProjectModel.

◆ getLanguages()

Commercetools\Api\Models\Project\Project::getLanguages ( )

Language of the country. A Project must have at least one language.

Returns
null|array

Implemented in Commercetools\Api\Models\Project\ProjectModel.

◆ getMessages()

Commercetools\Api\Models\Project\Project::getMessages ( )

Holds the configuration for the Messages Query feature.

Returns
null|MessagesConfiguration

Implemented in Commercetools\Api\Models\Project\ProjectModel.

◆ getName()

Commercetools\Api\Models\Project\Project::getName ( )

Name of the Project.

Returns
null|string

Implemented in Commercetools\Api\Models\Project\ProjectModel.

◆ getSearchIndexing()

Commercetools\Api\Models\Project\Project::getSearchIndexing ( )

Controls indexing of resources to be provided on high performance read-only search endpoints.

Returns
null|SearchIndexingConfiguration

Implemented in Commercetools\Api\Models\Project\ProjectModel.

◆ getShippingRateInputType()

Commercetools\Api\Models\Project\Project::getShippingRateInputType ( )

Holds the configuration for the tiered shipping rates feature.

Returns
null|ShippingRateInputType

Implemented in Commercetools\Api\Models\Project\ProjectModel.

◆ getShoppingLists()

Commercetools\Api\Models\Project\Project::getShoppingLists ( )

Holds the configuration for the Shopping Lists feature. This field may not be present on Projects created before January 2020.

Returns
null|ShoppingListsConfiguration

Implemented in Commercetools\Api\Models\Project\ProjectModel.

◆ getTrialUntil()

Commercetools\Api\Models\Project\Project::getTrialUntil ( )

Date in YYYY-MM format specifying when the trial period for the Project ends. Only present on Projects in trial period.

Returns
null|string

Implemented in Commercetools\Api\Models\Project\ProjectModel.

◆ getVersion()

Commercetools\Api\Models\Project\Project::getVersion ( )

Current version of the Project.

Returns
null|int

Implemented in Commercetools\Api\Models\Project\ProjectModel.

◆ setBusinessUnits()

Commercetools\Api\Models\Project\Project::setBusinessUnits ( ?BusinessUnitConfiguration  $businessUnits)
Parameters
?BusinessUnitConfiguration$businessUnits

Implemented in Commercetools\Api\Models\Project\ProjectModel.

◆ setCarts()

Commercetools\Api\Models\Project\Project::setCarts ( ?CartsConfiguration  $carts)
Parameters
?CartsConfiguration$carts

Implemented in Commercetools\Api\Models\Project\ProjectModel.

◆ setCountries()

Commercetools\Api\Models\Project\Project::setCountries ( ?array  $countries)
Parameters
?array$countries

Implemented in Commercetools\Api\Models\Project\ProjectModel.

◆ setCreatedAt()

Commercetools\Api\Models\Project\Project::setCreatedAt ( ?DateTimeImmutable  $createdAt)
Parameters
?DateTimeImmutable$createdAt

Implemented in Commercetools\Api\Models\Project\ProjectModel.

◆ setCurrencies()

Commercetools\Api\Models\Project\Project::setCurrencies ( ?array  $currencies)
Parameters
?array$currencies

Implemented in Commercetools\Api\Models\Project\ProjectModel.

◆ setExternalOAuth()

Commercetools\Api\Models\Project\Project::setExternalOAuth ( ?ExternalOAuth  $externalOAuth)
Parameters
?ExternalOAuth$externalOAuth

Implemented in Commercetools\Api\Models\Project\ProjectModel.

◆ setKey()

Commercetools\Api\Models\Project\Project::setKey ( ?string  $key)
Parameters
?string$key

Implemented in Commercetools\Api\Models\Project\ProjectModel.

◆ setLanguages()

Commercetools\Api\Models\Project\Project::setLanguages ( ?array  $languages)
Parameters
?array$languages

Implemented in Commercetools\Api\Models\Project\ProjectModel.

◆ setMessages()

Commercetools\Api\Models\Project\Project::setMessages ( ?MessagesConfiguration  $messages)
Parameters
?MessagesConfiguration$messages

Implemented in Commercetools\Api\Models\Project\ProjectModel.

◆ setName()

Commercetools\Api\Models\Project\Project::setName ( ?string  $name)
Parameters
?string$name

Implemented in Commercetools\Api\Models\Project\ProjectModel.

◆ setSearchIndexing()

Commercetools\Api\Models\Project\Project::setSearchIndexing ( ?SearchIndexingConfiguration  $searchIndexing)
Parameters
?SearchIndexingConfiguration$searchIndexing

Implemented in Commercetools\Api\Models\Project\ProjectModel.

◆ setShippingRateInputType()

Commercetools\Api\Models\Project\Project::setShippingRateInputType ( ?ShippingRateInputType  $shippingRateInputType)
Parameters
?ShippingRateInputType$shippingRateInputType

Implemented in Commercetools\Api\Models\Project\ProjectModel.

◆ setShoppingLists()

Commercetools\Api\Models\Project\Project::setShoppingLists ( ?ShoppingListsConfiguration  $shoppingLists)
Parameters
?ShoppingListsConfiguration$shoppingLists

Implemented in Commercetools\Api\Models\Project\ProjectModel.

◆ setTrialUntil()

Commercetools\Api\Models\Project\Project::setTrialUntil ( ?string  $trialUntil)
Parameters
?string$trialUntil

Implemented in Commercetools\Api\Models\Project\ProjectModel.

◆ setVersion()

Commercetools\Api\Models\Project\Project::setVersion ( ?int  $version)
Parameters
?int$version

Implemented in Commercetools\Api\Models\Project\ProjectModel.

Member Data Documentation

◆ FIELD_BUSINESS_UNITS

const Commercetools\Api\Models\Project\Project::FIELD_BUSINESS_UNITS = 'businessUnits'

Definition at line 32 of file Project.php.

◆ FIELD_CARTS

const Commercetools\Api\Models\Project\Project::FIELD_CARTS = 'carts'

Definition at line 27 of file Project.php.

◆ FIELD_COUNTRIES

const Commercetools\Api\Models\Project\Project::FIELD_COUNTRIES = 'countries'

Definition at line 21 of file Project.php.

◆ FIELD_CREATED_AT

const Commercetools\Api\Models\Project\Project::FIELD_CREATED_AT = 'createdAt'

Definition at line 24 of file Project.php.

◆ FIELD_CURRENCIES

const Commercetools\Api\Models\Project\Project::FIELD_CURRENCIES = 'currencies'

Definition at line 22 of file Project.php.

◆ FIELD_EXTERNAL_O_AUTH

const Commercetools\Api\Models\Project\Project::FIELD_EXTERNAL_O_AUTH = 'externalOAuth'

Definition at line 30 of file Project.php.

◆ FIELD_KEY

const Commercetools\Api\Models\Project\Project::FIELD_KEY = 'key'

Definition at line 19 of file Project.php.

◆ FIELD_LANGUAGES

const Commercetools\Api\Models\Project\Project::FIELD_LANGUAGES = 'languages'

Definition at line 23 of file Project.php.

◆ FIELD_MESSAGES

const Commercetools\Api\Models\Project\Project::FIELD_MESSAGES = 'messages'

Definition at line 26 of file Project.php.

◆ FIELD_NAME

const Commercetools\Api\Models\Project\Project::FIELD_NAME = 'name'

Definition at line 20 of file Project.php.

◆ FIELD_SEARCH_INDEXING

const Commercetools\Api\Models\Project\Project::FIELD_SEARCH_INDEXING = 'searchIndexing'

Definition at line 31 of file Project.php.

◆ FIELD_SHIPPING_RATE_INPUT_TYPE

const Commercetools\Api\Models\Project\Project::FIELD_SHIPPING_RATE_INPUT_TYPE = 'shippingRateInputType'

Definition at line 29 of file Project.php.

◆ FIELD_SHOPPING_LISTS

const Commercetools\Api\Models\Project\Project::FIELD_SHOPPING_LISTS = 'shoppingLists'

Definition at line 28 of file Project.php.

◆ FIELD_TRIAL_UNTIL

const Commercetools\Api\Models\Project\Project::FIELD_TRIAL_UNTIL = 'trialUntil'

Definition at line 25 of file Project.php.

◆ FIELD_VERSION

const Commercetools\Api\Models\Project\Project::FIELD_VERSION = 'version'

Definition at line 18 of file Project.php.


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