commercetools-sdk-php-v2
The commercetools platform, import-api and PHP sdks generated from our api reference.
lib
commercetools-api
src
Models
BusinessUnit
BusinessUnit.php
1
<?php
2
3
declare(strict_types=1);
9
namespace
Commercetools\Api\Models\BusinessUnit
;
10
11
use
Commercetools\Api\Models\Common\AddressCollection
;
12
use
Commercetools\Api\Models\Common\BaseResource
;
13
use
Commercetools\Api\Models\Common\CreatedBy
;
14
use
Commercetools\Api\Models\Common\LastModifiedBy
;
15
use
Commercetools\Api\Models\Store\StoreKeyReferenceCollection
;
16
use
Commercetools\Api\Models\Type\CustomFields
;
17
use
Commercetools\Base\DateTimeImmutableCollection
;
18
use
Commercetools\Base\JsonObject
;
19
use DateTimeImmutable;
20
21
interface
BusinessUnit
extends
BaseResource
22
{
23
public
const
DISCRIMINATOR_FIELD
=
'unitType'
;
24
public
const
FIELD_LAST_MODIFIED_BY
=
'lastModifiedBy'
;
25
public
const
FIELD_CREATED_BY
=
'createdBy'
;
26
public
const
FIELD_KEY
=
'key'
;
27
public
const
FIELD_STATUS
=
'status'
;
28
public
const
FIELD_STORES
=
'stores'
;
29
public
const
FIELD_STORE_MODE
=
'storeMode'
;
30
public
const
FIELD_UNIT_TYPE
=
'unitType'
;
31
public
const
FIELD_NAME
=
'name'
;
32
public
const
FIELD_CONTACT_EMAIL
=
'contactEmail'
;
33
public
const
FIELD_CUSTOM
=
'custom'
;
34
public
const
FIELD_ADDRESSES
=
'addresses'
;
35
public
const
FIELD_SHIPPING_ADDRESS_IDS
=
'shippingAddressIds'
;
36
public
const
FIELD_DEFAULT_SHIPPING_ADDRESS_ID
=
'defaultShippingAddressId'
;
37
public
const
FIELD_BILLING_ADDRESS_IDS
=
'billingAddressIds'
;
38
public
const
FIELD_DEFAULT_BILLING_ADDRESS_ID
=
'defaultBillingAddressId'
;
39
public
const
FIELD_ASSOCIATE_MODE
=
'associateMode'
;
40
public
const
FIELD_ASSOCIATES
=
'associates'
;
41
public
const
FIELD_INHERITED_ASSOCIATES
=
'inheritedAssociates'
;
42
public
const
FIELD_PARENT_UNIT
=
'parentUnit'
;
43
public
const
FIELD_TOP_LEVEL_UNIT
=
'topLevelUnit'
;
44
public
const
FIELD_APPROVAL_RULE_MODE
=
'approvalRuleMode'
;
45
52
public
function
getId
();
53
60
public
function
getVersion
();
61
68
public
function
getCreatedAt
();
69
76
public
function
getLastModifiedAt
();
77
84
public
function
getLastModifiedBy
();
85
92
public
function
getCreatedBy
();
93
100
public
function
getKey
();
101
108
public
function
getStatus
();
109
118
public
function
getStores
();
119
126
public
function
getStoreMode
();
127
134
public
function
getUnitType
();
135
142
public
function
getName
();
143
150
public
function
getContactEmail
();
151
158
public
function
getCustom
();
159
166
public
function
getAddresses
();
167
174
public
function
getShippingAddressIds
();
175
182
public
function
getDefaultShippingAddressId
();
183
190
public
function
getBillingAddressIds
();
191
198
public
function
getDefaultBillingAddressId
();
199
206
public
function
getAssociateMode
();
207
214
public
function
getAssociates
();
215
222
public
function
getInheritedAssociates
();
223
230
public
function
getParentUnit
();
231
238
public
function
getTopLevelUnit
();
239
247
public
function
getApprovalRuleMode
();
248
252
public
function
setId
(?
string
$id): void;
253
257
public
function
setVersion
(?
int
$version): void;
258
262
public
function
setCreatedAt
(?DateTimeImmutable $createdAt): void;
263
267
public
function
setLastModifiedAt
(?DateTimeImmutable $lastModifiedAt): void;
268
272
public
function
setLastModifiedBy
(?
LastModifiedBy
$lastModifiedBy): void;
273
277
public
function
setCreatedBy
(?
CreatedBy
$createdBy): void;
278
282
public
function
setKey
(?
string
$key): void;
283
287
public
function
setStatus
(?
string
$status): void;
288
292
public
function
setStores
(?
StoreKeyReferenceCollection
$stores): void;
293
297
public
function
setStoreMode
(?
string
$storeMode): void;
298
302
public
function
setName
(?
string
$name): void;
303
307
public
function
setContactEmail
(?
string
$contactEmail): void;
308
312
public
function
setCustom
(?
CustomFields
$custom): void;
313
317
public
function
setAddresses
(?
AddressCollection
$addresses): void;
318
322
public
function
setShippingAddressIds
(?array $shippingAddressIds): void;
323
327
public
function
setDefaultShippingAddressId
(?
string
$defaultShippingAddressId): void;
328
332
public
function
setBillingAddressIds
(?array $billingAddressIds): void;
333
337
public
function
setDefaultBillingAddressId
(?
string
$defaultBillingAddressId): void;
338
342
public
function
setAssociateMode
(?
string
$associateMode): void;
343
347
public
function
setAssociates
(?
AssociateCollection
$associates): void;
348
352
public
function
setInheritedAssociates
(?
InheritedAssociateCollection
$inheritedAssociates): void;
353
357
public
function
setParentUnit
(?
BusinessUnitKeyReference
$parentUnit): void;
358
362
public
function
setTopLevelUnit
(?
BusinessUnitKeyReference
$topLevelUnit): void;
363
367
public
function
setApprovalRuleMode
(?
string
$approvalRuleMode): void;
368
}
Commercetools\Api\Models\BusinessUnit\AssociateCollection
Definition:
AssociateCollection.php:22
Commercetools\Api\Models\BusinessUnit\InheritedAssociateCollection
Definition:
InheritedAssociateCollection.php:22
Commercetools\Api\Models\Common\AddressCollection
Definition:
AddressCollection.php:22
Commercetools\Api\Models\Store\StoreKeyReferenceCollection
Definition:
StoreKeyReferenceCollection.php:22
Commercetools\Base\DateTimeImmutableCollection
Definition:
DateTimeImmutableCollection.php:21
Commercetools\Api\Models\BusinessUnit\BusinessUnit
Definition:
BusinessUnit.php:22
Commercetools\Api\Models\BusinessUnit\BusinessUnit\getStatus
getStatus()
Commercetools\Api\Models\BusinessUnit\BusinessUnit\FIELD_ADDRESSES
const FIELD_ADDRESSES
Definition:
BusinessUnit.php:34
Commercetools\Api\Models\BusinessUnit\BusinessUnit\getId
getId()
Commercetools\Api\Models\BusinessUnit\BusinessUnit\setAssociateMode
setAssociateMode(?string $associateMode)
Commercetools\Api\Models\BusinessUnit\BusinessUnit\getVersion
getVersion()
Commercetools\Api\Models\BusinessUnit\BusinessUnit\FIELD_LAST_MODIFIED_BY
const FIELD_LAST_MODIFIED_BY
Definition:
BusinessUnit.php:24
Commercetools\Api\Models\BusinessUnit\BusinessUnit\setCreatedBy
setCreatedBy(?CreatedBy $createdBy)
Commercetools\Api\Models\BusinessUnit\BusinessUnit\setCreatedAt
setCreatedAt(?DateTimeImmutable $createdAt)
Commercetools\Api\Models\BusinessUnit\BusinessUnit\FIELD_UNIT_TYPE
const FIELD_UNIT_TYPE
Definition:
BusinessUnit.php:30
Commercetools\Api\Models\BusinessUnit\BusinessUnit\getCreatedBy
getCreatedBy()
Commercetools\Api\Models\BusinessUnit\BusinessUnit\getInheritedAssociates
getInheritedAssociates()
Commercetools\Api\Models\BusinessUnit\BusinessUnit\setKey
setKey(?string $key)
Commercetools\Api\Models\BusinessUnit\BusinessUnit\getApprovalRuleMode
getApprovalRuleMode()
Commercetools\Api\Models\BusinessUnit\BusinessUnit\getAssociateMode
getAssociateMode()
Commercetools\Api\Models\BusinessUnit\BusinessUnit\FIELD_STATUS
const FIELD_STATUS
Definition:
BusinessUnit.php:27
Commercetools\Api\Models\BusinessUnit\BusinessUnit\getLastModifiedBy
getLastModifiedBy()
Commercetools\Api\Models\BusinessUnit\BusinessUnit\setDefaultBillingAddressId
setDefaultBillingAddressId(?string $defaultBillingAddressId)
Commercetools\Api\Models\BusinessUnit\BusinessUnit\getTopLevelUnit
getTopLevelUnit()
Commercetools\Api\Models\BusinessUnit\BusinessUnit\getKey
getKey()
Commercetools\Api\Models\BusinessUnit\BusinessUnit\getContactEmail
getContactEmail()
Commercetools\Api\Models\BusinessUnit\BusinessUnit\setDefaultShippingAddressId
setDefaultShippingAddressId(?string $defaultShippingAddressId)
Commercetools\Api\Models\BusinessUnit\BusinessUnit\getDefaultShippingAddressId
getDefaultShippingAddressId()
Commercetools\Api\Models\BusinessUnit\BusinessUnit\setApprovalRuleMode
setApprovalRuleMode(?string $approvalRuleMode)
Commercetools\Api\Models\BusinessUnit\BusinessUnit\FIELD_CUSTOM
const FIELD_CUSTOM
Definition:
BusinessUnit.php:33
Commercetools\Api\Models\BusinessUnit\BusinessUnit\FIELD_ASSOCIATE_MODE
const FIELD_ASSOCIATE_MODE
Definition:
BusinessUnit.php:39
Commercetools\Api\Models\BusinessUnit\BusinessUnit\setVersion
setVersion(?int $version)
Commercetools\Api\Models\BusinessUnit\BusinessUnit\FIELD_SHIPPING_ADDRESS_IDS
const FIELD_SHIPPING_ADDRESS_IDS
Definition:
BusinessUnit.php:35
Commercetools\Api\Models\BusinessUnit\BusinessUnit\FIELD_STORE_MODE
const FIELD_STORE_MODE
Definition:
BusinessUnit.php:29
Commercetools\Api\Models\BusinessUnit\BusinessUnit\getAddresses
getAddresses()
Commercetools\Api\Models\BusinessUnit\BusinessUnit\setTopLevelUnit
setTopLevelUnit(?BusinessUnitKeyReference $topLevelUnit)
Commercetools\Api\Models\BusinessUnit\BusinessUnit\getParentUnit
getParentUnit()
Commercetools\Api\Models\BusinessUnit\BusinessUnit\getLastModifiedAt
getLastModifiedAt()
Commercetools\Api\Models\BusinessUnit\BusinessUnit\getDefaultBillingAddressId
getDefaultBillingAddressId()
Commercetools\Api\Models\BusinessUnit\BusinessUnit\setShippingAddressIds
setShippingAddressIds(?array $shippingAddressIds)
Commercetools\Api\Models\BusinessUnit\BusinessUnit\getStoreMode
getStoreMode()
Commercetools\Api\Models\BusinessUnit\BusinessUnit\getName
getName()
Commercetools\Api\Models\BusinessUnit\BusinessUnit\setId
setId(?string $id)
Commercetools\Api\Models\BusinessUnit\BusinessUnit\getCreatedAt
getCreatedAt()
Commercetools\Api\Models\BusinessUnit\BusinessUnit\setParentUnit
setParentUnit(?BusinessUnitKeyReference $parentUnit)
Commercetools\Api\Models\BusinessUnit\BusinessUnit\setStoreMode
setStoreMode(?string $storeMode)
Commercetools\Api\Models\BusinessUnit\BusinessUnit\FIELD_KEY
const FIELD_KEY
Definition:
BusinessUnit.php:26
Commercetools\Api\Models\BusinessUnit\BusinessUnit\setAddresses
setAddresses(?AddressCollection $addresses)
Commercetools\Api\Models\BusinessUnit\BusinessUnit\getStores
getStores()
Commercetools\Api\Models\BusinessUnit\BusinessUnit\setStores
setStores(?StoreKeyReferenceCollection $stores)
Commercetools\Api\Models\BusinessUnit\BusinessUnit\getAssociates
getAssociates()
Commercetools\Api\Models\BusinessUnit\BusinessUnit\FIELD_PARENT_UNIT
const FIELD_PARENT_UNIT
Definition:
BusinessUnit.php:42
Commercetools\Api\Models\BusinessUnit\BusinessUnit\FIELD_CREATED_BY
const FIELD_CREATED_BY
Definition:
BusinessUnit.php:25
Commercetools\Api\Models\BusinessUnit\BusinessUnit\setContactEmail
setContactEmail(?string $contactEmail)
Commercetools\Api\Models\BusinessUnit\BusinessUnit\setInheritedAssociates
setInheritedAssociates(?InheritedAssociateCollection $inheritedAssociates)
Commercetools\Api\Models\BusinessUnit\BusinessUnit\FIELD_BILLING_ADDRESS_IDS
const FIELD_BILLING_ADDRESS_IDS
Definition:
BusinessUnit.php:37
Commercetools\Api\Models\BusinessUnit\BusinessUnit\FIELD_TOP_LEVEL_UNIT
const FIELD_TOP_LEVEL_UNIT
Definition:
BusinessUnit.php:43
Commercetools\Api\Models\BusinessUnit\BusinessUnit\FIELD_DEFAULT_BILLING_ADDRESS_ID
const FIELD_DEFAULT_BILLING_ADDRESS_ID
Definition:
BusinessUnit.php:38
Commercetools\Api\Models\BusinessUnit\BusinessUnit\setLastModifiedBy
setLastModifiedBy(?LastModifiedBy $lastModifiedBy)
Commercetools\Api\Models\BusinessUnit\BusinessUnit\FIELD_DEFAULT_SHIPPING_ADDRESS_ID
const FIELD_DEFAULT_SHIPPING_ADDRESS_ID
Definition:
BusinessUnit.php:36
Commercetools\Api\Models\BusinessUnit\BusinessUnit\getUnitType
getUnitType()
Commercetools\Api\Models\BusinessUnit\BusinessUnit\FIELD_CONTACT_EMAIL
const FIELD_CONTACT_EMAIL
Definition:
BusinessUnit.php:32
Commercetools\Api\Models\BusinessUnit\BusinessUnit\DISCRIMINATOR_FIELD
const DISCRIMINATOR_FIELD
Definition:
BusinessUnit.php:23
Commercetools\Api\Models\BusinessUnit\BusinessUnit\setName
setName(?string $name)
Commercetools\Api\Models\BusinessUnit\BusinessUnit\FIELD_APPROVAL_RULE_MODE
const FIELD_APPROVAL_RULE_MODE
Definition:
BusinessUnit.php:44
Commercetools\Api\Models\BusinessUnit\BusinessUnit\FIELD_ASSOCIATES
const FIELD_ASSOCIATES
Definition:
BusinessUnit.php:40
Commercetools\Api\Models\BusinessUnit\BusinessUnit\FIELD_STORES
const FIELD_STORES
Definition:
BusinessUnit.php:28
Commercetools\Api\Models\BusinessUnit\BusinessUnit\getCustom
getCustom()
Commercetools\Api\Models\BusinessUnit\BusinessUnit\FIELD_NAME
const FIELD_NAME
Definition:
BusinessUnit.php:31
Commercetools\Api\Models\BusinessUnit\BusinessUnit\setStatus
setStatus(?string $status)
Commercetools\Api\Models\BusinessUnit\BusinessUnit\getBillingAddressIds
getBillingAddressIds()
Commercetools\Api\Models\BusinessUnit\BusinessUnit\setCustom
setCustom(?CustomFields $custom)
Commercetools\Api\Models\BusinessUnit\BusinessUnit\setLastModifiedAt
setLastModifiedAt(?DateTimeImmutable $lastModifiedAt)
Commercetools\Api\Models\BusinessUnit\BusinessUnit\setAssociates
setAssociates(?AssociateCollection $associates)
Commercetools\Api\Models\BusinessUnit\BusinessUnit\FIELD_INHERITED_ASSOCIATES
const FIELD_INHERITED_ASSOCIATES
Definition:
BusinessUnit.php:41
Commercetools\Api\Models\BusinessUnit\BusinessUnit\getShippingAddressIds
getShippingAddressIds()
Commercetools\Api\Models\BusinessUnit\BusinessUnit\setBillingAddressIds
setBillingAddressIds(?array $billingAddressIds)
Commercetools\Api\Models\BusinessUnit\BusinessUnitKeyReference
Definition:
BusinessUnitKeyReference.php:16
Commercetools\Api\Models\Common\BaseResource
Definition:
BaseResource.php:249
Commercetools\Api\Models\Common\CreatedBy
Definition:
CreatedBy.php:16
Commercetools\Api\Models\Common\LastModifiedBy
Definition:
LastModifiedBy.php:16
Commercetools\Api\Models\Type\CustomFields
Definition:
CustomFields.php:15
Commercetools\Base\JsonObject
Definition:
JsonObject.php:15
Commercetools\Api\Models\BusinessUnit
Definition:
Associate.php:9
Generated by
1.9.1