diff --git a/changes.md b/changes.md
index 7b024e8d98a..fe8fca7df90 100644
--- a/changes.md
+++ b/changes.md
@@ -404,6 +404,13 @@
**Import changes**
+Added Enum(s)
+
+- added enum `product-selection` to type `ImportResourceType`
+Added Property(s)
@@ -418,6 +425,14 @@
Changed Property(s)
+
+- :warning: changed property `country` of type `ExternalTaxRateDraft` from type `string` to `CountryCode`
+- :warning: changed property `value` of type `MoneySetField` from type `Money[]` to `TypedMoney[]`
+Removed Property(s)
@@ -426,6 +441,13 @@
Added Method(s)
+
+- added method `$apiRoot->withProjectKeyValue()->productSelections()->importContainers()->withImportContainerKeyValue()->post()`
+Added Type(s)
@@ -433,7 +455,23 @@
- added type `RetentionPolicy`
- added type `TimeToLiveConfig`
- added type `TimeToLiveRetentionPolicy`
+- added type `ProductSelectionImportRequest`
- added type `AttributeLevel`
+- added type `VariantSelectionType`
+- added type `VariantSelection`
+- added type `VariantExclusion`
+- added type `ProductSelectionAssignment`
+- added type `ProductSelectionMode`
+- added type `ProductSelectionImport`
+Added Resource(s)
+
+- added resource `/{projectKey}/product-selections`
+- added resource `/{projectKey}/product-selections/import-containers`
+- added resource `/{projectKey}/product-selections/import-containers/{importContainerKey}`
Unique identifier of the Asset.
+ *Unique identifier of the Asset. Not required when importing Assets using the Import API.
* * @return null|string diff --git a/lib/commercetools-api/src/Models/Common/AssetBuilder.php b/lib/commercetools-api/src/Models/Common/AssetBuilder.php index 9b152b3f96d..a0457a214bb 100644 --- a/lib/commercetools-api/src/Models/Common/AssetBuilder.php +++ b/lib/commercetools-api/src/Models/Common/AssetBuilder.php @@ -65,7 +65,7 @@ final class AssetBuilder implements Builder private $key; /** - *Unique identifier of the Asset.
+ *Unique identifier of the Asset. Not required when importing Assets using the Import API.
* * @return null|string diff --git a/lib/commercetools-api/src/Models/Common/AssetModel.php b/lib/commercetools-api/src/Models/Common/AssetModel.php index f4e55b68a49..7eb5d98da43 100644 --- a/lib/commercetools-api/src/Models/Common/AssetModel.php +++ b/lib/commercetools-api/src/Models/Common/AssetModel.php @@ -86,7 +86,7 @@ public function __construct( } /** - *Unique identifier of the Asset.
+ *Unique identifier of the Asset. Not required when importing Assets using the Import API.
* * * @return null|string diff --git a/lib/commercetools-import-tests/test/unit/Client/Resource/ResourceByProjectKeyProductSelectionsImportContainersByImportContainerKeyTest.php b/lib/commercetools-import-tests/test/unit/Client/Resource/ResourceByProjectKeyProductSelectionsImportContainersByImportContainerKeyTest.php new file mode 100644 index 00000000000..d7968127fe8 --- /dev/null +++ b/lib/commercetools-import-tests/test/unit/Client/Resource/ResourceByProjectKeyProductSelectionsImportContainersByImportContainerKeyTest.php @@ -0,0 +1,168 @@ +assertSame(strtolower($method), strtolower($request->getMethod())); + $this->assertSame($relativeUri, (string) $request->getUri()); + if (!is_null($body)) { + $this->assertJsonStringEqualsJsonString($body, (string) $request->getBody()); + } else { + $this->assertSame("", (string) $request->getBody()); + } + } + + + + /** + * @dataProvider getRequestBuilderResponses() + */ + public function testMapFromResponse(callable $builderFunction, $statusCode) + { + $builder = new ImportRequestBuilder(); + $request = $builderFunction($builder); + $this->assertInstanceOf(ApiRequest::class, $request); + + $response = new Response($statusCode, [], "{}"); + $this->assertInstanceOf(JsonObject::class, $request->mapFromResponse($response)); + } + + /** + * @dataProvider getRequestBuilders() + */ + public function testExecuteClientException(callable $builderFunction) + { + $client = $this->createMock(ClientInterface::class); + + $builder = new ImportRequestBuilder($client); + $request = $builderFunction($builder); + $client->method("send")->willThrowException(new ClientException("Oops!", $request, new Response(400))); + + $this->expectException(ApiClientException::class); + $request->execute(); + } + + /** + * @dataProvider getRequestBuilders() + */ + public function testExecuteServerException(callable $builderFunction) + { + $client = $this->createMock(ClientInterface::class); + + $builder = new ImportRequestBuilder($client); + $request = $builderFunction($builder); + $client->method("send")->willThrowException(new ServerException("Oops!", $request, new Response(500))); + + $this->expectException(ApiServerException::class); + $request->execute(); + } + + public function getRequests() + { + return [ + 'ByProjectKeyProductSelectionsImportContainersByImportContainerKeyPost' => [ + function (ImportRequestBuilder $builder): RequestInterface { + return $builder + ->withProjectKeyValue("test_projectKey") + ->productSelections() + ->importContainers() + ->withImportContainerKeyValue("test_importContainerKey") + ->post(null); + }, + 'post', + 'test_projectKey/product-selections/import-containers/test_importContainerKey', + ] + ]; + } + + public function getResources() + { + return [ + ]; + } + + public function getRequestBuilders() + { + return [ + 'ByProjectKeyProductSelectionsImportContainersByImportContainerKeyPost' => [ + function (ImportRequestBuilder $builder): RequestInterface { + return $builder + ->withProjectKeyValue("projectKey") + ->productSelections() + ->importContainers() + ->withImportContainerKeyValue("importContainerKey") + ->post(null); + } + ] + ]; + } + + public function getRequestBuilderResponses() + { + return [ + 'ByProjectKeyProductSelectionsImportContainersByImportContainerKeyPost_201' => [ + function (ImportRequestBuilder $builder): RequestInterface { + return $builder + ->withProjectKeyValue("projectKey") + ->productSelections() + ->importContainers() + ->withImportContainerKeyValue("importContainerKey") + ->post(null); + }, + 201 + ], + 'ByProjectKeyProductSelectionsImportContainersByImportContainerKeyPost_400' => [ + function (ImportRequestBuilder $builder): RequestInterface { + return $builder + ->withProjectKeyValue("projectKey") + ->productSelections() + ->importContainers() + ->withImportContainerKeyValue("importContainerKey") + ->post(null); + }, + 400 + ], + 'ByProjectKeyProductSelectionsImportContainersByImportContainerKeyPost_599' => [ + function (ImportRequestBuilder $builder): RequestInterface { + return $builder + ->withProjectKeyValue("projectKey") + ->productSelections() + ->importContainers() + ->withImportContainerKeyValue("importContainerKey") + ->post(null); + }, + 599 + ] + ]; + } +} diff --git a/lib/commercetools-import-tests/test/unit/Client/Resource/ResourceByProjectKeyProductSelectionsImportContainersTest.php b/lib/commercetools-import-tests/test/unit/Client/Resource/ResourceByProjectKeyProductSelectionsImportContainersTest.php new file mode 100644 index 00000000000..b71df9e5a73 --- /dev/null +++ b/lib/commercetools-import-tests/test/unit/Client/Resource/ResourceByProjectKeyProductSelectionsImportContainersTest.php @@ -0,0 +1,81 @@ +assertInstanceOf($class, $resource); + $this->assertEquals($expectedArgs, $resource->getArgs()); + } + + + + + + + + public function getRequests() + { + return [ + ]; + } + + public function getResources() + { + return [ + 'ResourceByProjectKeyProductSelectionsImportContainersByImportContainerKey' => [ + function (ImportRequestBuilder $builder): ResourceByProjectKeyProductSelectionsImportContainersByImportContainerKey { + return $builder + ->withProjectKeyValue("test_projectKey") + ->productSelections() + ->importContainers() + ->withImportContainerKeyValue("test_importContainerKey"); + }, + ResourceByProjectKeyProductSelectionsImportContainersByImportContainerKey::class, + ['projectKey' => 'test_projectKey', 'importContainerKey' => 'test_importContainerKey'], + '/{projectKey}/product-selections/import-containers/{importContainerKey}' + ] + ]; + } + + public function getRequestBuilders() + { + return [ + ]; + } + + public function getRequestBuilderResponses() + { + return [ + ]; + } +} diff --git a/lib/commercetools-import-tests/test/unit/Client/Resource/ResourceByProjectKeyProductSelectionsTest.php b/lib/commercetools-import-tests/test/unit/Client/Resource/ResourceByProjectKeyProductSelectionsTest.php new file mode 100644 index 00000000000..54230e642a5 --- /dev/null +++ b/lib/commercetools-import-tests/test/unit/Client/Resource/ResourceByProjectKeyProductSelectionsTest.php @@ -0,0 +1,80 @@ +assertInstanceOf($class, $resource); + $this->assertEquals($expectedArgs, $resource->getArgs()); + } + + + + + + + + public function getRequests() + { + return [ + ]; + } + + public function getResources() + { + return [ + 'ResourceByProjectKeyProductSelectionsImportContainers' => [ + function (ImportRequestBuilder $builder): ResourceByProjectKeyProductSelectionsImportContainers { + return $builder + ->withProjectKeyValue("test_projectKey") + ->productSelections() + ->importContainers(); + }, + ResourceByProjectKeyProductSelectionsImportContainers::class, + ['projectKey' => 'test_projectKey'], + '/{projectKey}/product-selections/import-containers' + ] + ]; + } + + public function getRequestBuilders() + { + return [ + ]; + } + + public function getRequestBuilderResponses() + { + return [ + ]; + } +} diff --git a/lib/commercetools-import-tests/test/unit/Client/Resource/ResourceByProjectKeyTest.php b/lib/commercetools-import-tests/test/unit/Client/Resource/ResourceByProjectKeyTest.php index 10d22f1ce3d..e64974cfaf1 100644 --- a/lib/commercetools-import-tests/test/unit/Client/Resource/ResourceByProjectKeyTest.php +++ b/lib/commercetools-import-tests/test/unit/Client/Resource/ResourceByProjectKeyTest.php @@ -24,6 +24,7 @@ use Commercetools\Import\Client\Resource\ResourceByProjectKeyPrices; use Commercetools\Import\Client\Resource\ResourceByProjectKeyProductDrafts; use Commercetools\Import\Client\Resource\ResourceByProjectKeyProducts; +use Commercetools\Import\Client\Resource\ResourceByProjectKeyProductSelections; use Commercetools\Import\Client\Resource\ResourceByProjectKeyProductTypes; use Commercetools\Import\Client\Resource\ResourceByProjectKeyProductVariantPatches; use Commercetools\Import\Client\Resource\ResourceByProjectKeyProductVariants; @@ -226,6 +227,16 @@ function (ImportRequestBuilder $builder): ResourceByProjectKeyDiscountCodes { ResourceByProjectKeyDiscountCodes::class, ['projectKey' => 'test_projectKey'], '/{projectKey}/discount-codes' + ], + 'ResourceByProjectKeyProductSelections' => [ + function (ImportRequestBuilder $builder): ResourceByProjectKeyProductSelections { + return $builder + ->withProjectKeyValue("test_projectKey") + ->productSelections(); + }, + ResourceByProjectKeyProductSelections::class, + ['projectKey' => 'test_projectKey'], + '/{projectKey}/product-selections' ] ]; } diff --git a/lib/commercetools-import/docs/RequestBuilder.md b/lib/commercetools-import/docs/RequestBuilder.md index 9815569a094..a1f250e6898 100644 --- a/lib/commercetools-import/docs/RequestBuilder.md +++ b/lib/commercetools-import/docs/RequestBuilder.md @@ -10,7 +10,7 @@ $root = new ImportRequestBuilder(); ## `withProjectKeyValue("projectKey")->categories()->importContainers()->withImportContainerKeyValue("importContainerKey")->post(null)` -Creates a request for creating new Categories or updating existing ones. +Creates an Import Request for Categories. ### Example ```php @@ -26,7 +26,7 @@ $request = $builder ``` ## `withProjectKeyValue("projectKey")->customers()->importContainers()->withImportContainerKeyValue("importContainerKey")->post(null)` -Creates a request for creating new Customers or updating existing ones. +Creates an Import Request for Customers. ### Example ```php @@ -42,7 +42,7 @@ $request = $builder ``` ## `withProjectKeyValue("projectKey")->discountCodes()->importContainers()->withImportContainerKeyValue("importContainerKey")->post(null)` -Creates a request for creating new Discount Codes or updating existing ones. +Creates an Import Request for Discount Codes. ### Example ```php @@ -58,7 +58,7 @@ $request = $builder ``` ## `withProjectKeyValue("projectKey")->importContainers()->post(null)` -Creates a new Import Container. +Creates an Import Container in the Project. Generates the [ImportContainerCreated](/projects/events#import-container-created-event) Event. @@ -75,7 +75,7 @@ $request = $builder ``` ## `withProjectKeyValue("projectKey")->importContainers()->get()` -Retrieves all Import Containers of a given project key. +Retrieves all ImportContainers in the Project. ### Example ```php @@ -89,7 +89,7 @@ $request = $builder ``` ## `withProjectKeyValue("projectKey")->importContainers()->withImportContainerKeyValue("importContainerKey")->put(null)` -Updates the Import Container given by the key. +Updates an [ImportContainer](ctp:import:type:ImportContainer) in the Project. ### Example ```php @@ -104,7 +104,7 @@ $request = $builder ``` ## `withProjectKeyValue("projectKey")->importContainers()->withImportContainerKeyValue("importContainerKey")->get()` -Retrieves the Import Container given by the key. +Retrieves an [ImportContainer](ctp:import:type:ImportContainer) with the provided `importContainerKey`. ### Example ```php @@ -119,7 +119,7 @@ $request = $builder ``` ## `withProjectKeyValue("projectKey")->importContainers()->withImportContainerKeyValue("importContainerKey")->delete()` -Deletes the Import Container specified by the `importContainerKey`. +Deletes an Import Container in the Project. Generates the [ImportContainerDeleted](/projects/events#import-container-deleted-event) Event. @@ -137,7 +137,7 @@ $request = $builder ``` ## `withProjectKeyValue("projectKey")->importContainers()->withImportContainerKeyValue("importContainerKey")->importOperations()->get()` -Retrieves all [ImportOperations](ctp:import:type:ImportOperation) of a given ImportContainer key. +Retrieves all ImportOperations within an [ImportContainer](ctp:import:type:ImportContainer). ### Example @@ -154,7 +154,7 @@ $request = $builder ``` ## `withProjectKeyValue("projectKey")->importContainers()->withImportContainerKeyValue("importContainerKey")->importSummaries()->get()` -Retrieves an [ImportSummary](ctp:import:type:ImportSummary) for the given Import Container. An [ImportSummary](ctp:import:type:ImportSummary) is calculated on demand. +Retrieves an [ImportSummary](ctp:import:type:ImportSummary) for the [ImportContainer](ctp:import:type:ImportContainer) with the provided `importContainerKey`. ### Example @@ -171,7 +171,7 @@ $request = $builder ``` ## `withProjectKeyValue("projectKey")->importOperations()->withIdValue("id")->get()` -Retrieves the [ImportOperation](ctp:import:type:ImportOperation) of a given ID. +Retrieves an ImportOperation with the provided `id`. ### Example @@ -187,7 +187,7 @@ $request = $builder ``` ## `withProjectKeyValue("projectKey")->inventories()->importContainers()->withImportContainerKeyValue("importContainerKey")->post(null)` -Creates a request for creating new Inventories or updating existing ones. +Creates an Import Request for InventoryEntries. ### Example ```php @@ -203,7 +203,7 @@ $request = $builder ``` ## `withProjectKeyValue("projectKey")->orderPatches()->importContainers()->withImportContainerKeyValue("importContainerKey")->post(null)` -Creates a new import request for order patches +Creates an Import Request for updating Orders. ### Example ```php @@ -219,7 +219,7 @@ $request = $builder ``` ## `withProjectKeyValue("projectKey")->orders()->importContainers()->withImportContainerKeyValue("importContainerKey")->post(null)` -Creates a request for creating new Orders. +Creates an Import Request for creating Orders. ### Example ```php @@ -235,7 +235,7 @@ $request = $builder ``` ## `withProjectKeyValue("projectKey")->prices()->importContainers()->withImportContainerKeyValue("importContainerKey")->post(null)` -Creates a request for creating new Prices or updating existing ones. +Creates an Import Request for Prices. ### Example ```php @@ -251,7 +251,7 @@ $request = $builder ``` ## `withProjectKeyValue("projectKey")->productDrafts()->importContainers()->withImportContainerKeyValue("importContainerKey")->post(null)` -Creates a request for creating new ProductDrafts or updating existing ones. +Creates an Import Request for Products. ### Example @@ -266,9 +266,25 @@ $request = $builder ->withImportContainerKeyValue("importContainerKey") ->post(null); ``` +## `withProjectKeyValue("projectKey")->productSelections()->importContainers()->withImportContainerKeyValue("importContainerKey")->post(null)` + +Creates an Import Request for Product Selections. + +### Example +```php +use Commercetools\Import\Client\ImportRequestBuilder; + +$builder = new ImportRequestBuilder(); +$request = $builder + ->withProjectKeyValue("projectKey") + ->productSelections() + ->importContainers() + ->withImportContainerKeyValue("importContainerKey") + ->post(null); +``` ## `withProjectKeyValue("projectKey")->productTypes()->importContainers()->withImportContainerKeyValue("importContainerKey")->post(null)` -Creates a request for creating new ProductTypes or updating existing ones. +Creates an Import Request for ProductTypes. ### Example ```php @@ -284,7 +300,7 @@ $request = $builder ``` ## `withProjectKeyValue("projectKey")->productVariantPatches()->importContainers()->withImportContainerKeyValue("importContainerKey")->post(null)` -Creates a new import request for Product Variant Patches. +Creates an Import Request for updating Product Variants. Returns an [InvalidField](ctp:import:type:InvalidFieldError) error if the [ProductVariantPatchRequest](ctp:import:type:ProductVariantPatchRequest) contains patches with and without the `product` field set. @@ -302,7 +318,7 @@ $request = $builder ``` ## `withProjectKeyValue("projectKey")->productVariants()->importContainers()->withImportContainerKeyValue("importContainerKey")->post(null)` -Creates a request for creating new ProductVariants or updating existing ones. +Creates an Import Request for ProductVariants. ### Example ```php @@ -318,7 +334,7 @@ $request = $builder ``` ## `withProjectKeyValue("projectKey")->products()->importContainers()->withImportContainerKeyValue("importContainerKey")->post(null)` -Creates a request for creating new Products or updating existing ones. +Creates an Import Request for Products. ### Example ```php @@ -334,7 +350,7 @@ $request = $builder ``` ## `withProjectKeyValue("projectKey")->standalonePrices()->importContainers()->withImportContainerKeyValue("importContainerKey")->post(null)` -Creates a request for creating new Standalone Prices or updating existing ones. +Creates an Import Request for Standalone Prices. ### Example ```php @@ -350,7 +366,7 @@ $request = $builder ``` ## `withProjectKeyValue("projectKey")->types()->importContainers()->withImportContainerKeyValue("importContainerKey")->post(null)` -Creates a request for creating new Type or updating existing ones. +Creates an Import Request for Types. ### Example ```php diff --git a/lib/commercetools-import/src/Client/Resource/ByProjectKeyProductSelectionsImportContainersByImportContainerKeyPost.php b/lib/commercetools-import/src/Client/Resource/ByProjectKeyProductSelectionsImportContainersByImportContainerKeyPost.php new file mode 100644 index 00000000000..2858deaadf2 --- /dev/null +++ b/lib/commercetools-import/src/Client/Resource/ByProjectKeyProductSelectionsImportContainersByImportContainerKeyPost.php @@ -0,0 +1,124 @@ + + */ +class ByProjectKeyProductSelectionsImportContainersByImportContainerKeyPost extends ApiRequest implements SecuredByManageProductSelections +{ + /** + * @param ?object|array|string $body + * @psalm-param arrayUser-defined unique identifier. If a Category with this key exists, it will be updated with the imported data.
User-defined unique identifier. If a Category with this key exists, it is updated with the imported data.
Maps to Category.slug.
- * Must match the pattern [-a-zA-Z0-9_]{2,256}.
Maps to Category.slug. Must match the pattern ^[A-Za-z0-9_-]{2,256}+$.
Maps to Category.parent.
- * The Reference to the parent Category with which the Category is associated.
- * If referenced Category does not exist, the state of the ImportOperation will be set to unresolved until the necessary Category is created.
Maps to Category.parent. If the referenced Category does not exist, the state of the ImportOperation will be set to unresolved until the referenced Category is created.
The custom fields for this Category.
+ *Maps to Category.custom.
User-defined unique identifier. If a Category with this key exists, it will be updated with the imported data.
User-defined unique identifier. If a Category with this key exists, it is updated with the imported data.
Maps to Category.slug.
- * Must match the pattern [-a-zA-Z0-9_]{2,256}.
Maps to Category.slug. Must match the pattern ^[A-Za-z0-9_-]{2,256}+$.
Maps to Category.parent.
- * The Reference to the parent Category with which the Category is associated.
- * If referenced Category does not exist, the state of the ImportOperation will be set to unresolved until the necessary Category is created.
Maps to Category.parent. If the referenced Category does not exist, the state of the ImportOperation will be set to unresolved until the referenced Category is created.
The custom fields for this Category.
+ *Maps to Category.custom.
User-defined unique identifier. If a Category with this key exists, it will be updated with the imported data.
User-defined unique identifier. If a Category with this key exists, it is updated with the imported data.
Maps to Category.slug.
- * Must match the pattern [-a-zA-Z0-9_]{2,256}.
Maps to Category.slug. Must match the pattern ^[A-Za-z0-9_-]{2,256}+$.
Maps to Category.parent.
- * The Reference to the parent Category with which the Category is associated.
- * If referenced Category does not exist, the state of the ImportOperation will be set to unresolved until the necessary Category is created.
Maps to Category.parent. If the referenced Category does not exist, the state of the ImportOperation will be set to unresolved until the referenced Category is created.
The custom fields for this Category.
+ *Maps to Category.custom.
Unique identifier of the Address.
+ *It is not recommended to set it manually since the API overwrites this ID when creating an Address for a Customer.
+ * Use key instead and omit this field from the request to let the API generate the ID for the Address.
User-defined identifier of the Address that must be unique when multiple addresses are referenced in BusinessUnits, Customers, and itemShippingAddresses (LineItem-specific addresses) of a Cart, Order, QuoteRequest, or Quote.
Title of the contact, for example 'Dr.'
+ * * @return null|string */ public function getTitle(); /** + *Salutation of the contact, for example 'Mr.' or 'Ms.'
+ * * @return null|string */ public function getSalutation(); /** + *Given name (first name) of the contact.
+ * * @return null|string */ public function getFirstName(); /** + *Family name (last name) of the contact.
+ * * @return null|string */ public function getLastName(); /** + *Name of the street.
+ * * @return null|string */ public function getStreetName(); /** + *Street number.
+ * * @return null|string */ public function getStreetNumber(); /** + *Further information on the street address.
+ * * @return null|string */ public function getAdditionalStreetInfo(); /** + *Postal code.
+ * * @return null|string */ public function getPostalCode(); /** + *Name of the city.
+ * * @return null|string */ public function getCity(); /** + *Name of the region.
+ * * @return null|string */ public function getRegion(); /** + *Name of the state, for example, Colorado.
+ * * @return null|string */ public function getState(); /** - *A two-digit country code as per ISO 3166-1 alpha-2.
+ *Name of the country.
* * @return null|string @@ -128,73 +156,95 @@ public function getState(); public function getCountry(); /** + *Name of the company.
+ * * @return null|string */ public function getCompany(); /** + *Name of the department.
+ * * @return null|string */ public function getDepartment(); /** + *Number or name of the building.
+ * * @return null|string */ public function getBuilding(); /** + *Number or name of the apartment.
+ * * @return null|string */ public function getApartment(); /** + *Post office box number.
+ * * @return null|string */ public function getPOBox(); /** + *Phone number of the contact.
+ * * @return null|string */ public function getPhone(); /** + *Mobile phone number of the contact.
+ * * @return null|string */ public function getMobile(); /** + *Email address of the contact.
+ * * @return null|string */ public function getEmail(); /** + *Fax number of the contact.
+ * * @return null|string */ public function getFax(); /** + *Further information on the Address.
+ * * @return null|string */ public function getAdditionalAddressInfo(); /** + *ID for the contact used in an external system.
+ * * @return null|string */ public function getExternalId(); /** - *Custom Fields defined for the Address. Custom Fields can only be applied to shippingAddress.
Custom Fields defined for the Address.
* * @return null|Custom diff --git a/lib/commercetools-import/src/Models/Common/AddressBuilder.php b/lib/commercetools-import/src/Models/Common/AddressBuilder.php index 3a1a5ec2a9c..89d860912fd 100644 --- a/lib/commercetools-import/src/Models/Common/AddressBuilder.php +++ b/lib/commercetools-import/src/Models/Common/AddressBuilder.php @@ -179,6 +179,10 @@ final class AddressBuilder implements Builder private $custom; /** + *Unique identifier of the Address.
+ *It is not recommended to set it manually since the API overwrites this ID when creating an Address for a Customer.
+ * Use key instead and omit this field from the request to let the API generate the ID for the Address.
User-defined identifier of the Address that must be unique when multiple addresses are referenced in BusinessUnits, Customers, and itemShippingAddresses (LineItem-specific addresses) of a Cart, Order, QuoteRequest, or Quote.
Title of the contact, for example 'Dr.'
+ * * @return null|string */ @@ -206,6 +214,8 @@ public function getTitle() } /** + *Salutation of the contact, for example 'Mr.' or 'Ms.'
+ * * @return null|string */ @@ -215,6 +225,8 @@ public function getSalutation() } /** + *Given name (first name) of the contact.
+ * * @return null|string */ @@ -224,6 +236,8 @@ public function getFirstName() } /** + *Family name (last name) of the contact.
+ * * @return null|string */ @@ -233,6 +247,8 @@ public function getLastName() } /** + *Name of the street.
+ * * @return null|string */ @@ -242,6 +258,8 @@ public function getStreetName() } /** + *Street number.
+ * * @return null|string */ @@ -251,6 +269,8 @@ public function getStreetNumber() } /** + *Further information on the street address.
+ * * @return null|string */ @@ -260,6 +280,8 @@ public function getAdditionalStreetInfo() } /** + *Postal code.
+ * * @return null|string */ @@ -269,6 +291,8 @@ public function getPostalCode() } /** + *Name of the city.
+ * * @return null|string */ @@ -278,6 +302,8 @@ public function getCity() } /** + *Name of the region.
+ * * @return null|string */ @@ -287,6 +313,8 @@ public function getRegion() } /** + *Name of the state, for example, Colorado.
+ * * @return null|string */ @@ -296,7 +324,7 @@ public function getState() } /** - *A two-digit country code as per ISO 3166-1 alpha-2.
+ *Name of the country.
* * @return null|string @@ -307,6 +335,8 @@ public function getCountry() } /** + *Name of the company.
+ * * @return null|string */ @@ -316,6 +346,8 @@ public function getCompany() } /** + *Name of the department.
+ * * @return null|string */ @@ -325,6 +357,8 @@ public function getDepartment() } /** + *Number or name of the building.
+ * * @return null|string */ @@ -334,6 +368,8 @@ public function getBuilding() } /** + *Number or name of the apartment.
+ * * @return null|string */ @@ -343,6 +379,8 @@ public function getApartment() } /** + *Post office box number.
+ * * @return null|string */ @@ -352,6 +390,8 @@ public function getPOBox() } /** + *Phone number of the contact.
+ * * @return null|string */ @@ -361,6 +401,8 @@ public function getPhone() } /** + *Mobile phone number of the contact.
+ * * @return null|string */ @@ -370,6 +412,8 @@ public function getMobile() } /** + *Email address of the contact.
+ * * @return null|string */ @@ -379,6 +423,8 @@ public function getEmail() } /** + *Fax number of the contact.
+ * * @return null|string */ @@ -388,6 +434,8 @@ public function getFax() } /** + *Further information on the Address.
+ * * @return null|string */ @@ -397,6 +445,8 @@ public function getAdditionalAddressInfo() } /** + *ID for the contact used in an external system.
+ * * @return null|string */ @@ -406,7 +456,7 @@ public function getExternalId() } /** - *Custom Fields defined for the Address. Custom Fields can only be applied to shippingAddress.
Custom Fields defined for the Address.
* * @return null|Custom diff --git a/lib/commercetools-import/src/Models/Common/AddressModel.php b/lib/commercetools-import/src/Models/Common/AddressModel.php index 29aa905e3de..4bd96efb428 100644 --- a/lib/commercetools-import/src/Models/Common/AddressModel.php +++ b/lib/commercetools-import/src/Models/Common/AddressModel.php @@ -238,6 +238,10 @@ public function __construct( } /** + *Unique identifier of the Address.
+ *It is not recommended to set it manually since the API overwrites this ID when creating an Address for a Customer.
+ * Use key instead and omit this field from the request to let the API generate the ID for the Address.
User-defined identifier of the Address that must be unique when multiple addresses are referenced in BusinessUnits, Customers, and itemShippingAddresses (LineItem-specific addresses) of a Cart, Order, QuoteRequest, or Quote.
Title of the contact, for example 'Dr.'
+ * * * @return null|string */ @@ -292,6 +300,8 @@ public function getTitle() } /** + *Salutation of the contact, for example 'Mr.' or 'Ms.'
+ * * * @return null|string */ @@ -310,6 +320,8 @@ public function getSalutation() } /** + *Given name (first name) of the contact.
+ * * * @return null|string */ @@ -328,6 +340,8 @@ public function getFirstName() } /** + *Family name (last name) of the contact.
+ * * * @return null|string */ @@ -346,6 +360,8 @@ public function getLastName() } /** + *Name of the street.
+ * * * @return null|string */ @@ -364,6 +380,8 @@ public function getStreetName() } /** + *Street number.
+ * * * @return null|string */ @@ -382,6 +400,8 @@ public function getStreetNumber() } /** + *Further information on the street address.
+ * * * @return null|string */ @@ -400,6 +420,8 @@ public function getAdditionalStreetInfo() } /** + *Postal code.
+ * * * @return null|string */ @@ -418,6 +440,8 @@ public function getPostalCode() } /** + *Name of the city.
+ * * * @return null|string */ @@ -436,6 +460,8 @@ public function getCity() } /** + *Name of the region.
+ * * * @return null|string */ @@ -454,6 +480,8 @@ public function getRegion() } /** + *Name of the state, for example, Colorado.
+ * * * @return null|string */ @@ -472,7 +500,7 @@ public function getState() } /** - *A two-digit country code as per ISO 3166-1 alpha-2.
+ *Name of the country.
* * * @return null|string @@ -492,6 +520,8 @@ public function getCountry() } /** + *Name of the company.
+ * * * @return null|string */ @@ -510,6 +540,8 @@ public function getCompany() } /** + *Name of the department.
+ * * * @return null|string */ @@ -528,6 +560,8 @@ public function getDepartment() } /** + *Number or name of the building.
+ * * * @return null|string */ @@ -546,6 +580,8 @@ public function getBuilding() } /** + *Number or name of the apartment.
+ * * * @return null|string */ @@ -564,6 +600,8 @@ public function getApartment() } /** + *Post office box number.
+ * * * @return null|string */ @@ -582,6 +620,8 @@ public function getPOBox() } /** + *Phone number of the contact.
+ * * * @return null|string */ @@ -600,6 +640,8 @@ public function getPhone() } /** + *Mobile phone number of the contact.
+ * * * @return null|string */ @@ -618,6 +660,8 @@ public function getMobile() } /** + *Email address of the contact.
+ * * * @return null|string */ @@ -636,6 +680,8 @@ public function getEmail() } /** + *Fax number of the contact.
+ * * * @return null|string */ @@ -654,6 +700,8 @@ public function getFax() } /** + *Further information on the Address.
+ * * * @return null|string */ @@ -672,6 +720,8 @@ public function getAdditionalAddressInfo() } /** + *ID for the contact used in an external system.
+ * * * @return null|string */ @@ -690,7 +740,7 @@ public function getExternalId() } /** - *Custom Fields defined for the Address. Custom Fields can only be applied to shippingAddress.
Custom Fields defined for the Address.
* * * @return null|Custom diff --git a/lib/commercetools-import/src/Models/Common/Asset.php b/lib/commercetools-import/src/Models/Common/Asset.php index 97ae0a97710..6627bdee90b 100644 --- a/lib/commercetools-import/src/Models/Common/Asset.php +++ b/lib/commercetools-import/src/Models/Common/Asset.php @@ -37,12 +37,7 @@ public function getKey(); public function getSources(); /** - *A localized string is a JSON object where the keys are of IETF language tag, and the values the corresponding strings used for that language.
- *{
- * "de": "Hundefutter",
- * "en": "dog food"
- * }
- *
+ * Name of the Asset.
* * @return null|LocalizedString @@ -50,12 +45,7 @@ public function getSources(); public function getName(); /** - *A localized string is a JSON object where the keys are of IETF language tag, and the values the corresponding strings used for that language.
- *{
- * "de": "Hundefutter",
- * "en": "dog food"
- * }
- *
+ * Description of the Asset.
* * @return null|LocalizedString @@ -63,13 +53,15 @@ public function getName(); public function getDescription(); /** + *Keywords for categorizing and organizing Assets.
+ * * @return null|array */ public function getTags(); /** - *The representation to be sent to the server when creating a resource with custom fields.
+ *Custom Fields defined for the Asset.
* * @return null|Custom diff --git a/lib/commercetools-import/src/Models/Common/AssetBuilder.php b/lib/commercetools-import/src/Models/Common/AssetBuilder.php index e18a2e74c0d..9d02aba519a 100644 --- a/lib/commercetools-import/src/Models/Common/AssetBuilder.php +++ b/lib/commercetools-import/src/Models/Common/AssetBuilder.php @@ -80,12 +80,7 @@ public function getSources() } /** - *A localized string is a JSON object where the keys are of IETF language tag, and the values the corresponding strings used for that language.
- *{
- * "de": "Hundefutter",
- * "en": "dog food"
- * }
- *
+ * Name of the Asset.
* * @return null|LocalizedString @@ -96,12 +91,7 @@ public function getName() } /** - *A localized string is a JSON object where the keys are of IETF language tag, and the values the corresponding strings used for that language.
- *{
- * "de": "Hundefutter",
- * "en": "dog food"
- * }
- *
+ * Description of the Asset.
* * @return null|LocalizedString @@ -112,6 +102,8 @@ public function getDescription() } /** + *Keywords for categorizing and organizing Assets.
+ * * @return null|array */ @@ -121,7 +113,7 @@ public function getTags() } /** - *The representation to be sent to the server when creating a resource with custom fields.
+ *Custom Fields defined for the Asset.
* * @return null|Custom diff --git a/lib/commercetools-import/src/Models/Common/AssetModel.php b/lib/commercetools-import/src/Models/Common/AssetModel.php index 81a3ea0b84f..e9cc7fe2006 100644 --- a/lib/commercetools-import/src/Models/Common/AssetModel.php +++ b/lib/commercetools-import/src/Models/Common/AssetModel.php @@ -117,12 +117,7 @@ public function getSources() } /** - *A localized string is a JSON object where the keys are of IETF language tag, and the values the corresponding strings used for that language.
- *{
- * "de": "Hundefutter",
- * "en": "dog food"
- * }
- *
+ * Name of the Asset.
* * * @return null|LocalizedString @@ -143,12 +138,7 @@ public function getName() } /** - *A localized string is a JSON object where the keys are of IETF language tag, and the values the corresponding strings used for that language.
- *{
- * "de": "Hundefutter",
- * "en": "dog food"
- * }
- *
+ * Description of the Asset.
* * * @return null|LocalizedString @@ -169,6 +159,8 @@ public function getDescription() } /** + *Keywords for categorizing and organizing Assets.
+ * * * @return null|array */ @@ -187,7 +179,7 @@ public function getTags() } /** - *The representation to be sent to the server when creating a resource with custom fields.
+ *Custom Fields defined for the Asset.
* * * @return null|Custom diff --git a/lib/commercetools-import/src/Models/Common/CartDiscountKeyReference.php b/lib/commercetools-import/src/Models/Common/CartDiscountKeyReference.php index 4cded64402e..09282dea445 100644 --- a/lib/commercetools-import/src/Models/Common/CartDiscountKeyReference.php +++ b/lib/commercetools-import/src/Models/Common/CartDiscountKeyReference.php @@ -13,4 +13,16 @@ interface CartDiscountKeyReference extends KeyReference { + /** + *User-defined unique identifier of the referenced CartDiscount.
+ * + + * @return null|string + */ + public function getKey(); + + /** + * @param ?string $key + */ + public function setKey(?string $key): void; } diff --git a/lib/commercetools-import/src/Models/Common/CartDiscountKeyReferenceBuilder.php b/lib/commercetools-import/src/Models/Common/CartDiscountKeyReferenceBuilder.php index 918a93d6c98..a24bfea60ac 100644 --- a/lib/commercetools-import/src/Models/Common/CartDiscountKeyReferenceBuilder.php +++ b/lib/commercetools-import/src/Models/Common/CartDiscountKeyReferenceBuilder.php @@ -27,6 +27,8 @@ final class CartDiscountKeyReferenceBuilder implements Builder private $key; /** + *User-defined unique identifier of the referenced CartDiscount.
+ * * @return null|string */ diff --git a/lib/commercetools-import/src/Models/Common/CartDiscountKeyReferenceModel.php b/lib/commercetools-import/src/Models/Common/CartDiscountKeyReferenceModel.php index cbd237e800f..e4c5a8e9bb5 100644 --- a/lib/commercetools-import/src/Models/Common/CartDiscountKeyReferenceModel.php +++ b/lib/commercetools-import/src/Models/Common/CartDiscountKeyReferenceModel.php @@ -45,6 +45,8 @@ public function __construct( } /** + *User-defined unique identifier of the referenced CartDiscount.
+ * * * @return null|string */ @@ -63,7 +65,7 @@ public function getKey() } /** - *The type of the referenced resource.
+ *Type of referenced resource.
* * * @return null|string diff --git a/lib/commercetools-import/src/Models/Common/CartKeyReference.php b/lib/commercetools-import/src/Models/Common/CartKeyReference.php index cf968a2a3a8..8bd75a33d44 100644 --- a/lib/commercetools-import/src/Models/Common/CartKeyReference.php +++ b/lib/commercetools-import/src/Models/Common/CartKeyReference.php @@ -13,4 +13,16 @@ interface CartKeyReference extends KeyReference { + /** + *User-defined unique identifier of the referenced Cart.
+ * + + * @return null|string + */ + public function getKey(); + + /** + * @param ?string $key + */ + public function setKey(?string $key): void; } diff --git a/lib/commercetools-import/src/Models/Common/CartKeyReferenceBuilder.php b/lib/commercetools-import/src/Models/Common/CartKeyReferenceBuilder.php index 94d1f22ba30..7b341003782 100644 --- a/lib/commercetools-import/src/Models/Common/CartKeyReferenceBuilder.php +++ b/lib/commercetools-import/src/Models/Common/CartKeyReferenceBuilder.php @@ -27,6 +27,8 @@ final class CartKeyReferenceBuilder implements Builder private $key; /** + *User-defined unique identifier of the referenced Cart.
+ * * @return null|string */ diff --git a/lib/commercetools-import/src/Models/Common/CartKeyReferenceModel.php b/lib/commercetools-import/src/Models/Common/CartKeyReferenceModel.php index 5c4e842aec0..794b866c161 100644 --- a/lib/commercetools-import/src/Models/Common/CartKeyReferenceModel.php +++ b/lib/commercetools-import/src/Models/Common/CartKeyReferenceModel.php @@ -45,6 +45,8 @@ public function __construct( } /** + *User-defined unique identifier of the referenced Cart.
+ * * * @return null|string */ @@ -63,7 +65,7 @@ public function getKey() } /** - *The type of the referenced resource.
+ *Type of referenced resource.
* * * @return null|string diff --git a/lib/commercetools-import/src/Models/Common/CategoryKeyReference.php b/lib/commercetools-import/src/Models/Common/CategoryKeyReference.php index 6e27cf7774f..ee616c65632 100644 --- a/lib/commercetools-import/src/Models/Common/CategoryKeyReference.php +++ b/lib/commercetools-import/src/Models/Common/CategoryKeyReference.php @@ -13,4 +13,16 @@ interface CategoryKeyReference extends KeyReference { + /** + *User-defined unique identifier of the referenced Category.
+ * + + * @return null|string + */ + public function getKey(); + + /** + * @param ?string $key + */ + public function setKey(?string $key): void; } diff --git a/lib/commercetools-import/src/Models/Common/CategoryKeyReferenceBuilder.php b/lib/commercetools-import/src/Models/Common/CategoryKeyReferenceBuilder.php index 2bd010863c2..ecc8952ba39 100644 --- a/lib/commercetools-import/src/Models/Common/CategoryKeyReferenceBuilder.php +++ b/lib/commercetools-import/src/Models/Common/CategoryKeyReferenceBuilder.php @@ -27,6 +27,8 @@ final class CategoryKeyReferenceBuilder implements Builder private $key; /** + *User-defined unique identifier of the referenced Category.
+ * * @return null|string */ diff --git a/lib/commercetools-import/src/Models/Common/CategoryKeyReferenceModel.php b/lib/commercetools-import/src/Models/Common/CategoryKeyReferenceModel.php index af21380ac62..625c99ccb65 100644 --- a/lib/commercetools-import/src/Models/Common/CategoryKeyReferenceModel.php +++ b/lib/commercetools-import/src/Models/Common/CategoryKeyReferenceModel.php @@ -45,6 +45,8 @@ public function __construct( } /** + *User-defined unique identifier of the referenced Category.
+ * * * @return null|string */ @@ -63,7 +65,7 @@ public function getKey() } /** - *The type of the referenced resource.
+ *Type of referenced resource.
* * * @return null|string diff --git a/lib/commercetools-import/src/Models/Common/ChannelKeyReference.php b/lib/commercetools-import/src/Models/Common/ChannelKeyReference.php index b2860a1d689..5f6500c2e77 100644 --- a/lib/commercetools-import/src/Models/Common/ChannelKeyReference.php +++ b/lib/commercetools-import/src/Models/Common/ChannelKeyReference.php @@ -13,4 +13,16 @@ interface ChannelKeyReference extends KeyReference { + /** + *User-defined unique identifier of the referenced Channel.
+ * + + * @return null|string + */ + public function getKey(); + + /** + * @param ?string $key + */ + public function setKey(?string $key): void; } diff --git a/lib/commercetools-import/src/Models/Common/ChannelKeyReferenceBuilder.php b/lib/commercetools-import/src/Models/Common/ChannelKeyReferenceBuilder.php index c41a85ad8e1..f49531b197d 100644 --- a/lib/commercetools-import/src/Models/Common/ChannelKeyReferenceBuilder.php +++ b/lib/commercetools-import/src/Models/Common/ChannelKeyReferenceBuilder.php @@ -27,6 +27,8 @@ final class ChannelKeyReferenceBuilder implements Builder private $key; /** + *User-defined unique identifier of the referenced Channel.
+ * * @return null|string */ diff --git a/lib/commercetools-import/src/Models/Common/ChannelKeyReferenceModel.php b/lib/commercetools-import/src/Models/Common/ChannelKeyReferenceModel.php index 9edcade6ac2..4c3f3296d23 100644 --- a/lib/commercetools-import/src/Models/Common/ChannelKeyReferenceModel.php +++ b/lib/commercetools-import/src/Models/Common/ChannelKeyReferenceModel.php @@ -45,6 +45,8 @@ public function __construct( } /** + *User-defined unique identifier of the referenced Channel.
+ * * * @return null|string */ @@ -63,7 +65,7 @@ public function getKey() } /** - *The type of the referenced resource.
+ *Type of referenced resource.
* * * @return null|string diff --git a/lib/commercetools-import/src/Models/Common/CustomObjectKeyReference.php b/lib/commercetools-import/src/Models/Common/CustomObjectKeyReference.php index 5a21a77c2f2..fe2467361b5 100644 --- a/lib/commercetools-import/src/Models/Common/CustomObjectKeyReference.php +++ b/lib/commercetools-import/src/Models/Common/CustomObjectKeyReference.php @@ -16,11 +16,26 @@ interface CustomObjectKeyReference extends KeyReference public const FIELD_CONTAINER = 'container'; /** + *User-defined unique identifier of the referenced CustomObject.
+ * + + * @return null|string + */ + public function getKey(); + + /** + *The container of the referenced CustomObject.
User-defined unique identifier of the referenced CustomObject.
+ * * @return null|string */ @@ -42,6 +44,8 @@ public function getKey() } /** + *The container of the referenced CustomObject.
User-defined unique identifier of the referenced CustomObject.
+ * * * @return null|string */ @@ -71,7 +73,7 @@ public function getKey() } /** - *The type of the referenced resource.
+ *Type of referenced resource.
* * * @return null|string @@ -91,6 +93,8 @@ public function getTypeId() } /** + *The container of the referenced CustomObject.
User-defined unique identifier of the referenced CustomerGroup.
+ * + + * @return null|string + */ + public function getKey(); + + /** + * @param ?string $key + */ + public function setKey(?string $key): void; } diff --git a/lib/commercetools-import/src/Models/Common/CustomerGroupKeyReferenceBuilder.php b/lib/commercetools-import/src/Models/Common/CustomerGroupKeyReferenceBuilder.php index 44b45f031c9..3f1fded396d 100644 --- a/lib/commercetools-import/src/Models/Common/CustomerGroupKeyReferenceBuilder.php +++ b/lib/commercetools-import/src/Models/Common/CustomerGroupKeyReferenceBuilder.php @@ -27,6 +27,8 @@ final class CustomerGroupKeyReferenceBuilder implements Builder private $key; /** + *User-defined unique identifier of the referenced CustomerGroup.
+ * * @return null|string */ diff --git a/lib/commercetools-import/src/Models/Common/CustomerGroupKeyReferenceModel.php b/lib/commercetools-import/src/Models/Common/CustomerGroupKeyReferenceModel.php index bafed1f7190..2d257955732 100644 --- a/lib/commercetools-import/src/Models/Common/CustomerGroupKeyReferenceModel.php +++ b/lib/commercetools-import/src/Models/Common/CustomerGroupKeyReferenceModel.php @@ -45,6 +45,8 @@ public function __construct( } /** + *User-defined unique identifier of the referenced CustomerGroup.
+ * * * @return null|string */ @@ -63,7 +65,7 @@ public function getKey() } /** - *The type of the referenced resource.
+ *Type of referenced resource.
* * * @return null|string diff --git a/lib/commercetools-import/src/Models/Common/CustomerKeyReference.php b/lib/commercetools-import/src/Models/Common/CustomerKeyReference.php index 5b5b6031bea..c800d0060ec 100644 --- a/lib/commercetools-import/src/Models/Common/CustomerKeyReference.php +++ b/lib/commercetools-import/src/Models/Common/CustomerKeyReference.php @@ -13,4 +13,16 @@ interface CustomerKeyReference extends KeyReference { + /** + *User-defined unique identifier of the referenced Customer.
+ * + + * @return null|string + */ + public function getKey(); + + /** + * @param ?string $key + */ + public function setKey(?string $key): void; } diff --git a/lib/commercetools-import/src/Models/Common/CustomerKeyReferenceBuilder.php b/lib/commercetools-import/src/Models/Common/CustomerKeyReferenceBuilder.php index cdeb83acaa4..203b7983572 100644 --- a/lib/commercetools-import/src/Models/Common/CustomerKeyReferenceBuilder.php +++ b/lib/commercetools-import/src/Models/Common/CustomerKeyReferenceBuilder.php @@ -27,6 +27,8 @@ final class CustomerKeyReferenceBuilder implements Builder private $key; /** + *User-defined unique identifier of the referenced Customer.
+ * * @return null|string */ diff --git a/lib/commercetools-import/src/Models/Common/CustomerKeyReferenceModel.php b/lib/commercetools-import/src/Models/Common/CustomerKeyReferenceModel.php index 314ea033fab..9006bbcec46 100644 --- a/lib/commercetools-import/src/Models/Common/CustomerKeyReferenceModel.php +++ b/lib/commercetools-import/src/Models/Common/CustomerKeyReferenceModel.php @@ -45,6 +45,8 @@ public function __construct( } /** + *User-defined unique identifier of the referenced Customer.
+ * * * @return null|string */ @@ -63,7 +65,7 @@ public function getKey() } /** - *The type of the referenced resource.
+ *Type of referenced resource.
* * * @return null|string diff --git a/lib/commercetools-import/src/Models/Common/DiscountCodeKeyReference.php b/lib/commercetools-import/src/Models/Common/DiscountCodeKeyReference.php index 61958cb3e06..fe1e9a8b7a4 100644 --- a/lib/commercetools-import/src/Models/Common/DiscountCodeKeyReference.php +++ b/lib/commercetools-import/src/Models/Common/DiscountCodeKeyReference.php @@ -13,4 +13,16 @@ interface DiscountCodeKeyReference extends KeyReference { + /** + *User-defined unique identifier of the referenced DiscountCode.
+ * + + * @return null|string + */ + public function getKey(); + + /** + * @param ?string $key + */ + public function setKey(?string $key): void; } diff --git a/lib/commercetools-import/src/Models/Common/DiscountCodeKeyReferenceBuilder.php b/lib/commercetools-import/src/Models/Common/DiscountCodeKeyReferenceBuilder.php index ebfe8db8b58..3f14fe702af 100644 --- a/lib/commercetools-import/src/Models/Common/DiscountCodeKeyReferenceBuilder.php +++ b/lib/commercetools-import/src/Models/Common/DiscountCodeKeyReferenceBuilder.php @@ -27,6 +27,8 @@ final class DiscountCodeKeyReferenceBuilder implements Builder private $key; /** + *User-defined unique identifier of the referenced DiscountCode.
+ * * @return null|string */ diff --git a/lib/commercetools-import/src/Models/Common/DiscountCodeKeyReferenceModel.php b/lib/commercetools-import/src/Models/Common/DiscountCodeKeyReferenceModel.php index 4fff35b47cc..805f847f8d1 100644 --- a/lib/commercetools-import/src/Models/Common/DiscountCodeKeyReferenceModel.php +++ b/lib/commercetools-import/src/Models/Common/DiscountCodeKeyReferenceModel.php @@ -45,6 +45,8 @@ public function __construct( } /** + *User-defined unique identifier of the referenced DiscountCode.
+ * * * @return null|string */ @@ -63,7 +65,7 @@ public function getKey() } /** - *The type of the referenced resource.
+ *Type of referenced resource.
* * * @return null|string diff --git a/lib/commercetools-import/src/Models/Common/DiscountedPrice.php b/lib/commercetools-import/src/Models/Common/DiscountedPrice.php index 9d22f66c821..85963b102fa 100644 --- a/lib/commercetools-import/src/Models/Common/DiscountedPrice.php +++ b/lib/commercetools-import/src/Models/Common/DiscountedPrice.php @@ -25,7 +25,7 @@ interface DiscountedPrice extends JsonObject public function getValue(); /** - *Reference to a ProductDiscount.
+ *Reference to a ProductDiscount. If the referenced ProductDiscount does not exist, the state of the ImportOperation will be set to unresolved until the referenced ProductDiscount is created.
Reference to a ProductDiscount.
+ *Reference to a ProductDiscount. If the referenced ProductDiscount does not exist, the state of the ImportOperation will be set to unresolved until the referenced ProductDiscount is created.
Reference to a ProductDiscount.
+ *Reference to a ProductDiscount. If the referenced ProductDiscount does not exist, the state of the ImportOperation will be set to unresolved until the referenced ProductDiscount is created.
The number of fraction digits of the money value.
+ * This is used to determine how many digits are after the decimal point.
+ * For example, for EUR and USD, this is 2, and for JPY, this is 0.
Amount in the smallest indivisible unit of a currency, such as:
+ *500).5).The type of money. The centPrecision type is used for currencies with minor units, such as EUR and USD. The highPrecision type is used for currencies without minor units, such as JPY.
The number of fraction digits of the money value.
+ * This is used to determine how many digits are after the decimal point.
+ * For example, for EUR and USD, this is 2, and for JPY, this is 0.
Amount in the smallest indivisible unit of a currency, such as:
+ *500).5).User-defined unique identifier of the referenced resource.
+ * If the referenced resource does not exist, the state of the ImportOperation will be set to unresolved until the referenced resource is created.
The type of the referenced resource.
+ *Type of referenced resource.
* * @return null|string diff --git a/lib/commercetools-import/src/Models/Common/KeyReferenceBuilder.php b/lib/commercetools-import/src/Models/Common/KeyReferenceBuilder.php index 369a8fdeef4..b795aa23b08 100644 --- a/lib/commercetools-import/src/Models/Common/KeyReferenceBuilder.php +++ b/lib/commercetools-import/src/Models/Common/KeyReferenceBuilder.php @@ -27,6 +27,9 @@ final class KeyReferenceBuilder implements Builder private $key; /** + *User-defined unique identifier of the referenced resource.
+ * If the referenced resource does not exist, the state of the ImportOperation will be set to unresolved until the referenced resource is created.
User-defined unique identifier of the referenced resource.
+ * If the referenced resource does not exist, the state of the ImportOperation will be set to unresolved until the referenced resource is created.
The type of the referenced resource.
+ *Type of referenced resource.
* * * @return null|string diff --git a/lib/commercetools-import/src/Models/Common/MoneyBuilder.php b/lib/commercetools-import/src/Models/Common/MoneyBuilder.php index 95c72e0c895..55fbf7b8e80 100644 --- a/lib/commercetools-import/src/Models/Common/MoneyBuilder.php +++ b/lib/commercetools-import/src/Models/Common/MoneyBuilder.php @@ -39,6 +39,10 @@ final class MoneyBuilder implements Builder private $currencyCode; /** + *The number of fraction digits of the money value.
+ * This is used to determine how many digits are after the decimal point.
+ * For example, for EUR and USD, this is 2, and for JPY, this is 0.
Amount in the smallest indivisible unit of a currency, such as:
+ *500).5).The type of money. The centPrecision type is used for currencies with minor units, such as EUR and USD. The highPrecision type is used for currencies without minor units, such as JPY.
The number of fraction digits of the money value.
+ * This is used to determine how many digits are after the decimal point.
+ * For example, for EUR and USD, this is 2, and for JPY, this is 0.
Amount in the smallest indivisible unit of a currency, such as:
+ *500).5).User-defined unique identifier of the referenced resource.
+ * If the referenced resource does not exist, the state of the ImportOperation will be set to unresolved until the referenced resource is created.
User-defined unique identifier of the referenced resource.
+ * If the referenced resource does not exist, the state of the ImportOperation will be set to unresolved until the referenced resource is created.
The type of the referenced resource.
+ *Type of referenced resource.
* * * @return null|string diff --git a/lib/commercetools-import/src/Models/Common/PaymentKeyReference.php b/lib/commercetools-import/src/Models/Common/PaymentKeyReference.php index bd18d465b92..90e0440da1d 100644 --- a/lib/commercetools-import/src/Models/Common/PaymentKeyReference.php +++ b/lib/commercetools-import/src/Models/Common/PaymentKeyReference.php @@ -13,4 +13,16 @@ interface PaymentKeyReference extends KeyReference { + /** + *User-defined unique identifier of the referenced Payment.
+ * + + * @return null|string + */ + public function getKey(); + + /** + * @param ?string $key + */ + public function setKey(?string $key): void; } diff --git a/lib/commercetools-import/src/Models/Common/PaymentKeyReferenceBuilder.php b/lib/commercetools-import/src/Models/Common/PaymentKeyReferenceBuilder.php index 5924c4b0028..b9279dae82d 100644 --- a/lib/commercetools-import/src/Models/Common/PaymentKeyReferenceBuilder.php +++ b/lib/commercetools-import/src/Models/Common/PaymentKeyReferenceBuilder.php @@ -27,6 +27,8 @@ final class PaymentKeyReferenceBuilder implements Builder private $key; /** + *User-defined unique identifier of the referenced Payment.
+ * * @return null|string */ diff --git a/lib/commercetools-import/src/Models/Common/PaymentKeyReferenceModel.php b/lib/commercetools-import/src/Models/Common/PaymentKeyReferenceModel.php index e7f17e84dbf..47e808e7254 100644 --- a/lib/commercetools-import/src/Models/Common/PaymentKeyReferenceModel.php +++ b/lib/commercetools-import/src/Models/Common/PaymentKeyReferenceModel.php @@ -45,6 +45,8 @@ public function __construct( } /** + *User-defined unique identifier of the referenced Payment.
+ * * * @return null|string */ @@ -63,7 +65,7 @@ public function getKey() } /** - *The type of the referenced resource.
+ *Type of referenced resource.
* * * @return null|string diff --git a/lib/commercetools-import/src/Models/Common/PriceKeyReference.php b/lib/commercetools-import/src/Models/Common/PriceKeyReference.php index d8df9fe58d6..07bc75e5525 100644 --- a/lib/commercetools-import/src/Models/Common/PriceKeyReference.php +++ b/lib/commercetools-import/src/Models/Common/PriceKeyReference.php @@ -13,4 +13,16 @@ interface PriceKeyReference extends KeyReference { + /** + *User-defined unique identifier of the referenced Embedded Price.
+ * + + * @return null|string + */ + public function getKey(); + + /** + * @param ?string $key + */ + public function setKey(?string $key): void; } diff --git a/lib/commercetools-import/src/Models/Common/PriceKeyReferenceBuilder.php b/lib/commercetools-import/src/Models/Common/PriceKeyReferenceBuilder.php index ff3f9b68ed2..58cc03a8056 100644 --- a/lib/commercetools-import/src/Models/Common/PriceKeyReferenceBuilder.php +++ b/lib/commercetools-import/src/Models/Common/PriceKeyReferenceBuilder.php @@ -27,6 +27,8 @@ final class PriceKeyReferenceBuilder implements Builder private $key; /** + *User-defined unique identifier of the referenced Embedded Price.
+ * * @return null|string */ diff --git a/lib/commercetools-import/src/Models/Common/PriceKeyReferenceModel.php b/lib/commercetools-import/src/Models/Common/PriceKeyReferenceModel.php index 35f77ee8d67..7d28776705a 100644 --- a/lib/commercetools-import/src/Models/Common/PriceKeyReferenceModel.php +++ b/lib/commercetools-import/src/Models/Common/PriceKeyReferenceModel.php @@ -45,6 +45,8 @@ public function __construct( } /** + *User-defined unique identifier of the referenced Embedded Price.
+ * * * @return null|string */ @@ -63,7 +65,7 @@ public function getKey() } /** - *The type of the referenced resource.
+ *Type of referenced resource.
* * * @return null|string diff --git a/lib/commercetools-import/src/Models/Common/ProductDiscountKeyReference.php b/lib/commercetools-import/src/Models/Common/ProductDiscountKeyReference.php index 4727d1b15d6..b75c7338480 100644 --- a/lib/commercetools-import/src/Models/Common/ProductDiscountKeyReference.php +++ b/lib/commercetools-import/src/Models/Common/ProductDiscountKeyReference.php @@ -13,4 +13,16 @@ interface ProductDiscountKeyReference extends KeyReference { + /** + *User-defined unique identifier of the referenced ProductDiscount.
+ * + + * @return null|string + */ + public function getKey(); + + /** + * @param ?string $key + */ + public function setKey(?string $key): void; } diff --git a/lib/commercetools-import/src/Models/Common/ProductDiscountKeyReferenceBuilder.php b/lib/commercetools-import/src/Models/Common/ProductDiscountKeyReferenceBuilder.php index 9b1799670e5..476515505c2 100644 --- a/lib/commercetools-import/src/Models/Common/ProductDiscountKeyReferenceBuilder.php +++ b/lib/commercetools-import/src/Models/Common/ProductDiscountKeyReferenceBuilder.php @@ -27,6 +27,8 @@ final class ProductDiscountKeyReferenceBuilder implements Builder private $key; /** + *User-defined unique identifier of the referenced ProductDiscount.
+ * * @return null|string */ diff --git a/lib/commercetools-import/src/Models/Common/ProductDiscountKeyReferenceModel.php b/lib/commercetools-import/src/Models/Common/ProductDiscountKeyReferenceModel.php index 827df92855b..7631ad6a03b 100644 --- a/lib/commercetools-import/src/Models/Common/ProductDiscountKeyReferenceModel.php +++ b/lib/commercetools-import/src/Models/Common/ProductDiscountKeyReferenceModel.php @@ -45,6 +45,8 @@ public function __construct( } /** + *User-defined unique identifier of the referenced ProductDiscount.
+ * * * @return null|string */ @@ -63,7 +65,7 @@ public function getKey() } /** - *The type of the referenced resource.
+ *Type of referenced resource.
* * * @return null|string diff --git a/lib/commercetools-import/src/Models/Common/ProductKeyReference.php b/lib/commercetools-import/src/Models/Common/ProductKeyReference.php index 5fbf9cd0133..50596392efa 100644 --- a/lib/commercetools-import/src/Models/Common/ProductKeyReference.php +++ b/lib/commercetools-import/src/Models/Common/ProductKeyReference.php @@ -13,4 +13,16 @@ interface ProductKeyReference extends KeyReference { + /** + *User-defined unique identifier of the referenced Product.
+ * + + * @return null|string + */ + public function getKey(); + + /** + * @param ?string $key + */ + public function setKey(?string $key): void; } diff --git a/lib/commercetools-import/src/Models/Common/ProductKeyReferenceBuilder.php b/lib/commercetools-import/src/Models/Common/ProductKeyReferenceBuilder.php index 24c9e7ba0c6..3635384dd86 100644 --- a/lib/commercetools-import/src/Models/Common/ProductKeyReferenceBuilder.php +++ b/lib/commercetools-import/src/Models/Common/ProductKeyReferenceBuilder.php @@ -27,6 +27,8 @@ final class ProductKeyReferenceBuilder implements Builder private $key; /** + *User-defined unique identifier of the referenced Product.
+ * * @return null|string */ diff --git a/lib/commercetools-import/src/Models/Common/ProductKeyReferenceModel.php b/lib/commercetools-import/src/Models/Common/ProductKeyReferenceModel.php index 86d55ae21b3..c3e1c355aae 100644 --- a/lib/commercetools-import/src/Models/Common/ProductKeyReferenceModel.php +++ b/lib/commercetools-import/src/Models/Common/ProductKeyReferenceModel.php @@ -45,6 +45,8 @@ public function __construct( } /** + *User-defined unique identifier of the referenced Product.
+ * * * @return null|string */ @@ -63,7 +65,7 @@ public function getKey() } /** - *The type of the referenced resource.
+ *Type of referenced resource.
* * * @return null|string diff --git a/lib/commercetools-import/src/Models/Common/ProductTypeKeyReference.php b/lib/commercetools-import/src/Models/Common/ProductTypeKeyReference.php index a2e3fd826de..eb13e136f4e 100644 --- a/lib/commercetools-import/src/Models/Common/ProductTypeKeyReference.php +++ b/lib/commercetools-import/src/Models/Common/ProductTypeKeyReference.php @@ -13,4 +13,16 @@ interface ProductTypeKeyReference extends KeyReference { + /** + *User-defined unique identifier of the referenced ProductType.
+ * + + * @return null|string + */ + public function getKey(); + + /** + * @param ?string $key + */ + public function setKey(?string $key): void; } diff --git a/lib/commercetools-import/src/Models/Common/ProductTypeKeyReferenceBuilder.php b/lib/commercetools-import/src/Models/Common/ProductTypeKeyReferenceBuilder.php index 10022feb84b..fb616bdd462 100644 --- a/lib/commercetools-import/src/Models/Common/ProductTypeKeyReferenceBuilder.php +++ b/lib/commercetools-import/src/Models/Common/ProductTypeKeyReferenceBuilder.php @@ -27,6 +27,8 @@ final class ProductTypeKeyReferenceBuilder implements Builder private $key; /** + *User-defined unique identifier of the referenced ProductType.
+ * * @return null|string */ diff --git a/lib/commercetools-import/src/Models/Common/ProductTypeKeyReferenceModel.php b/lib/commercetools-import/src/Models/Common/ProductTypeKeyReferenceModel.php index 8b1a40202b7..6bb59c6e62b 100644 --- a/lib/commercetools-import/src/Models/Common/ProductTypeKeyReferenceModel.php +++ b/lib/commercetools-import/src/Models/Common/ProductTypeKeyReferenceModel.php @@ -45,6 +45,8 @@ public function __construct( } /** + *User-defined unique identifier of the referenced ProductType.
+ * * * @return null|string */ @@ -63,7 +65,7 @@ public function getKey() } /** - *The type of the referenced resource.
+ *Type of referenced resource.
* * * @return null|string diff --git a/lib/commercetools-import/src/Models/Common/ProductVariantKeyReference.php b/lib/commercetools-import/src/Models/Common/ProductVariantKeyReference.php index 410f8838d13..fc58e9c4471 100644 --- a/lib/commercetools-import/src/Models/Common/ProductVariantKeyReference.php +++ b/lib/commercetools-import/src/Models/Common/ProductVariantKeyReference.php @@ -13,4 +13,16 @@ interface ProductVariantKeyReference extends KeyReference { + /** + *User-defined unique identifier of the referenced ProductVariant.
+ * + + * @return null|string + */ + public function getKey(); + + /** + * @param ?string $key + */ + public function setKey(?string $key): void; } diff --git a/lib/commercetools-import/src/Models/Common/ProductVariantKeyReferenceBuilder.php b/lib/commercetools-import/src/Models/Common/ProductVariantKeyReferenceBuilder.php index 1e647cb3e83..f691e93b2af 100644 --- a/lib/commercetools-import/src/Models/Common/ProductVariantKeyReferenceBuilder.php +++ b/lib/commercetools-import/src/Models/Common/ProductVariantKeyReferenceBuilder.php @@ -27,6 +27,8 @@ final class ProductVariantKeyReferenceBuilder implements Builder private $key; /** + *User-defined unique identifier of the referenced ProductVariant.
+ * * @return null|string */ diff --git a/lib/commercetools-import/src/Models/Common/ProductVariantKeyReferenceModel.php b/lib/commercetools-import/src/Models/Common/ProductVariantKeyReferenceModel.php index 599e8474730..d8e97a44182 100644 --- a/lib/commercetools-import/src/Models/Common/ProductVariantKeyReferenceModel.php +++ b/lib/commercetools-import/src/Models/Common/ProductVariantKeyReferenceModel.php @@ -45,6 +45,8 @@ public function __construct( } /** + *User-defined unique identifier of the referenced ProductVariant.
+ * * * @return null|string */ @@ -63,7 +65,7 @@ public function getKey() } /** - *The type of the referenced resource.
+ *Type of referenced resource.
* * * @return null|string diff --git a/lib/commercetools-import/src/Models/Common/ShippingMethodKeyReference.php b/lib/commercetools-import/src/Models/Common/ShippingMethodKeyReference.php index 8041d3034a5..619691e091b 100644 --- a/lib/commercetools-import/src/Models/Common/ShippingMethodKeyReference.php +++ b/lib/commercetools-import/src/Models/Common/ShippingMethodKeyReference.php @@ -13,4 +13,16 @@ interface ShippingMethodKeyReference extends KeyReference { + /** + *User-defined unique identifier of the referenced ShippingMethod.
+ * + + * @return null|string + */ + public function getKey(); + + /** + * @param ?string $key + */ + public function setKey(?string $key): void; } diff --git a/lib/commercetools-import/src/Models/Common/ShippingMethodKeyReferenceBuilder.php b/lib/commercetools-import/src/Models/Common/ShippingMethodKeyReferenceBuilder.php index ea31540aeeb..92926e4f697 100644 --- a/lib/commercetools-import/src/Models/Common/ShippingMethodKeyReferenceBuilder.php +++ b/lib/commercetools-import/src/Models/Common/ShippingMethodKeyReferenceBuilder.php @@ -27,6 +27,8 @@ final class ShippingMethodKeyReferenceBuilder implements Builder private $key; /** + *User-defined unique identifier of the referenced ShippingMethod.
+ * * @return null|string */ diff --git a/lib/commercetools-import/src/Models/Common/ShippingMethodKeyReferenceModel.php b/lib/commercetools-import/src/Models/Common/ShippingMethodKeyReferenceModel.php index 325e1b5ac09..a9bc71e3ff0 100644 --- a/lib/commercetools-import/src/Models/Common/ShippingMethodKeyReferenceModel.php +++ b/lib/commercetools-import/src/Models/Common/ShippingMethodKeyReferenceModel.php @@ -45,6 +45,8 @@ public function __construct( } /** + *User-defined unique identifier of the referenced ShippingMethod.
+ * * * @return null|string */ @@ -63,7 +65,7 @@ public function getKey() } /** - *The type of the referenced resource.
+ *Type of referenced resource.
* * * @return null|string diff --git a/lib/commercetools-import/src/Models/Common/StateKeyReference.php b/lib/commercetools-import/src/Models/Common/StateKeyReference.php index 52aa4495980..69713ebc56f 100644 --- a/lib/commercetools-import/src/Models/Common/StateKeyReference.php +++ b/lib/commercetools-import/src/Models/Common/StateKeyReference.php @@ -13,4 +13,16 @@ interface StateKeyReference extends KeyReference { + /** + *User-defined unique identifier of the referenced State.
+ * + + * @return null|string + */ + public function getKey(); + + /** + * @param ?string $key + */ + public function setKey(?string $key): void; } diff --git a/lib/commercetools-import/src/Models/Common/StateKeyReferenceBuilder.php b/lib/commercetools-import/src/Models/Common/StateKeyReferenceBuilder.php index 14ddd94f336..e4ca286e5e2 100644 --- a/lib/commercetools-import/src/Models/Common/StateKeyReferenceBuilder.php +++ b/lib/commercetools-import/src/Models/Common/StateKeyReferenceBuilder.php @@ -27,6 +27,8 @@ final class StateKeyReferenceBuilder implements Builder private $key; /** + *User-defined unique identifier of the referenced State.
+ * * @return null|string */ diff --git a/lib/commercetools-import/src/Models/Common/StateKeyReferenceModel.php b/lib/commercetools-import/src/Models/Common/StateKeyReferenceModel.php index d7ebdb4c810..8444ac0b450 100644 --- a/lib/commercetools-import/src/Models/Common/StateKeyReferenceModel.php +++ b/lib/commercetools-import/src/Models/Common/StateKeyReferenceModel.php @@ -45,6 +45,8 @@ public function __construct( } /** + *User-defined unique identifier of the referenced State.
+ * * * @return null|string */ @@ -63,7 +65,7 @@ public function getKey() } /** - *The type of the referenced resource.
+ *Type of referenced resource.
* * * @return null|string diff --git a/lib/commercetools-import/src/Models/Common/StoreKeyReference.php b/lib/commercetools-import/src/Models/Common/StoreKeyReference.php index 6f10c252cd8..857acb45016 100644 --- a/lib/commercetools-import/src/Models/Common/StoreKeyReference.php +++ b/lib/commercetools-import/src/Models/Common/StoreKeyReference.php @@ -13,4 +13,16 @@ interface StoreKeyReference extends KeyReference { + /** + *User-defined unique identifier of the referenced Store.
+ * + + * @return null|string + */ + public function getKey(); + + /** + * @param ?string $key + */ + public function setKey(?string $key): void; } diff --git a/lib/commercetools-import/src/Models/Common/StoreKeyReferenceBuilder.php b/lib/commercetools-import/src/Models/Common/StoreKeyReferenceBuilder.php index 22432c936fa..97e9c2dd63f 100644 --- a/lib/commercetools-import/src/Models/Common/StoreKeyReferenceBuilder.php +++ b/lib/commercetools-import/src/Models/Common/StoreKeyReferenceBuilder.php @@ -27,6 +27,8 @@ final class StoreKeyReferenceBuilder implements Builder private $key; /** + *User-defined unique identifier of the referenced Store.
+ * * @return null|string */ diff --git a/lib/commercetools-import/src/Models/Common/StoreKeyReferenceModel.php b/lib/commercetools-import/src/Models/Common/StoreKeyReferenceModel.php index c2b6221b7bb..3f2579f1980 100644 --- a/lib/commercetools-import/src/Models/Common/StoreKeyReferenceModel.php +++ b/lib/commercetools-import/src/Models/Common/StoreKeyReferenceModel.php @@ -45,6 +45,8 @@ public function __construct( } /** + *User-defined unique identifier of the referenced Store.
+ * * * @return null|string */ @@ -63,7 +65,7 @@ public function getKey() } /** - *The type of the referenced resource.
+ *Type of referenced resource.
* * * @return null|string diff --git a/lib/commercetools-import/src/Models/Common/TaxCategoryKeyReference.php b/lib/commercetools-import/src/Models/Common/TaxCategoryKeyReference.php index f6c64af338d..e3c996bcc66 100644 --- a/lib/commercetools-import/src/Models/Common/TaxCategoryKeyReference.php +++ b/lib/commercetools-import/src/Models/Common/TaxCategoryKeyReference.php @@ -13,4 +13,16 @@ interface TaxCategoryKeyReference extends KeyReference { + /** + *User-defined unique identifier of the referenced TaxCategory.
+ * + + * @return null|string + */ + public function getKey(); + + /** + * @param ?string $key + */ + public function setKey(?string $key): void; } diff --git a/lib/commercetools-import/src/Models/Common/TaxCategoryKeyReferenceBuilder.php b/lib/commercetools-import/src/Models/Common/TaxCategoryKeyReferenceBuilder.php index 8fe20240ef1..7c30b237b82 100644 --- a/lib/commercetools-import/src/Models/Common/TaxCategoryKeyReferenceBuilder.php +++ b/lib/commercetools-import/src/Models/Common/TaxCategoryKeyReferenceBuilder.php @@ -27,6 +27,8 @@ final class TaxCategoryKeyReferenceBuilder implements Builder private $key; /** + *User-defined unique identifier of the referenced TaxCategory.
+ * * @return null|string */ diff --git a/lib/commercetools-import/src/Models/Common/TaxCategoryKeyReferenceModel.php b/lib/commercetools-import/src/Models/Common/TaxCategoryKeyReferenceModel.php index 9fcd090eccd..d0ea0a1c86f 100644 --- a/lib/commercetools-import/src/Models/Common/TaxCategoryKeyReferenceModel.php +++ b/lib/commercetools-import/src/Models/Common/TaxCategoryKeyReferenceModel.php @@ -45,6 +45,8 @@ public function __construct( } /** + *User-defined unique identifier of the referenced TaxCategory.
+ * * * @return null|string */ @@ -63,7 +65,7 @@ public function getKey() } /** - *The type of the referenced resource.
+ *Type of referenced resource.
* * * @return null|string diff --git a/lib/commercetools-import/src/Models/Common/TypeKeyReference.php b/lib/commercetools-import/src/Models/Common/TypeKeyReference.php index bc72623a82c..f284cac7267 100644 --- a/lib/commercetools-import/src/Models/Common/TypeKeyReference.php +++ b/lib/commercetools-import/src/Models/Common/TypeKeyReference.php @@ -13,4 +13,16 @@ interface TypeKeyReference extends KeyReference { + /** + *User-defined unique identifier of the referenced Type.
+ * + + * @return null|string + */ + public function getKey(); + + /** + * @param ?string $key + */ + public function setKey(?string $key): void; } diff --git a/lib/commercetools-import/src/Models/Common/TypeKeyReferenceBuilder.php b/lib/commercetools-import/src/Models/Common/TypeKeyReferenceBuilder.php index c19189e8756..2230982621a 100644 --- a/lib/commercetools-import/src/Models/Common/TypeKeyReferenceBuilder.php +++ b/lib/commercetools-import/src/Models/Common/TypeKeyReferenceBuilder.php @@ -27,6 +27,8 @@ final class TypeKeyReferenceBuilder implements Builder private $key; /** + *User-defined unique identifier of the referenced Type.
+ * * @return null|string */ diff --git a/lib/commercetools-import/src/Models/Common/TypeKeyReferenceModel.php b/lib/commercetools-import/src/Models/Common/TypeKeyReferenceModel.php index f80bc8aa6d4..e6db0777a0c 100644 --- a/lib/commercetools-import/src/Models/Common/TypeKeyReferenceModel.php +++ b/lib/commercetools-import/src/Models/Common/TypeKeyReferenceModel.php @@ -45,6 +45,8 @@ public function __construct( } /** + *User-defined unique identifier of the referenced Type.
+ * * * @return null|string */ @@ -63,7 +65,7 @@ public function getKey() } /** - *The type of the referenced resource.
+ *Type of referenced resource.
* * * @return null|string diff --git a/lib/commercetools-import/src/Models/Common/TypedMoney.php b/lib/commercetools-import/src/Models/Common/TypedMoney.php index 5780c416f13..8695a35c3f8 100644 --- a/lib/commercetools-import/src/Models/Common/TypedMoney.php +++ b/lib/commercetools-import/src/Models/Common/TypedMoney.php @@ -20,18 +20,30 @@ interface TypedMoney extends JsonObject public const FIELD_CURRENCY_CODE = 'currencyCode'; /** + *The type of money. The centPrecision type is used for currencies with minor units, such as EUR and USD. The highPrecision type is used for currencies without minor units, such as JPY.
The number of fraction digits of the money value.
+ * This is used to determine how many digits are after the decimal point.
+ * For example, for EUR and USD, this is 2, and for JPY, this is 0.
Amount in the smallest indivisible unit of a currency, such as:
+ *500).5).The number of fraction digits of the money value.
+ * This is used to determine how many digits are after the decimal point.
+ * For example, for EUR and USD, this is 2, and for JPY, this is 0.
Amount in the smallest indivisible unit of a currency, such as:
+ *500).5).The type of money. The centPrecision type is used for currencies with minor units, such as EUR and USD. The highPrecision type is used for currencies without minor units, such as JPY.
The number of fraction digits of the money value.
+ * This is used to determine how many digits are after the decimal point.
+ * For example, for EUR and USD, this is 2, and for JPY, this is 0.
Amount in the smallest indivisible unit of a currency, such as:
+ *500).5).The key of the resource.
key of the unresolved resource.
The type of resource.
+ *Type of the unresolved resource.
* * @return null|string diff --git a/lib/commercetools-import/src/Models/Common/UnresolvedReferencesBuilder.php b/lib/commercetools-import/src/Models/Common/UnresolvedReferencesBuilder.php index 1a85a765d70..74553799d35 100644 --- a/lib/commercetools-import/src/Models/Common/UnresolvedReferencesBuilder.php +++ b/lib/commercetools-import/src/Models/Common/UnresolvedReferencesBuilder.php @@ -33,7 +33,7 @@ final class UnresolvedReferencesBuilder implements Builder private $typeId; /** - *The key of the resource.
key of the unresolved resource.
The type of resource.
+ *Type of the unresolved resource.
* * @return null|string diff --git a/lib/commercetools-import/src/Models/Common/UnresolvedReferencesModel.php b/lib/commercetools-import/src/Models/Common/UnresolvedReferencesModel.php index af7985509bd..4e5a74fa4f9 100644 --- a/lib/commercetools-import/src/Models/Common/UnresolvedReferencesModel.php +++ b/lib/commercetools-import/src/Models/Common/UnresolvedReferencesModel.php @@ -44,7 +44,7 @@ public function __construct( } /** - *The key of the resource.
key of the unresolved resource.
The type of resource.
+ *Type of the unresolved resource.
* * * @return null|string diff --git a/lib/commercetools-import/src/Models/Customers/CustomerAddress.php b/lib/commercetools-import/src/Models/Customers/CustomerAddress.php index d849f55e836..2fb0d1edcfd 100644 --- a/lib/commercetools-import/src/Models/Customers/CustomerAddress.php +++ b/lib/commercetools-import/src/Models/Customers/CustomerAddress.php @@ -42,7 +42,7 @@ interface CustomerAddress extends JsonObject /** *User-defined identifier for the address.
- * Must follow the pattern [a-zA-Z0-9_-]{2,256} and must be unique per customer.
User-defined identifier for the address.
- * Must follow the pattern [a-zA-Z0-9_-]{2,256} and must be unique per customer.
User-defined identifier for the address.
- * Must follow the pattern [a-zA-Z0-9_-]{2,256} and must be unique per customer.
User-defined unique identifier. If a Customer with this key exists, it will be updated with the imported data.
User-defined unique identifier. If a Customer with this key exists, it is updated with the imported data.
Required when authenticationMode is set to Password. Maps to Customer.password.
Maps to Customer.password. Required when authenticationMode is set to Password.
The References to the Stores with which the Customer is associated. If referenced Stores do not exist, the state of the ImportOperation will be set to unresolved until the necessary Stores are created.
Maps to Customer.stores. If the referenced Stores do not exist, the state of the ImportOperation will be set to unresolved until the referenced Stores are created.
The Reference to the CustomerGroup with which the Customer is associated.
- * If referenced CustomerGroup does not exist, the state of the ImportOperation will be set to unresolved until the necessary CustomerGroup is created.
Maps to Customer.customerGroup. If the referenced CustomerGroup does not exist, the state of the ImportOperation will be set to unresolved until the referenced CustomerGroup is created.
The index of the address in the addresses array. The defaultBillingAddressId of the customer will be set to the ID of that address.
Index of the address in the addresses array to use as the default billing address. The defaultBillingAddressId of the Customer will be set to the id of that address.
The indices of the billing addresses in the addresses array. The billingAddressIds of the customer will be set to the IDs of that addresses.
Indices of the billing addresses in the addresses array. The billingAddressIds of the Customer will be set to the id of these addresses.
The index of the address in the addresses array. The defaultShippingAddressId of the customer will be set to the ID of that address.
The index of the address in the addresses array. The defaultShippingAddressId of the Customer will be set to the id of that address.
The indices of the shipping addresses in the addresses array. The shippingAddressIds of the customer will be set to the IDs of that addresses.
Indices of the shipping addresses in the addresses array. The shippingAddressIds of the Customer will be set to the id of these addresses.
The Custom Fields for this Customer.
+ *Maps to Customer.custom.
User-defined unique identifier. If a Customer with this key exists, it will be updated with the imported data.
User-defined unique identifier. If a Customer with this key exists, it is updated with the imported data.
Required when authenticationMode is set to Password. Maps to Customer.password.
Maps to Customer.password. Required when authenticationMode is set to Password.
The References to the Stores with which the Customer is associated. If referenced Stores do not exist, the state of the ImportOperation will be set to unresolved until the necessary Stores are created.
Maps to Customer.stores. If the referenced Stores do not exist, the state of the ImportOperation will be set to unresolved until the referenced Stores are created.
The Reference to the CustomerGroup with which the Customer is associated.
- * If referenced CustomerGroup does not exist, the state of the ImportOperation will be set to unresolved until the necessary CustomerGroup is created.
Maps to Customer.customerGroup. If the referenced CustomerGroup does not exist, the state of the ImportOperation will be set to unresolved until the referenced CustomerGroup is created.
The index of the address in the addresses array. The defaultBillingAddressId of the customer will be set to the ID of that address.
Index of the address in the addresses array to use as the default billing address. The defaultBillingAddressId of the Customer will be set to the id of that address.
The indices of the billing addresses in the addresses array. The billingAddressIds of the customer will be set to the IDs of that addresses.
Indices of the billing addresses in the addresses array. The billingAddressIds of the Customer will be set to the id of these addresses.
The index of the address in the addresses array. The defaultShippingAddressId of the customer will be set to the ID of that address.
The index of the address in the addresses array. The defaultShippingAddressId of the Customer will be set to the id of that address.
The indices of the shipping addresses in the addresses array. The shippingAddressIds of the customer will be set to the IDs of that addresses.
Indices of the shipping addresses in the addresses array. The shippingAddressIds of the Customer will be set to the id of these addresses.
The Custom Fields for this Customer.
+ *Maps to Customer.custom.
User-defined unique identifier. If a Customer with this key exists, it will be updated with the imported data.
User-defined unique identifier. If a Customer with this key exists, it is updated with the imported data.
Required when authenticationMode is set to Password. Maps to Customer.password.
Maps to Customer.password. Required when authenticationMode is set to Password.
The References to the Stores with which the Customer is associated. If referenced Stores do not exist, the state of the ImportOperation will be set to unresolved until the necessary Stores are created.
Maps to Customer.stores. If the referenced Stores do not exist, the state of the ImportOperation will be set to unresolved until the referenced Stores are created.
The Reference to the CustomerGroup with which the Customer is associated.
- * If referenced CustomerGroup does not exist, the state of the ImportOperation will be set to unresolved until the necessary CustomerGroup is created.
Maps to Customer.customerGroup. If the referenced CustomerGroup does not exist, the state of the ImportOperation will be set to unresolved until the referenced CustomerGroup is created.
The index of the address in the addresses array. The defaultBillingAddressId of the customer will be set to the ID of that address.
Index of the address in the addresses array to use as the default billing address. The defaultBillingAddressId of the Customer will be set to the id of that address.
The indices of the billing addresses in the addresses array. The billingAddressIds of the customer will be set to the IDs of that addresses.
Indices of the billing addresses in the addresses array. The billingAddressIds of the Customer will be set to the id of these addresses.
The index of the address in the addresses array. The defaultShippingAddressId of the customer will be set to the ID of that address.
The index of the address in the addresses array. The defaultShippingAddressId of the Customer will be set to the id of that address.
The indices of the shipping addresses in the addresses array. The shippingAddressIds of the customer will be set to the IDs of that addresses.
Indices of the shipping addresses in the addresses array. The shippingAddressIds of the Customer will be set to the id of these addresses.
The Custom Fields for this Customer.
+ *Maps to Customer.custom.
true or false
true or false
true or false
JSON array of boolean values without duplicates. + * The order of items in the array is not fixed.
+ * * @return null|array */ diff --git a/lib/commercetools-import/src/Models/Customfields/BooleanSetFieldBuilder.php b/lib/commercetools-import/src/Models/Customfields/BooleanSetFieldBuilder.php index 10c28124090..b39567306d8 100644 --- a/lib/commercetools-import/src/Models/Customfields/BooleanSetFieldBuilder.php +++ b/lib/commercetools-import/src/Models/Customfields/BooleanSetFieldBuilder.php @@ -27,6 +27,9 @@ final class BooleanSetFieldBuilder implements Builder private $value; /** + *JSON array of boolean values without duplicates. + * The order of items in the array is not fixed.
+ * * @return null|array */ diff --git a/lib/commercetools-import/src/Models/Customfields/BooleanSetFieldModel.php b/lib/commercetools-import/src/Models/Customfields/BooleanSetFieldModel.php index b4c0454c02f..943ee9fbc9e 100644 --- a/lib/commercetools-import/src/Models/Customfields/BooleanSetFieldModel.php +++ b/lib/commercetools-import/src/Models/Customfields/BooleanSetFieldModel.php @@ -65,6 +65,9 @@ public function getType() } /** + *JSON array of boolean values without duplicates. + * The order of items in the array is not fixed.
+ * * * @return null|array */ diff --git a/lib/commercetools-import/src/Models/Customfields/Custom.php b/lib/commercetools-import/src/Models/Customfields/Custom.php index 24ab1d386c5..004264d8fa7 100644 --- a/lib/commercetools-import/src/Models/Customfields/Custom.php +++ b/lib/commercetools-import/src/Models/Customfields/Custom.php @@ -18,7 +18,7 @@ interface Custom extends JsonObject public const FIELD_FIELDS = 'fields'; /** - *The type that provides the field definitions for this object.
+ *The Type that provides the field definitions for this object. If the referenced Type does not exist, the state of the ImportOperation will be set to unresolved until the referenced Type is created.
The type that provides the field definitions for this object.
+ *The Type that provides the field definitions for this object. If the referenced Type does not exist, the state of the ImportOperation will be set to unresolved until the referenced Type is created.
The type that provides the field definitions for this object.
+ *The Type that provides the field definitions for this object. If the referenced Type does not exist, the state of the ImportOperation will be set to unresolved until the referenced Type is created.
A date in the format YYYY-MM-DD.
A date in the format YYYY-MM-DD.
A date in the format YYYY-MM-DD.
JSON array of date values in the format YYYY-MM-DD without duplicates.
+ * The order of items in the array is not fixed.
JSON array of date values in the format YYYY-MM-DD without duplicates.
+ * The order of items in the array is not fixed.
JSON array of date values in the format YYYY-MM-DD without duplicates.
+ * The order of items in the array is not fixed.
A date with time in the format YYYY-MM-DDTHH:mm:ss.SSSZ.
+ * The time zone is optional and defaults to UTC if not specified.
+ * If the time zone is specified, it must be in the format ±HH:mm or Z for UTC.
A date with time in the format YYYY-MM-DDTHH:mm:ss.SSSZ.
+ * The time zone is optional and defaults to UTC if not specified.
+ * If the time zone is specified, it must be in the format ±HH:mm or Z for UTC.
A date with time in the format YYYY-MM-DDTHH:mm:ss.SSSZ.
+ * The time zone is optional and defaults to UTC if not specified.
+ * If the time zone is specified, it must be in the format ±HH:mm or Z for UTC.
JSON array of date time values in the format YYYY-MM-DDTHH:mm:ss.SSSZ without duplicates.
+ * The time zone is optional and defaults to UTC if not specified.
+ * If the time zone is specified, it must be in the format ±HH:mm or Z for UTC.
+ * The order of items in the array is not fixed.
JSON array of date time values in the format YYYY-MM-DDTHH:mm:ss.SSSZ without duplicates.
+ * The time zone is optional and defaults to UTC if not specified.
+ * If the time zone is specified, it must be in the format ±HH:mm or Z for UTC.
+ * The order of items in the array is not fixed.
JSON array of date time values in the format YYYY-MM-DDTHH:mm:ss.SSSZ without duplicates.
+ * The time zone is optional and defaults to UTC if not specified.
+ * If the time zone is specified, it must be in the format ±HH:mm or Z for UTC.
+ * The order of items in the array is not fixed.
The key of the enum value.
+ * Must be a key of one of the CustomFieldEnumValues defined in the CustomFieldEnumType.
The key of the enum value.
+ * Must be a key of one of the CustomFieldEnumValues defined in the CustomFieldEnumType.
The key of the enum value.
+ * Must be a key of one of the CustomFieldEnumValues defined in the CustomFieldEnumType.
JSON array of enum values, each represented by its key. + * Each key must match the key of a CustomFieldLocalizedEnumValue in the CustomFieldEnumType. + * The order of items in the array is not fixed.
+ * * @return null|array */ diff --git a/lib/commercetools-import/src/Models/Customfields/EnumSetFieldBuilder.php b/lib/commercetools-import/src/Models/Customfields/EnumSetFieldBuilder.php index 776bdcf42fe..776b7ff6dd8 100644 --- a/lib/commercetools-import/src/Models/Customfields/EnumSetFieldBuilder.php +++ b/lib/commercetools-import/src/Models/Customfields/EnumSetFieldBuilder.php @@ -27,6 +27,10 @@ final class EnumSetFieldBuilder implements Builder private $value; /** + *JSON array of enum values, each represented by its key. + * Each key must match the key of a CustomFieldLocalizedEnumValue in the CustomFieldEnumType. + * The order of items in the array is not fixed.
+ * * @return null|array */ diff --git a/lib/commercetools-import/src/Models/Customfields/EnumSetFieldModel.php b/lib/commercetools-import/src/Models/Customfields/EnumSetFieldModel.php index af18ee066d2..04eea87b629 100644 --- a/lib/commercetools-import/src/Models/Customfields/EnumSetFieldModel.php +++ b/lib/commercetools-import/src/Models/Customfields/EnumSetFieldModel.php @@ -65,6 +65,10 @@ public function getType() } /** + *JSON array of enum values, each represented by its key. + * Each key must match the key of a CustomFieldLocalizedEnumValue in the CustomFieldEnumType. + * The order of items in the array is not fixed.
+ * * * @return null|array */ diff --git a/lib/commercetools-import/src/Models/Customfields/LocalizedEnumField.php b/lib/commercetools-import/src/Models/Customfields/LocalizedEnumField.php index ca34670b941..f1709ed2423 100644 --- a/lib/commercetools-import/src/Models/Customfields/LocalizedEnumField.php +++ b/lib/commercetools-import/src/Models/Customfields/LocalizedEnumField.php @@ -16,6 +16,9 @@ interface LocalizedEnumField extends CustomField public const FIELD_VALUE = 'value'; /** + *The key of the localized enum value. + * Must match the key of a CustomFieldLocalizedEnumValue in the CustomFieldLocalizedEnumType.
+ * * @return null|string */ diff --git a/lib/commercetools-import/src/Models/Customfields/LocalizedEnumFieldBuilder.php b/lib/commercetools-import/src/Models/Customfields/LocalizedEnumFieldBuilder.php index 8809f12c4f2..38594863cfc 100644 --- a/lib/commercetools-import/src/Models/Customfields/LocalizedEnumFieldBuilder.php +++ b/lib/commercetools-import/src/Models/Customfields/LocalizedEnumFieldBuilder.php @@ -27,6 +27,9 @@ final class LocalizedEnumFieldBuilder implements Builder private $value; /** + *The key of the localized enum value. + * Must match the key of a CustomFieldLocalizedEnumValue in the CustomFieldLocalizedEnumType.
+ * * @return null|string */ diff --git a/lib/commercetools-import/src/Models/Customfields/LocalizedEnumFieldModel.php b/lib/commercetools-import/src/Models/Customfields/LocalizedEnumFieldModel.php index 1273e980aa4..c56e541f726 100644 --- a/lib/commercetools-import/src/Models/Customfields/LocalizedEnumFieldModel.php +++ b/lib/commercetools-import/src/Models/Customfields/LocalizedEnumFieldModel.php @@ -65,6 +65,9 @@ public function getType() } /** + *The key of the localized enum value. + * Must match the key of a CustomFieldLocalizedEnumValue in the CustomFieldLocalizedEnumType.
+ * * * @return null|string */ diff --git a/lib/commercetools-import/src/Models/Customfields/LocalizedEnumSetField.php b/lib/commercetools-import/src/Models/Customfields/LocalizedEnumSetField.php index 0d893dc6d9a..3340c92809d 100644 --- a/lib/commercetools-import/src/Models/Customfields/LocalizedEnumSetField.php +++ b/lib/commercetools-import/src/Models/Customfields/LocalizedEnumSetField.php @@ -16,6 +16,10 @@ interface LocalizedEnumSetField extends CustomField public const FIELD_VALUE = 'value'; /** + *JSON array of localized enum values, each represented by its key. + * Each key must match the key of an CustomFieldLocalizedEnumValue in the CustomFieldLocalizedEnumType. + * The order of items in the array is not fixed.
+ * * @return null|array */ diff --git a/lib/commercetools-import/src/Models/Customfields/LocalizedEnumSetFieldBuilder.php b/lib/commercetools-import/src/Models/Customfields/LocalizedEnumSetFieldBuilder.php index fea09cf32d5..93abcdc8525 100644 --- a/lib/commercetools-import/src/Models/Customfields/LocalizedEnumSetFieldBuilder.php +++ b/lib/commercetools-import/src/Models/Customfields/LocalizedEnumSetFieldBuilder.php @@ -27,6 +27,10 @@ final class LocalizedEnumSetFieldBuilder implements Builder private $value; /** + *JSON array of localized enum values, each represented by its key. + * Each key must match the key of an CustomFieldLocalizedEnumValue in the CustomFieldLocalizedEnumType. + * The order of items in the array is not fixed.
+ * * @return null|array */ diff --git a/lib/commercetools-import/src/Models/Customfields/LocalizedEnumSetFieldModel.php b/lib/commercetools-import/src/Models/Customfields/LocalizedEnumSetFieldModel.php index cf98b04074e..5527543483c 100644 --- a/lib/commercetools-import/src/Models/Customfields/LocalizedEnumSetFieldModel.php +++ b/lib/commercetools-import/src/Models/Customfields/LocalizedEnumSetFieldModel.php @@ -65,6 +65,10 @@ public function getType() } /** + *JSON array of localized enum values, each represented by its key. + * Each key must match the key of an CustomFieldLocalizedEnumValue in the CustomFieldLocalizedEnumType. + * The order of items in the array is not fixed.
+ * * * @return null|array */ diff --git a/lib/commercetools-import/src/Models/Customfields/LocalizedStringField.php b/lib/commercetools-import/src/Models/Customfields/LocalizedStringField.php index f1c2139d02f..9efeafbb047 100644 --- a/lib/commercetools-import/src/Models/Customfields/LocalizedStringField.php +++ b/lib/commercetools-import/src/Models/Customfields/LocalizedStringField.php @@ -17,12 +17,7 @@ interface LocalizedStringField extends CustomField public const FIELD_VALUE = 'value'; /** - *A localized string is a JSON object where the keys are of IETF language tag, and the values the corresponding strings used for that language.
- *{
- * "de": "Hundefutter",
- * "en": "dog food"
- * }
- *
+ * A localized string.
* * @return null|LocalizedString diff --git a/lib/commercetools-import/src/Models/Customfields/LocalizedStringFieldBuilder.php b/lib/commercetools-import/src/Models/Customfields/LocalizedStringFieldBuilder.php index 88c3bcf4ac8..e13bab23cfc 100644 --- a/lib/commercetools-import/src/Models/Customfields/LocalizedStringFieldBuilder.php +++ b/lib/commercetools-import/src/Models/Customfields/LocalizedStringFieldBuilder.php @@ -29,12 +29,7 @@ final class LocalizedStringFieldBuilder implements Builder private $value; /** - *A localized string is a JSON object where the keys are of IETF language tag, and the values the corresponding strings used for that language.
- *{
- * "de": "Hundefutter",
- * "en": "dog food"
- * }
- *
+ * A localized string.
* * @return null|LocalizedString diff --git a/lib/commercetools-import/src/Models/Customfields/LocalizedStringFieldModel.php b/lib/commercetools-import/src/Models/Customfields/LocalizedStringFieldModel.php index 4dcab2c70e1..198dc096071 100644 --- a/lib/commercetools-import/src/Models/Customfields/LocalizedStringFieldModel.php +++ b/lib/commercetools-import/src/Models/Customfields/LocalizedStringFieldModel.php @@ -67,12 +67,7 @@ public function getType() } /** - *A localized string is a JSON object where the keys are of IETF language tag, and the values the corresponding strings used for that language.
- *{
- * "de": "Hundefutter",
- * "en": "dog food"
- * }
- *
+ * A localized string.
* * * @return null|LocalizedString diff --git a/lib/commercetools-import/src/Models/Customfields/LocalizedStringSetField.php b/lib/commercetools-import/src/Models/Customfields/LocalizedStringSetField.php index 2ca87355de3..b3d77e5e706 100644 --- a/lib/commercetools-import/src/Models/Customfields/LocalizedStringSetField.php +++ b/lib/commercetools-import/src/Models/Customfields/LocalizedStringSetField.php @@ -17,6 +17,9 @@ interface LocalizedStringSetField extends CustomField public const FIELD_VALUE = 'value'; /** + *JSON array of localized strings. + * The order of items in the array is not fixed.
+ * * @return null|LocalizedStringCollection */ diff --git a/lib/commercetools-import/src/Models/Customfields/LocalizedStringSetFieldBuilder.php b/lib/commercetools-import/src/Models/Customfields/LocalizedStringSetFieldBuilder.php index 080b461ee1f..faa3df29435 100644 --- a/lib/commercetools-import/src/Models/Customfields/LocalizedStringSetFieldBuilder.php +++ b/lib/commercetools-import/src/Models/Customfields/LocalizedStringSetFieldBuilder.php @@ -28,6 +28,9 @@ final class LocalizedStringSetFieldBuilder implements Builder private $value; /** + *JSON array of localized strings. + * The order of items in the array is not fixed.
+ * * @return null|LocalizedStringCollection */ diff --git a/lib/commercetools-import/src/Models/Customfields/LocalizedStringSetFieldModel.php b/lib/commercetools-import/src/Models/Customfields/LocalizedStringSetFieldModel.php index 4886acdc934..cd221db4b66 100644 --- a/lib/commercetools-import/src/Models/Customfields/LocalizedStringSetFieldModel.php +++ b/lib/commercetools-import/src/Models/Customfields/LocalizedStringSetFieldModel.php @@ -66,6 +66,9 @@ public function getType() } /** + *JSON array of localized strings. + * The order of items in the array is not fixed.
+ * * * @return null|LocalizedStringCollection */ diff --git a/lib/commercetools-import/src/Models/Customfields/MoneyField.php b/lib/commercetools-import/src/Models/Customfields/MoneyField.php index 642c30ea532..6487352b34a 100644 --- a/lib/commercetools-import/src/Models/Customfields/MoneyField.php +++ b/lib/commercetools-import/src/Models/Customfields/MoneyField.php @@ -17,6 +17,8 @@ interface MoneyField extends CustomField public const FIELD_VALUE = 'value'; /** + *A money value in cent precision format.
+ * * @return null|TypedMoney */ diff --git a/lib/commercetools-import/src/Models/Customfields/MoneyFieldBuilder.php b/lib/commercetools-import/src/Models/Customfields/MoneyFieldBuilder.php index 43d6b2b28d9..20a872fd55a 100644 --- a/lib/commercetools-import/src/Models/Customfields/MoneyFieldBuilder.php +++ b/lib/commercetools-import/src/Models/Customfields/MoneyFieldBuilder.php @@ -29,6 +29,8 @@ final class MoneyFieldBuilder implements Builder private $value; /** + *A money value in cent precision format.
+ * * @return null|TypedMoney */ diff --git a/lib/commercetools-import/src/Models/Customfields/MoneyFieldModel.php b/lib/commercetools-import/src/Models/Customfields/MoneyFieldModel.php index 4a71c71f96c..ea9dff92e3a 100644 --- a/lib/commercetools-import/src/Models/Customfields/MoneyFieldModel.php +++ b/lib/commercetools-import/src/Models/Customfields/MoneyFieldModel.php @@ -67,6 +67,8 @@ public function getType() } /** + *A money value in cent precision format.
+ * * * @return null|TypedMoney */ diff --git a/lib/commercetools-import/src/Models/Customfields/MoneySetField.php b/lib/commercetools-import/src/Models/Customfields/MoneySetField.php index 18daabda3d9..6d41404de74 100644 --- a/lib/commercetools-import/src/Models/Customfields/MoneySetField.php +++ b/lib/commercetools-import/src/Models/Customfields/MoneySetField.php @@ -10,20 +10,23 @@ use Commercetools\Base\DateTimeImmutableCollection; use Commercetools\Base\JsonObject; -use Commercetools\Import\Models\Common\MoneyCollection; +use Commercetools\Import\Models\Common\TypedMoneyCollection; interface MoneySetField extends CustomField { public const FIELD_VALUE = 'value'; /** + *JSON array of money values in cent precision format. + * The order of items in the array is not fixed.
+ * - * @return null|MoneyCollection + * @return null|TypedMoneyCollection */ public function getValue(); /** - * @param ?MoneyCollection $value + * @param ?TypedMoneyCollection $value */ - public function setValue(?MoneyCollection $value): void; + public function setValue(?TypedMoneyCollection $value): void; } diff --git a/lib/commercetools-import/src/Models/Customfields/MoneySetFieldBuilder.php b/lib/commercetools-import/src/Models/Customfields/MoneySetFieldBuilder.php index 8fc742693b3..68efebdeb7c 100644 --- a/lib/commercetools-import/src/Models/Customfields/MoneySetFieldBuilder.php +++ b/lib/commercetools-import/src/Models/Customfields/MoneySetFieldBuilder.php @@ -13,7 +13,7 @@ use Commercetools\Base\JsonObject; use Commercetools\Base\JsonObjectModel; use Commercetools\Base\MapperFactory; -use Commercetools\Import\Models\Common\MoneyCollection; +use Commercetools\Import\Models\Common\TypedMoneyCollection; use stdClass; /** @@ -23,13 +23,16 @@ final class MoneySetFieldBuilder implements Builder { /** - * @var ?MoneyCollection + * @var ?TypedMoneyCollection */ private $value; /** + *JSON array of money values in cent precision format. + * The order of items in the array is not fixed.
+ * - * @return null|MoneyCollection + * @return null|TypedMoneyCollection */ public function getValue() { @@ -37,10 +40,10 @@ public function getValue() } /** - * @param ?MoneyCollection $value + * @param ?TypedMoneyCollection $value * @return $this */ - public function withValue(?MoneyCollection $value) + public function withValue(?TypedMoneyCollection $value) { $this->value = $value; diff --git a/lib/commercetools-import/src/Models/Customfields/MoneySetFieldModel.php b/lib/commercetools-import/src/Models/Customfields/MoneySetFieldModel.php index 0ff7db42bcb..59437878cff 100644 --- a/lib/commercetools-import/src/Models/Customfields/MoneySetFieldModel.php +++ b/lib/commercetools-import/src/Models/Customfields/MoneySetFieldModel.php @@ -12,7 +12,7 @@ use Commercetools\Base\JsonObject; use Commercetools\Base\JsonObjectModel; use Commercetools\Base\MapperFactory; -use Commercetools\Import\Models\Common\MoneyCollection; +use Commercetools\Import\Models\Common\TypedMoneyCollection; use stdClass; /** @@ -29,7 +29,7 @@ final class MoneySetFieldModel extends JsonObjectModel implements MoneySetField /** * - * @var ?MoneyCollection + * @var ?TypedMoneyCollection */ protected $value; @@ -38,7 +38,7 @@ final class MoneySetFieldModel extends JsonObjectModel implements MoneySetField * @psalm-suppress MissingParamType */ public function __construct( - ?MoneyCollection $value = null, + ?TypedMoneyCollection $value = null, ?string $type = null ) { $this->value = $value; @@ -66,8 +66,11 @@ public function getType() } /** + *JSON array of money values in cent precision format. + * The order of items in the array is not fixed.
* - * @return null|MoneyCollection + * + * @return null|TypedMoneyCollection */ public function getValue() { @@ -77,7 +80,7 @@ public function getValue() if (is_null($data)) { return null; } - $this->value = MoneyCollection::fromArray($data); + $this->value = TypedMoneyCollection::fromArray($data); } return $this->value; @@ -85,9 +88,9 @@ public function getValue() /** - * @param ?MoneyCollection $value + * @param ?TypedMoneyCollection $value */ - public function setValue(?MoneyCollection $value): void + public function setValue(?TypedMoneyCollection $value): void { $this->value = $value; } diff --git a/lib/commercetools-import/src/Models/Customfields/NumberField.php b/lib/commercetools-import/src/Models/Customfields/NumberField.php index 718d16c75c1..c26d771f79b 100644 --- a/lib/commercetools-import/src/Models/Customfields/NumberField.php +++ b/lib/commercetools-import/src/Models/Customfields/NumberField.php @@ -16,6 +16,9 @@ interface NumberField extends CustomField public const FIELD_VALUE = 'value'; /** + *A number value. + * Can be an integer or a floating-point number.
+ * * @return null|float */ diff --git a/lib/commercetools-import/src/Models/Customfields/NumberFieldBuilder.php b/lib/commercetools-import/src/Models/Customfields/NumberFieldBuilder.php index cdb8d273733..4ca63e0cbcc 100644 --- a/lib/commercetools-import/src/Models/Customfields/NumberFieldBuilder.php +++ b/lib/commercetools-import/src/Models/Customfields/NumberFieldBuilder.php @@ -27,6 +27,9 @@ final class NumberFieldBuilder implements Builder private $value; /** + *A number value. + * Can be an integer or a floating-point number.
+ * * @return null|float */ diff --git a/lib/commercetools-import/src/Models/Customfields/NumberFieldModel.php b/lib/commercetools-import/src/Models/Customfields/NumberFieldModel.php index ff8fa9bf0ff..bcaa4c93e12 100644 --- a/lib/commercetools-import/src/Models/Customfields/NumberFieldModel.php +++ b/lib/commercetools-import/src/Models/Customfields/NumberFieldModel.php @@ -65,6 +65,9 @@ public function getType() } /** + *A number value. + * Can be an integer or a floating-point number.
+ * * * @return null|float */ diff --git a/lib/commercetools-import/src/Models/Customfields/NumberSetField.php b/lib/commercetools-import/src/Models/Customfields/NumberSetField.php index cad72c6069b..7b5edd177a6 100644 --- a/lib/commercetools-import/src/Models/Customfields/NumberSetField.php +++ b/lib/commercetools-import/src/Models/Customfields/NumberSetField.php @@ -16,6 +16,9 @@ interface NumberSetField extends CustomField public const FIELD_VALUE = 'value'; /** + *JSON array of integer or floating-point number values. + * The order of items in the array is not fixed.
+ * * @return null|array */ diff --git a/lib/commercetools-import/src/Models/Customfields/NumberSetFieldBuilder.php b/lib/commercetools-import/src/Models/Customfields/NumberSetFieldBuilder.php index bda8fe55029..91b8249208c 100644 --- a/lib/commercetools-import/src/Models/Customfields/NumberSetFieldBuilder.php +++ b/lib/commercetools-import/src/Models/Customfields/NumberSetFieldBuilder.php @@ -27,6 +27,9 @@ final class NumberSetFieldBuilder implements Builder private $value; /** + *JSON array of integer or floating-point number values. + * The order of items in the array is not fixed.
+ * * @return null|array */ diff --git a/lib/commercetools-import/src/Models/Customfields/NumberSetFieldModel.php b/lib/commercetools-import/src/Models/Customfields/NumberSetFieldModel.php index 7a5c951205a..125ada0ee63 100644 --- a/lib/commercetools-import/src/Models/Customfields/NumberSetFieldModel.php +++ b/lib/commercetools-import/src/Models/Customfields/NumberSetFieldModel.php @@ -65,6 +65,9 @@ public function getType() } /** + *JSON array of integer or floating-point number values. + * The order of items in the array is not fixed.
+ * * * @return null|array */ diff --git a/lib/commercetools-import/src/Models/Customfields/ReferenceSetField.php b/lib/commercetools-import/src/Models/Customfields/ReferenceSetField.php index 17cae2f101e..6f14ae145cf 100644 --- a/lib/commercetools-import/src/Models/Customfields/ReferenceSetField.php +++ b/lib/commercetools-import/src/Models/Customfields/ReferenceSetField.php @@ -17,6 +17,9 @@ interface ReferenceSetField extends CustomField public const FIELD_VALUE = 'value'; /** + *JSON array of references, each referencing an existing resource by key. + * The order of items in the array is not fixed.
+ * * @return null|KeyReferenceCollection */ diff --git a/lib/commercetools-import/src/Models/Customfields/ReferenceSetFieldBuilder.php b/lib/commercetools-import/src/Models/Customfields/ReferenceSetFieldBuilder.php index c11fbec8d7e..61860acc139 100644 --- a/lib/commercetools-import/src/Models/Customfields/ReferenceSetFieldBuilder.php +++ b/lib/commercetools-import/src/Models/Customfields/ReferenceSetFieldBuilder.php @@ -28,6 +28,9 @@ final class ReferenceSetFieldBuilder implements Builder private $value; /** + *JSON array of references, each referencing an existing resource by key. + * The order of items in the array is not fixed.
+ * * @return null|KeyReferenceCollection */ diff --git a/lib/commercetools-import/src/Models/Customfields/ReferenceSetFieldModel.php b/lib/commercetools-import/src/Models/Customfields/ReferenceSetFieldModel.php index 6ca0da8a058..05ae6f0b06d 100644 --- a/lib/commercetools-import/src/Models/Customfields/ReferenceSetFieldModel.php +++ b/lib/commercetools-import/src/Models/Customfields/ReferenceSetFieldModel.php @@ -66,6 +66,9 @@ public function getType() } /** + *JSON array of references, each referencing an existing resource by key. + * The order of items in the array is not fixed.
+ * * * @return null|KeyReferenceCollection */ diff --git a/lib/commercetools-import/src/Models/Customfields/StringField.php b/lib/commercetools-import/src/Models/Customfields/StringField.php index c68fbe54a93..286cb52f1d8 100644 --- a/lib/commercetools-import/src/Models/Customfields/StringField.php +++ b/lib/commercetools-import/src/Models/Customfields/StringField.php @@ -16,6 +16,8 @@ interface StringField extends CustomField public const FIELD_VALUE = 'value'; /** + *A text value.
+ * * @return null|string */ diff --git a/lib/commercetools-import/src/Models/Customfields/StringFieldBuilder.php b/lib/commercetools-import/src/Models/Customfields/StringFieldBuilder.php index 0908fe9a232..866ebdce68a 100644 --- a/lib/commercetools-import/src/Models/Customfields/StringFieldBuilder.php +++ b/lib/commercetools-import/src/Models/Customfields/StringFieldBuilder.php @@ -27,6 +27,8 @@ final class StringFieldBuilder implements Builder private $value; /** + *A text value.
+ * * @return null|string */ diff --git a/lib/commercetools-import/src/Models/Customfields/StringFieldModel.php b/lib/commercetools-import/src/Models/Customfields/StringFieldModel.php index 6256d102519..50c4a9f2512 100644 --- a/lib/commercetools-import/src/Models/Customfields/StringFieldModel.php +++ b/lib/commercetools-import/src/Models/Customfields/StringFieldModel.php @@ -65,6 +65,8 @@ public function getType() } /** + *A text value.
+ * * * @return null|string */ diff --git a/lib/commercetools-import/src/Models/Customfields/StringSetField.php b/lib/commercetools-import/src/Models/Customfields/StringSetField.php index 4a698c9afa9..c96bbb75cdc 100644 --- a/lib/commercetools-import/src/Models/Customfields/StringSetField.php +++ b/lib/commercetools-import/src/Models/Customfields/StringSetField.php @@ -16,6 +16,9 @@ interface StringSetField extends CustomField public const FIELD_VALUE = 'value'; /** + *JSON array of strings. + * The order of items in the array is not fixed.
+ * * @return null|array */ diff --git a/lib/commercetools-import/src/Models/Customfields/StringSetFieldBuilder.php b/lib/commercetools-import/src/Models/Customfields/StringSetFieldBuilder.php index 4c282e4ec24..c2f0cb2c956 100644 --- a/lib/commercetools-import/src/Models/Customfields/StringSetFieldBuilder.php +++ b/lib/commercetools-import/src/Models/Customfields/StringSetFieldBuilder.php @@ -27,6 +27,9 @@ final class StringSetFieldBuilder implements Builder private $value; /** + *JSON array of strings. + * The order of items in the array is not fixed.
+ * * @return null|array */ diff --git a/lib/commercetools-import/src/Models/Customfields/StringSetFieldModel.php b/lib/commercetools-import/src/Models/Customfields/StringSetFieldModel.php index f53d52bb725..b8b8dabbe44 100644 --- a/lib/commercetools-import/src/Models/Customfields/StringSetFieldModel.php +++ b/lib/commercetools-import/src/Models/Customfields/StringSetFieldModel.php @@ -65,6 +65,9 @@ public function getType() } /** + *JSON array of strings. + * The order of items in the array is not fixed.
+ * * * @return null|array */ diff --git a/lib/commercetools-import/src/Models/Customfields/TimeField.php b/lib/commercetools-import/src/Models/Customfields/TimeField.php index 133bc36b798..d064f7856f2 100644 --- a/lib/commercetools-import/src/Models/Customfields/TimeField.php +++ b/lib/commercetools-import/src/Models/Customfields/TimeField.php @@ -17,6 +17,10 @@ interface TimeField extends CustomField public const FIELD_VALUE = 'value'; /** + *A time value in the format HH:mm:ss.SSS.
+ * The time zone is optional and defaults to UTC if not specified.
+ * If the time zone is specified, it must be in the format ±HH:mm or Z for UTC.
A time value in the format HH:mm:ss.SSS.
+ * The time zone is optional and defaults to UTC if not specified.
+ * If the time zone is specified, it must be in the format ±HH:mm or Z for UTC.
A time value in the format HH:mm:ss.SSS.
+ * The time zone is optional and defaults to UTC if not specified.
+ * If the time zone is specified, it must be in the format ±HH:mm or Z for UTC.
JSON array of time values in the format HH:mm:ss.SSS.
+ * The time zone is optional and defaults to UTC if not specified.
+ * If the time zone is specified, it must be in the format ±HH:mm or Z for UTC.
+ * The order of items in the array is not fixed.
JSON array of time values in the format HH:mm:ss.SSS.
+ * The time zone is optional and defaults to UTC if not specified.
+ * If the time zone is specified, it must be in the format ±HH:mm or Z for UTC.
+ * The order of items in the array is not fixed.
JSON array of time values in the format HH:mm:ss.SSS.
+ * The time zone is optional and defaults to UTC if not specified.
+ * If the time zone is specified, it must be in the format ±HH:mm or Z for UTC.
+ * The order of items in the array is not fixed.
User-defined unique identifier. If a Discount Code with this key exists, it will be updated with the imported data.
User-defined unique identifier. If a DiscountCode with this key exists, it is updated with the imported data.
User-defined unique identifier of the DiscountCode that is used by the customer to apply the discount.
- *The value cannot be updated. Attempting to update the value will result in an InvalidFieldsUpdate error.
+ *Maps to DiscountCode.code. This value cannot be updated. Attempting to update this value will result in an InvalidFieldsUpdate error.
Reference to CartDiscounts that can be applied to the Cart once the DiscountCode is applied.
+ *Maps to DiscountCode.cartDiscounts. If the referenced CartDiscounts do not exist, the state of the ImportOperation will be set to unresolved until the referenced CartDiscounts are created.
DiscountCode can only be applied to Carts that match this predicate.
+ *Maps to DiscountCode.cartPredicate.
Indicates if the DiscountCode is active and can be applied to the Cart.
+ *Maps to DiscountCode.isActive.
Number of times the DiscountCode can be applied. DiscountCode application is counted at the time of Order creation or update. However, Order cancellation or deletion does not decrement the count.
+ *Maps to DiscountCode.maxApplications.
Number of times the DiscountCode can be applied per Customer (anonymous Carts are not supported). DiscountCode application is counted at the time of Order creation or update. However, Order cancellation or deletion does not decrement the count.
+ *Maps to DiscountCode.maxApplicationsPerCustomer.
Groups to which the DiscountCode belongs.
+ *Maps to DiscountCode.groups.
Date and time (UTC) from which the DiscountCode is effective.
+ *Maps to DiscountCode.validFrom.
Date and time (UTC) until which the DiscountCode is effective.
+ *Maps to DiscountCode.validUntil.
Custom Fields of the DiscountCode.
+ *Maps to DiscountCode.custom.
User-defined unique identifier. If a Discount Code with this key exists, it will be updated with the imported data.
User-defined unique identifier. If a DiscountCode with this key exists, it is updated with the imported data.
User-defined unique identifier of the DiscountCode that is used by the customer to apply the discount.
- *The value cannot be updated. Attempting to update the value will result in an InvalidFieldsUpdate error.
+ *Maps to DiscountCode.code. This value cannot be updated. Attempting to update this value will result in an InvalidFieldsUpdate error.
Reference to CartDiscounts that can be applied to the Cart once the DiscountCode is applied.
+ *Maps to DiscountCode.cartDiscounts. If the referenced CartDiscounts do not exist, the state of the ImportOperation will be set to unresolved until the referenced CartDiscounts are created.
DiscountCode can only be applied to Carts that match this predicate.
+ *Maps to DiscountCode.cartPredicate.
Indicates if the DiscountCode is active and can be applied to the Cart.
+ *Maps to DiscountCode.isActive.
Number of times the DiscountCode can be applied. DiscountCode application is counted at the time of Order creation or update. However, Order cancellation or deletion does not decrement the count.
+ *Maps to DiscountCode.maxApplications.
Number of times the DiscountCode can be applied per Customer (anonymous Carts are not supported). DiscountCode application is counted at the time of Order creation or update. However, Order cancellation or deletion does not decrement the count.
+ *Maps to DiscountCode.maxApplicationsPerCustomer.
Groups to which the DiscountCode belongs.
+ *Maps to DiscountCode.groups.
Date and time (UTC) from which the DiscountCode is effective.
+ *Maps to DiscountCode.validFrom.
Date and time (UTC) until which the DiscountCode is effective.
+ *Maps to DiscountCode.validUntil.
Custom Fields of the DiscountCode.
+ *Maps to DiscountCode.custom.
User-defined unique identifier. If a Discount Code with this key exists, it will be updated with the imported data.
User-defined unique identifier. If a DiscountCode with this key exists, it is updated with the imported data.
User-defined unique identifier of the DiscountCode that is used by the customer to apply the discount.
- *The value cannot be updated. Attempting to update the value will result in an InvalidFieldsUpdate error.
+ *Maps to DiscountCode.code. This value cannot be updated. Attempting to update this value will result in an InvalidFieldsUpdate error.
Reference to CartDiscounts that can be applied to the Cart once the DiscountCode is applied.
+ *Maps to DiscountCode.cartDiscounts. If the referenced CartDiscounts do not exist, the state of the ImportOperation will be set to unresolved until the referenced CartDiscounts are created.
DiscountCode can only be applied to Carts that match this predicate.
+ *Maps to DiscountCode.cartPredicate.
Indicates if the DiscountCode is active and can be applied to the Cart.
+ *Maps to DiscountCode.isActive.
Number of times the DiscountCode can be applied. DiscountCode application is counted at the time of Order creation or update. However, Order cancellation or deletion does not decrement the count.
+ *Maps to DiscountCode.maxApplications.
Number of times the DiscountCode can be applied per Customer (anonymous Carts are not supported). DiscountCode application is counted at the time of Order creation or update. However, Order cancellation or deletion does not decrement the count.
+ *Maps to DiscountCode.maxApplicationsPerCustomer.
Groups to which the DiscountCode belongs.
+ *Maps to DiscountCode.groups.
Date and time (UTC) from which the DiscountCode is effective.
+ *Maps to DiscountCode.validFrom.
Date and time (UTC) until which the DiscountCode is effective.
+ *Maps to DiscountCode.validUntil.
Custom Fields of the DiscountCode.
+ *Maps to DiscountCode.custom.
The index of the resource in the import request that contains the invalid field.
+ * * @return null|int */ diff --git a/lib/commercetools-import/src/Models/Errors/InvalidFieldErrorBuilder.php b/lib/commercetools-import/src/Models/Errors/InvalidFieldErrorBuilder.php index b972508dcac..e4a604b94f1 100644 --- a/lib/commercetools-import/src/Models/Errors/InvalidFieldErrorBuilder.php +++ b/lib/commercetools-import/src/Models/Errors/InvalidFieldErrorBuilder.php @@ -95,6 +95,8 @@ public function getAllowedValues() } /** + *The index of the resource in the import request that contains the invalid field.
+ * * @return null|int */ diff --git a/lib/commercetools-import/src/Models/Errors/InvalidFieldErrorModel.php b/lib/commercetools-import/src/Models/Errors/InvalidFieldErrorModel.php index 5f30c5d35fe..713bb9fc37a 100644 --- a/lib/commercetools-import/src/Models/Errors/InvalidFieldErrorModel.php +++ b/lib/commercetools-import/src/Models/Errors/InvalidFieldErrorModel.php @@ -177,6 +177,8 @@ public function getAllowedValues() } /** + *The index of the resource in the import request that contains the invalid field.
+ * * * @return null|int */ diff --git a/lib/commercetools-import/src/Models/Errors/ResourceCreationError.php b/lib/commercetools-import/src/Models/Errors/ResourceCreationError.php index c3a9876ab2b..4343643b2b9 100644 --- a/lib/commercetools-import/src/Models/Errors/ResourceCreationError.php +++ b/lib/commercetools-import/src/Models/Errors/ResourceCreationError.php @@ -16,6 +16,8 @@ interface ResourceCreationError extends ErrorObject public const FIELD_RESOURCE = 'resource'; /** + *The resource that was created.
+ * * @return null|mixed */ diff --git a/lib/commercetools-import/src/Models/Errors/ResourceCreationErrorBuilder.php b/lib/commercetools-import/src/Models/Errors/ResourceCreationErrorBuilder.php index 2e2b6269b89..250fbbe9310 100644 --- a/lib/commercetools-import/src/Models/Errors/ResourceCreationErrorBuilder.php +++ b/lib/commercetools-import/src/Models/Errors/ResourceCreationErrorBuilder.php @@ -44,6 +44,8 @@ public function getMessage() } /** + *The resource that was created.
+ * * @return null|mixed */ diff --git a/lib/commercetools-import/src/Models/Errors/ResourceCreationErrorModel.php b/lib/commercetools-import/src/Models/Errors/ResourceCreationErrorModel.php index 6de53abd6fc..1b184b18853 100644 --- a/lib/commercetools-import/src/Models/Errors/ResourceCreationErrorModel.php +++ b/lib/commercetools-import/src/Models/Errors/ResourceCreationErrorModel.php @@ -93,6 +93,8 @@ public function getMessage() } /** + *The resource that was created.
+ * * * @return null|mixed */ diff --git a/lib/commercetools-import/src/Models/Errors/ResourceDeletionError.php b/lib/commercetools-import/src/Models/Errors/ResourceDeletionError.php index f4f3a509b96..00ec15b5fdd 100644 --- a/lib/commercetools-import/src/Models/Errors/ResourceDeletionError.php +++ b/lib/commercetools-import/src/Models/Errors/ResourceDeletionError.php @@ -16,6 +16,8 @@ interface ResourceDeletionError extends ErrorObject public const FIELD_RESOURCE = 'resource'; /** + *The resource that was deleted.
+ * * @return null|mixed */ diff --git a/lib/commercetools-import/src/Models/Errors/ResourceDeletionErrorBuilder.php b/lib/commercetools-import/src/Models/Errors/ResourceDeletionErrorBuilder.php index 188e71478aa..0a6dfc44424 100644 --- a/lib/commercetools-import/src/Models/Errors/ResourceDeletionErrorBuilder.php +++ b/lib/commercetools-import/src/Models/Errors/ResourceDeletionErrorBuilder.php @@ -44,6 +44,8 @@ public function getMessage() } /** + *The resource that was deleted.
+ * * @return null|mixed */ diff --git a/lib/commercetools-import/src/Models/Errors/ResourceDeletionErrorModel.php b/lib/commercetools-import/src/Models/Errors/ResourceDeletionErrorModel.php index 96b0eb33ffe..2161976a1fa 100644 --- a/lib/commercetools-import/src/Models/Errors/ResourceDeletionErrorModel.php +++ b/lib/commercetools-import/src/Models/Errors/ResourceDeletionErrorModel.php @@ -93,6 +93,8 @@ public function getMessage() } /** + *The resource that was deleted.
+ * * * @return null|mixed */ diff --git a/lib/commercetools-import/src/Models/Errors/ResourceNotFoundError.php b/lib/commercetools-import/src/Models/Errors/ResourceNotFoundError.php index 504e2f1b188..d99829bcd3e 100644 --- a/lib/commercetools-import/src/Models/Errors/ResourceNotFoundError.php +++ b/lib/commercetools-import/src/Models/Errors/ResourceNotFoundError.php @@ -16,6 +16,8 @@ interface ResourceNotFoundError extends ErrorObject public const FIELD_RESOURCE = 'resource'; /** + *The resource that was not found.
+ * * @return null|mixed */ diff --git a/lib/commercetools-import/src/Models/Errors/ResourceNotFoundErrorBuilder.php b/lib/commercetools-import/src/Models/Errors/ResourceNotFoundErrorBuilder.php index 17ebdea40df..86a0d86818a 100644 --- a/lib/commercetools-import/src/Models/Errors/ResourceNotFoundErrorBuilder.php +++ b/lib/commercetools-import/src/Models/Errors/ResourceNotFoundErrorBuilder.php @@ -44,6 +44,8 @@ public function getMessage() } /** + *The resource that was not found.
+ * * @return null|mixed */ diff --git a/lib/commercetools-import/src/Models/Errors/ResourceNotFoundErrorModel.php b/lib/commercetools-import/src/Models/Errors/ResourceNotFoundErrorModel.php index 6b741dadbc1..cdfacc82bf4 100644 --- a/lib/commercetools-import/src/Models/Errors/ResourceNotFoundErrorModel.php +++ b/lib/commercetools-import/src/Models/Errors/ResourceNotFoundErrorModel.php @@ -93,6 +93,8 @@ public function getMessage() } /** + *The resource that was not found.
+ * * * @return null|mixed */ diff --git a/lib/commercetools-import/src/Models/Errors/ResourceUpdateError.php b/lib/commercetools-import/src/Models/Errors/ResourceUpdateError.php index dc625d4c641..b18daa31d1e 100644 --- a/lib/commercetools-import/src/Models/Errors/ResourceUpdateError.php +++ b/lib/commercetools-import/src/Models/Errors/ResourceUpdateError.php @@ -16,6 +16,8 @@ interface ResourceUpdateError extends ErrorObject public const FIELD_RESOURCE = 'resource'; /** + *The resource that was updated.
+ * * @return null|mixed */ diff --git a/lib/commercetools-import/src/Models/Errors/ResourceUpdateErrorBuilder.php b/lib/commercetools-import/src/Models/Errors/ResourceUpdateErrorBuilder.php index 5014eab8f8b..494762c0679 100644 --- a/lib/commercetools-import/src/Models/Errors/ResourceUpdateErrorBuilder.php +++ b/lib/commercetools-import/src/Models/Errors/ResourceUpdateErrorBuilder.php @@ -44,6 +44,8 @@ public function getMessage() } /** + *The resource that was updated.
+ * * @return null|mixed */ diff --git a/lib/commercetools-import/src/Models/Errors/ResourceUpdateErrorModel.php b/lib/commercetools-import/src/Models/Errors/ResourceUpdateErrorModel.php index 7e42884751d..68045de2df8 100644 --- a/lib/commercetools-import/src/Models/Errors/ResourceUpdateErrorModel.php +++ b/lib/commercetools-import/src/Models/Errors/ResourceUpdateErrorModel.php @@ -93,6 +93,8 @@ public function getMessage() } /** + *The resource that was updated.
+ * * * @return null|mixed */ diff --git a/lib/commercetools-import/src/Models/Errors/VariantValues.php b/lib/commercetools-import/src/Models/Errors/VariantValues.php index e1c013a41e4..8db4c4222d7 100644 --- a/lib/commercetools-import/src/Models/Errors/VariantValues.php +++ b/lib/commercetools-import/src/Models/Errors/VariantValues.php @@ -20,6 +20,8 @@ interface VariantValues extends JsonObject public const FIELD_ATTRIBUTES = 'attributes'; /** + *The SKU of the Product Variant.
+ * * @return null|string */ diff --git a/lib/commercetools-import/src/Models/Errors/VariantValuesBuilder.php b/lib/commercetools-import/src/Models/Errors/VariantValuesBuilder.php index 7f5885ff9b5..123bc646e30 100644 --- a/lib/commercetools-import/src/Models/Errors/VariantValuesBuilder.php +++ b/lib/commercetools-import/src/Models/Errors/VariantValuesBuilder.php @@ -41,6 +41,8 @@ final class VariantValuesBuilder implements Builder private $attributes; /** + *The SKU of the Product Variant.
+ * * @return null|string */ diff --git a/lib/commercetools-import/src/Models/Errors/VariantValuesModel.php b/lib/commercetools-import/src/Models/Errors/VariantValuesModel.php index b18380d0e88..650f073b61d 100644 --- a/lib/commercetools-import/src/Models/Errors/VariantValuesModel.php +++ b/lib/commercetools-import/src/Models/Errors/VariantValuesModel.php @@ -54,6 +54,8 @@ public function __construct( } /** + *The SKU of the Product Variant.
+ * * * @return null|string */ diff --git a/lib/commercetools-import/src/Models/Importcontainers/ImportContainer.php b/lib/commercetools-import/src/Models/Importcontainers/ImportContainer.php index 397a5fee3a1..d0c5d258a3a 100644 --- a/lib/commercetools-import/src/Models/Importcontainers/ImportContainer.php +++ b/lib/commercetools-import/src/Models/Importcontainers/ImportContainer.php @@ -23,7 +23,7 @@ interface ImportContainer extends JsonObject public const FIELD_EXPIRES_AT = 'expiresAt'; /** - *User-defined unique identifier for the ImportContainer.
+ *User-defined unique identifier of the ImportContainer.
* * @return null|string @@ -31,8 +31,7 @@ interface ImportContainer extends JsonObject public function getKey(); /** - *The resource type the ImportContainer is able to handle. - * If not present, the ImportContainer is able to import all of the supported ImportResourceTypes.
+ *The resource type the ImportContainer supports. If not present, the ImportContainer can import all of the supported ImportResourceTypes.
* * @return null|string @@ -40,7 +39,7 @@ public function getKey(); public function getResourceType(); /** - *The version of the ImportContainer.
+ *Current version of the ImportContainer.
* * @return null|int diff --git a/lib/commercetools-import/src/Models/Importcontainers/ImportContainerBuilder.php b/lib/commercetools-import/src/Models/Importcontainers/ImportContainerBuilder.php index 9e904914c32..acb9f8f8df5 100644 --- a/lib/commercetools-import/src/Models/Importcontainers/ImportContainerBuilder.php +++ b/lib/commercetools-import/src/Models/Importcontainers/ImportContainerBuilder.php @@ -64,7 +64,7 @@ final class ImportContainerBuilder implements Builder private $expiresAt; /** - *User-defined unique identifier for the ImportContainer.
+ *User-defined unique identifier of the ImportContainer.
* * @return null|string @@ -75,8 +75,7 @@ public function getKey() } /** - *The resource type the ImportContainer is able to handle. - * If not present, the ImportContainer is able to import all of the supported ImportResourceTypes.
+ *The resource type the ImportContainer supports. If not present, the ImportContainer can import all of the supported ImportResourceTypes.
* * @return null|string @@ -87,7 +86,7 @@ public function getResourceType() } /** - *The version of the ImportContainer.
+ *Current version of the ImportContainer.
* * @return null|int diff --git a/lib/commercetools-import/src/Models/Importcontainers/ImportContainerDraft.php b/lib/commercetools-import/src/Models/Importcontainers/ImportContainerDraft.php index 1eb82928547..8716632c04a 100644 --- a/lib/commercetools-import/src/Models/Importcontainers/ImportContainerDraft.php +++ b/lib/commercetools-import/src/Models/Importcontainers/ImportContainerDraft.php @@ -26,8 +26,8 @@ interface ImportContainerDraft extends JsonObject public function getKey(); /** - *The resource type to be imported. - * If not given, the ImportContainer is able to import all of the supported ImportResourceTypes.
+ *The resource type the ImportContainer will accept. + * If not specified, the ImportContainer can import all of the supported ImportResourceTypes.
* * @return null|string diff --git a/lib/commercetools-import/src/Models/Importcontainers/ImportContainerDraftBuilder.php b/lib/commercetools-import/src/Models/Importcontainers/ImportContainerDraftBuilder.php index de5f060a7ce..f1ded68fd92 100644 --- a/lib/commercetools-import/src/Models/Importcontainers/ImportContainerDraftBuilder.php +++ b/lib/commercetools-import/src/Models/Importcontainers/ImportContainerDraftBuilder.php @@ -50,8 +50,8 @@ public function getKey() } /** - *The resource type to be imported. - * If not given, the ImportContainer is able to import all of the supported ImportResourceTypes.
+ *The resource type the ImportContainer will accept. + * If not specified, the ImportContainer can import all of the supported ImportResourceTypes.
* * @return null|string diff --git a/lib/commercetools-import/src/Models/Importcontainers/ImportContainerDraftModel.php b/lib/commercetools-import/src/Models/Importcontainers/ImportContainerDraftModel.php index 0264c9ff4c4..c94eb7b7ad2 100644 --- a/lib/commercetools-import/src/Models/Importcontainers/ImportContainerDraftModel.php +++ b/lib/commercetools-import/src/Models/Importcontainers/ImportContainerDraftModel.php @@ -72,8 +72,8 @@ public function getKey() } /** - *The resource type to be imported. - * If not given, the ImportContainer is able to import all of the supported ImportResourceTypes.
+ *The resource type the ImportContainer will accept. + * If not specified, the ImportContainer can import all of the supported ImportResourceTypes.
* * * @return null|string diff --git a/lib/commercetools-import/src/Models/Importcontainers/ImportContainerModel.php b/lib/commercetools-import/src/Models/Importcontainers/ImportContainerModel.php index 2a50083d1cc..456de410b1d 100644 --- a/lib/commercetools-import/src/Models/Importcontainers/ImportContainerModel.php +++ b/lib/commercetools-import/src/Models/Importcontainers/ImportContainerModel.php @@ -85,7 +85,7 @@ public function __construct( } /** - *User-defined unique identifier for the ImportContainer.
+ *User-defined unique identifier of the ImportContainer.
* * * @return null|string @@ -105,8 +105,7 @@ public function getKey() } /** - *The resource type the ImportContainer is able to handle. - * If not present, the ImportContainer is able to import all of the supported ImportResourceTypes.
+ *The resource type the ImportContainer supports. If not present, the ImportContainer can import all of the supported ImportResourceTypes.
* * * @return null|string @@ -126,7 +125,7 @@ public function getResourceType() } /** - *The version of the ImportContainer.
+ *Current version of the ImportContainer.
* * * @return null|int diff --git a/lib/commercetools-import/src/Models/Importcontainers/ImportContainerPagedResponse.php b/lib/commercetools-import/src/Models/Importcontainers/ImportContainerPagedResponse.php index 0110d7d910f..cb0416ef3ac 100644 --- a/lib/commercetools-import/src/Models/Importcontainers/ImportContainerPagedResponse.php +++ b/lib/commercetools-import/src/Models/Importcontainers/ImportContainerPagedResponse.php @@ -36,7 +36,7 @@ public function getLimit(); public function getOffset(); /** - *The actual number of results returned.
+ *Actual number of results returned.
* * @return null|int @@ -44,7 +44,7 @@ public function getOffset(); public function getCount(); /** - *The total number of results matching the query.
+ *Total number of results matching the query.
* * @return null|int @@ -52,7 +52,7 @@ public function getCount(); public function getTotal(); /** - *The array of Import Containers matching the query.
+ *ImportContainers matching the query.
* * @return null|ImportContainerCollection diff --git a/lib/commercetools-import/src/Models/Importcontainers/ImportContainerPagedResponseBuilder.php b/lib/commercetools-import/src/Models/Importcontainers/ImportContainerPagedResponseBuilder.php index 25d7fc24826..e328cd0aa4a 100644 --- a/lib/commercetools-import/src/Models/Importcontainers/ImportContainerPagedResponseBuilder.php +++ b/lib/commercetools-import/src/Models/Importcontainers/ImportContainerPagedResponseBuilder.php @@ -73,7 +73,7 @@ public function getOffset() } /** - *The actual number of results returned.
+ *Actual number of results returned.
* * @return null|int @@ -84,7 +84,7 @@ public function getCount() } /** - *The total number of results matching the query.
+ *Total number of results matching the query.
* * @return null|int @@ -95,7 +95,7 @@ public function getTotal() } /** - *The array of Import Containers matching the query.
+ *ImportContainers matching the query.
* * @return null|ImportContainerCollection diff --git a/lib/commercetools-import/src/Models/Importcontainers/ImportContainerPagedResponseModel.php b/lib/commercetools-import/src/Models/Importcontainers/ImportContainerPagedResponseModel.php index 2a268400c3f..c0721a16d3d 100644 --- a/lib/commercetools-import/src/Models/Importcontainers/ImportContainerPagedResponseModel.php +++ b/lib/commercetools-import/src/Models/Importcontainers/ImportContainerPagedResponseModel.php @@ -108,7 +108,7 @@ public function getOffset() } /** - *The actual number of results returned.
+ *Actual number of results returned.
* * * @return null|int @@ -128,7 +128,7 @@ public function getCount() } /** - *The total number of results matching the query.
+ *Total number of results matching the query.
* * * @return null|int @@ -148,7 +148,7 @@ public function getTotal() } /** - *The array of Import Containers matching the query.
+ *ImportContainers matching the query.
* * * @return null|ImportContainerCollection diff --git a/lib/commercetools-import/src/Models/Importcontainers/ImportContainerUpdateDraft.php b/lib/commercetools-import/src/Models/Importcontainers/ImportContainerUpdateDraft.php index 0834e783b96..29113cbfbc1 100644 --- a/lib/commercetools-import/src/Models/Importcontainers/ImportContainerUpdateDraft.php +++ b/lib/commercetools-import/src/Models/Importcontainers/ImportContainerUpdateDraft.php @@ -25,8 +25,8 @@ interface ImportContainerUpdateDraft extends JsonObject public function getVersion(); /** - *The resource type to be imported. - * If not given, the ImportContainer is able to import all of the supported ImportResourceTypes.
+ *The resource type to be imported. + * If not given, the ImportContainer is able to import all of the supported ImportResourceTypes.
* * @return null|string diff --git a/lib/commercetools-import/src/Models/Importcontainers/ImportContainerUpdateDraftBuilder.php b/lib/commercetools-import/src/Models/Importcontainers/ImportContainerUpdateDraftBuilder.php index 4d4bd148a99..e732155e8db 100644 --- a/lib/commercetools-import/src/Models/Importcontainers/ImportContainerUpdateDraftBuilder.php +++ b/lib/commercetools-import/src/Models/Importcontainers/ImportContainerUpdateDraftBuilder.php @@ -44,8 +44,8 @@ public function getVersion() } /** - *The resource type to be imported. - * If not given, the ImportContainer is able to import all of the supported ImportResourceTypes.
+ *The resource type to be imported. + * If not given, the ImportContainer is able to import all of the supported ImportResourceTypes.
* * @return null|string diff --git a/lib/commercetools-import/src/Models/Importcontainers/ImportContainerUpdateDraftModel.php b/lib/commercetools-import/src/Models/Importcontainers/ImportContainerUpdateDraftModel.php index 0b06227ba91..cdbd83189a6 100644 --- a/lib/commercetools-import/src/Models/Importcontainers/ImportContainerUpdateDraftModel.php +++ b/lib/commercetools-import/src/Models/Importcontainers/ImportContainerUpdateDraftModel.php @@ -64,8 +64,8 @@ public function getVersion() } /** - *The resource type to be imported. - * If not given, the ImportContainer is able to import all of the supported ImportResourceTypes.
+ *The resource type to be imported. + * If not given, the ImportContainer is able to import all of the supported ImportResourceTypes.
* * * @return null|string diff --git a/lib/commercetools-import/src/Models/Importoperations/ImportOperation.php b/lib/commercetools-import/src/Models/Importoperations/ImportOperation.php index 7d1f0eaa220..71b7471797e 100644 --- a/lib/commercetools-import/src/Models/Importoperations/ImportOperation.php +++ b/lib/commercetools-import/src/Models/Importoperations/ImportOperation.php @@ -29,7 +29,7 @@ interface ImportOperation extends JsonObject public const FIELD_EXPIRES_AT = 'expiresAt'; /** - *The version of the ImportOperation.
+ *Current version of the ImportOperation.
* * @return null|int @@ -37,7 +37,7 @@ interface ImportOperation extends JsonObject public function getVersion(); /** - *The key of the ImportContainer.
+ *key of the ImportContainer.
The key of the resource.
+ *key of the resource being imported.
The ID of the ImportOperation.
+ *Unique identifier of the ImportOperation.
* * @return null|string @@ -61,7 +61,7 @@ public function getResourceKey(); public function getId(); /** - *The import status of the resource. Set to rejected or validationFailed if the import of the resource was not successful.
The import status of the resource. If rejected or validationFailed, the import was unsuccessful.
The version of the imported resource when the import was successful.
+ *The version of the imported resource when the import was successful.
Contains an error if the import of the resource was not successful. See Errors.
+ *Contains errors if the import was unsuccessful. See Errors.
* * @return null|ErrorObjectCollection @@ -85,7 +85,7 @@ public function getResourceVersion(); public function getErrors(); /** - *In case of unresolved status this array will show the unresolved references
+ *If the resource being imported contains references to resources which do not exist, these references are contained within this array.
* * @return null|UnresolvedReferencesCollection @@ -93,7 +93,7 @@ public function getErrors(); public function getUnresolvedReferences(); /** - *The time when the ImportOperation was created.
+ *Date and time (UTC) the ImportOperation was created.
* * @return null|DateTimeImmutable @@ -101,7 +101,7 @@ public function getUnresolvedReferences(); public function getCreatedAt(); /** - *The last time When the ImportOperation was modified.
+ *Date and time (UTC) the ImportOperation was last updated.
* * @return null|DateTimeImmutable @@ -109,7 +109,7 @@ public function getCreatedAt(); public function getLastModifiedAt(); /** - *The expiration time of the ImportOperation.
+ *Date and time (UTC) the ImportOperation will be deleted.
* * @return null|DateTimeImmutable diff --git a/lib/commercetools-import/src/Models/Importoperations/ImportOperationBuilder.php b/lib/commercetools-import/src/Models/Importoperations/ImportOperationBuilder.php index b943647e7c2..8d8fbb6ebb1 100644 --- a/lib/commercetools-import/src/Models/Importoperations/ImportOperationBuilder.php +++ b/lib/commercetools-import/src/Models/Importoperations/ImportOperationBuilder.php @@ -90,7 +90,7 @@ final class ImportOperationBuilder implements Builder private $expiresAt; /** - *The version of the ImportOperation.
+ *Current version of the ImportOperation.
* * @return null|int @@ -101,7 +101,7 @@ public function getVersion() } /** - *The key of the ImportContainer.
+ *key of the ImportContainer.
The key of the resource.
+ *key of the resource being imported.
The ID of the ImportOperation.
+ *Unique identifier of the ImportOperation.
* * @return null|string @@ -134,7 +134,7 @@ public function getId() } /** - *The import status of the resource. Set to rejected or validationFailed if the import of the resource was not successful.
The import status of the resource. If rejected or validationFailed, the import was unsuccessful.
The version of the imported resource when the import was successful.
+ *The version of the imported resource when the import was successful.
Contains an error if the import of the resource was not successful. See Errors.
+ *Contains errors if the import was unsuccessful. See Errors.
* * @return null|ErrorObjectCollection @@ -167,7 +167,7 @@ public function getErrors() } /** - *In case of unresolved status this array will show the unresolved references
+ *If the resource being imported contains references to resources which do not exist, these references are contained within this array.
* * @return null|UnresolvedReferencesCollection @@ -178,7 +178,7 @@ public function getUnresolvedReferences() } /** - *The time when the ImportOperation was created.
+ *Date and time (UTC) the ImportOperation was created.
* * @return null|DateTimeImmutable @@ -189,7 +189,7 @@ public function getCreatedAt() } /** - *The last time When the ImportOperation was modified.
+ *Date and time (UTC) the ImportOperation was last updated.
* * @return null|DateTimeImmutable @@ -200,7 +200,7 @@ public function getLastModifiedAt() } /** - *The expiration time of the ImportOperation.
+ *Date and time (UTC) the ImportOperation will be deleted.
* * @return null|DateTimeImmutable diff --git a/lib/commercetools-import/src/Models/Importoperations/ImportOperationModel.php b/lib/commercetools-import/src/Models/Importoperations/ImportOperationModel.php index d59a3c19072..afc46b2f9fa 100644 --- a/lib/commercetools-import/src/Models/Importoperations/ImportOperationModel.php +++ b/lib/commercetools-import/src/Models/Importoperations/ImportOperationModel.php @@ -119,7 +119,7 @@ public function __construct( } /** - *The version of the ImportOperation.
+ *Current version of the ImportOperation.
* * * @return null|int @@ -139,7 +139,7 @@ public function getVersion() } /** - *The key of the ImportContainer.
+ *key of the ImportContainer.
The key of the resource.
+ *key of the resource being imported.
The ID of the ImportOperation.
+ *Unique identifier of the ImportOperation.
* * * @return null|string @@ -199,7 +199,7 @@ public function getId() } /** - *The import status of the resource. Set to rejected or validationFailed if the import of the resource was not successful.
The import status of the resource. If rejected or validationFailed, the import was unsuccessful.
The version of the imported resource when the import was successful.
+ *The version of the imported resource when the import was successful.
Contains an error if the import of the resource was not successful. See Errors.
+ *Contains errors if the import was unsuccessful. See Errors.
* * * @return null|ErrorObjectCollection @@ -259,7 +259,7 @@ public function getErrors() } /** - *In case of unresolved status this array will show the unresolved references
+ *If the resource being imported contains references to resources which do not exist, these references are contained within this array.
* * * @return null|UnresolvedReferencesCollection @@ -279,7 +279,7 @@ public function getUnresolvedReferences() } /** - *The time when the ImportOperation was created.
+ *Date and time (UTC) the ImportOperation was created.
* * * @return null|DateTimeImmutable @@ -303,7 +303,7 @@ public function getCreatedAt() } /** - *The last time When the ImportOperation was modified.
+ *Date and time (UTC) the ImportOperation was last updated.
* * * @return null|DateTimeImmutable @@ -327,7 +327,7 @@ public function getLastModifiedAt() } /** - *The expiration time of the ImportOperation.
+ *Date and time (UTC) the ImportOperation will be deleted.
* * * @return null|DateTimeImmutable diff --git a/lib/commercetools-import/src/Models/Importoperations/ImportOperationStatus.php b/lib/commercetools-import/src/Models/Importoperations/ImportOperationStatus.php index 76c7e047b5f..737e87c4e4c 100644 --- a/lib/commercetools-import/src/Models/Importoperations/ImportOperationStatus.php +++ b/lib/commercetools-import/src/Models/Importoperations/ImportOperationStatus.php @@ -19,7 +19,7 @@ interface ImportOperationStatus extends JsonObject public const FIELD_ERRORS = 'errors'; /** - *The ID of the ImportOperation.
+ *id of the ImportOperation.
The validation state of the ImportOperation.
+ *Validation state of the ImportOperation.
* * @return null|string @@ -35,8 +35,7 @@ public function getOperationId(); public function getState(); /** - *The validation errors for the ImportOperation. - * See Errors.
+ *Errors for the ImportOperation.
* * @return null|ErrorObjectCollection diff --git a/lib/commercetools-import/src/Models/Importoperations/ImportOperationStatusBuilder.php b/lib/commercetools-import/src/Models/Importoperations/ImportOperationStatusBuilder.php index 72815125964..80cc4d42c00 100644 --- a/lib/commercetools-import/src/Models/Importoperations/ImportOperationStatusBuilder.php +++ b/lib/commercetools-import/src/Models/Importoperations/ImportOperationStatusBuilder.php @@ -40,7 +40,7 @@ final class ImportOperationStatusBuilder implements Builder private $errors; /** - *The ID of the ImportOperation.
+ *id of the ImportOperation.
The validation state of the ImportOperation.
+ *Validation state of the ImportOperation.
* * @return null|string @@ -62,8 +62,7 @@ public function getState() } /** - *The validation errors for the ImportOperation. - * See Errors.
+ *Errors for the ImportOperation.
* * @return null|ErrorObjectCollection diff --git a/lib/commercetools-import/src/Models/Importoperations/ImportOperationStatusModel.php b/lib/commercetools-import/src/Models/Importoperations/ImportOperationStatusModel.php index 82455fcf61a..b9901fe0ae2 100644 --- a/lib/commercetools-import/src/Models/Importoperations/ImportOperationStatusModel.php +++ b/lib/commercetools-import/src/Models/Importoperations/ImportOperationStatusModel.php @@ -53,7 +53,7 @@ public function __construct( } /** - *The ID of the ImportOperation.
+ *id of the ImportOperation.
The validation state of the ImportOperation.
+ *Validation state of the ImportOperation.
* * * @return null|string @@ -93,8 +93,7 @@ public function getState() } /** - *The validation errors for the ImportOperation. - * See Errors.
+ *Errors for the ImportOperation.
* * * @return null|ErrorObjectCollection diff --git a/lib/commercetools-import/src/Models/Importrequests/ImportRequestModel.php b/lib/commercetools-import/src/Models/Importrequests/ImportRequestModel.php index 157ed8cdaac..91601cd3e30 100644 --- a/lib/commercetools-import/src/Models/Importrequests/ImportRequestModel.php +++ b/lib/commercetools-import/src/Models/Importrequests/ImportRequestModel.php @@ -40,6 +40,7 @@ final class ImportRequestModel extends JsonObjectModel implements ImportRequest 'price' => PriceImportRequestModel::class, 'product' => ProductImportRequestModel::class, 'product-draft' => ProductDraftImportRequestModel::class, + 'product-selection' => ProductSelectionImportRequestModel::class, 'product-type' => ProductTypeImportRequestModel::class, 'product-variant' => ProductVariantImportRequestModel::class, 'product-variant-patch' => ProductVariantPatchRequestModel::class, diff --git a/lib/commercetools-import/src/Models/Importrequests/ImportResponse.php b/lib/commercetools-import/src/Models/Importrequests/ImportResponse.php index 02314ec3425..0168577c9b3 100644 --- a/lib/commercetools-import/src/Models/Importrequests/ImportResponse.php +++ b/lib/commercetools-import/src/Models/Importrequests/ImportResponse.php @@ -17,7 +17,7 @@ interface ImportResponse extends JsonObject public const FIELD_OPERATION_STATUS = 'operationStatus'; /** - *A list of the ID's and validation statuses of new ImportOperations.
+ *The identifiers and status of the ImportOperations created by the ImportRequest.
* * @return null|ImportOperationStatusCollection diff --git a/lib/commercetools-import/src/Models/Importrequests/ImportResponseBuilder.php b/lib/commercetools-import/src/Models/Importrequests/ImportResponseBuilder.php index a7266cf2b80..a3192619253 100644 --- a/lib/commercetools-import/src/Models/Importrequests/ImportResponseBuilder.php +++ b/lib/commercetools-import/src/Models/Importrequests/ImportResponseBuilder.php @@ -28,7 +28,7 @@ final class ImportResponseBuilder implements Builder private $operationStatus; /** - *A list of the ID's and validation statuses of new ImportOperations.
+ *The identifiers and status of the ImportOperations created by the ImportRequest.
* * @return null|ImportOperationStatusCollection diff --git a/lib/commercetools-import/src/Models/Importrequests/ImportResponseModel.php b/lib/commercetools-import/src/Models/Importrequests/ImportResponseModel.php index 6768f7e7454..ab4149527b9 100644 --- a/lib/commercetools-import/src/Models/Importrequests/ImportResponseModel.php +++ b/lib/commercetools-import/src/Models/Importrequests/ImportResponseModel.php @@ -37,7 +37,7 @@ public function __construct( } /** - *A list of the ID's and validation statuses of new ImportOperations.
+ *The identifiers and status of the ImportOperations created by the ImportRequest.
* * * @return null|ImportOperationStatusCollection diff --git a/lib/commercetools-import/src/Models/Importrequests/ProductSelectionImportRequest.php b/lib/commercetools-import/src/Models/Importrequests/ProductSelectionImportRequest.php new file mode 100644 index 00000000000..15bd0506c7f --- /dev/null +++ b/lib/commercetools-import/src/Models/Importrequests/ProductSelectionImportRequest.php @@ -0,0 +1,31 @@ +The Product Selection import resources of this request. + * + + * @return null|ProductSelectionImportCollection + */ + public function getResources(); + + /** + * @param ?ProductSelectionImportCollection $resources + */ + public function setResources(?ProductSelectionImportCollection $resources): void; +} diff --git a/lib/commercetools-import/src/Models/Importrequests/ProductSelectionImportRequestBuilder.php b/lib/commercetools-import/src/Models/Importrequests/ProductSelectionImportRequestBuilder.php new file mode 100644 index 00000000000..3dbc872e24e --- /dev/null +++ b/lib/commercetools-import/src/Models/Importrequests/ProductSelectionImportRequestBuilder.php @@ -0,0 +1,64 @@ + + */ +final class ProductSelectionImportRequestBuilder implements Builder +{ + /** + + * @var ?ProductSelectionImportCollection + */ + private $resources; + + /** + *The Product Selection import resources of this request.
+ * + + * @return null|ProductSelectionImportCollection + */ + public function getResources() + { + return $this->resources; + } + + /** + * @param ?ProductSelectionImportCollection $resources + * @return $this + */ + public function withResources(?ProductSelectionImportCollection $resources) + { + $this->resources = $resources; + + return $this; + } + + + public function build(): ProductSelectionImportRequest + { + return new ProductSelectionImportRequestModel( + $this->resources + ); + } + + public static function of(): ProductSelectionImportRequestBuilder + { + return new self(); + } +} diff --git a/lib/commercetools-import/src/Models/Importrequests/ProductSelectionImportRequestCollection.php b/lib/commercetools-import/src/Models/Importrequests/ProductSelectionImportRequestCollection.php new file mode 100644 index 00000000000..32704f3a2ec --- /dev/null +++ b/lib/commercetools-import/src/Models/Importrequests/ProductSelectionImportRequestCollection.php @@ -0,0 +1,56 @@ + + * @method ProductSelectionImportRequest current() + * @method ProductSelectionImportRequest end() + * @method ProductSelectionImportRequest at($offset) + */ +class ProductSelectionImportRequestCollection extends ImportRequestCollection +{ + /** + * @psalm-assert ProductSelectionImportRequest $value + * @psalm-param ProductSelectionImportRequest|stdClass $value + * @throws InvalidArgumentException + * + * @return ProductSelectionImportRequestCollection + */ + public function add($value) + { + if (!$value instanceof ProductSelectionImportRequest) { + throw new InvalidArgumentException(); + } + $this->store($value); + + return $this; + } + + /** + * @psalm-return callable(int):?ProductSelectionImportRequest + */ + protected function mapper() + { + return function (?int $index): ?ProductSelectionImportRequest { + $data = $this->get($index); + if ($data instanceof stdClass) { + /** @var ProductSelectionImportRequest $data */ + $data = ProductSelectionImportRequestModel::of($data); + $this->set($data, $index); + } + + return $data; + }; + } +} diff --git a/lib/commercetools-import/src/Models/Importrequests/ProductSelectionImportRequestModel.php b/lib/commercetools-import/src/Models/Importrequests/ProductSelectionImportRequestModel.php new file mode 100644 index 00000000000..4a56f9dd5c9 --- /dev/null +++ b/lib/commercetools-import/src/Models/Importrequests/ProductSelectionImportRequestModel.php @@ -0,0 +1,96 @@ +resources = $resources; + $this->type = $type ?? self::DISCRIMINATOR_VALUE; + } + + /** + *The resource types that can be imported.
+ * + * + * @return null|string + */ + public function getType() + { + if (is_null($this->type)) { + /** @psalm-var ?string $data */ + $data = $this->raw(self::FIELD_TYPE); + if (is_null($data)) { + return null; + } + $this->type = (string) $data; + } + + return $this->type; + } + + /** + *The Product Selection import resources of this request.
+ * + * + * @return null|ProductSelectionImportCollection + */ + public function getResources() + { + if (is_null($this->resources)) { + /** @psalm-var ?listThe import status of an ImportContainer given by the number of resources in each ProcessingState.
+ *The current ProcessingStates of ImportOperations in an ImportContainer.
* * @return null|OperationStates @@ -25,7 +25,7 @@ interface ImportSummary extends JsonObject public function getStates(); /** - *The total number of ImportOperations received for this Import Summary.
+ *The total number of ImportOperations in states.
The import status of an ImportContainer given by the number of resources in each ProcessingState.
+ *The current ProcessingStates of ImportOperations in an ImportContainer.
* * @return null|OperationStates @@ -44,7 +44,7 @@ public function getStates() } /** - *The total number of ImportOperations received for this Import Summary.
+ *The total number of ImportOperations in states.
The import status of an ImportContainer given by the number of resources in each ProcessingState.
+ *The current ProcessingStates of ImportOperations in an ImportContainer.
* * * @return null|OperationStates @@ -65,7 +65,7 @@ public function getStates() } /** - *The total number of ImportOperations received for this Import Summary.
+ *The total number of ImportOperations in states.
The number of resources in the processing state.
The number of ImportOperations in the processing state.
The number of resources in the validationFailed state.
The number of ImportOperations in the validationFailed state.
The number of resources in the unresolved state.
The number of ImportOperations in the unresolved state.
The number of resources in the waitForMasterVariant state.
The number of ImportOperations in the waitForMasterVariant state.
The number of resources in the imported state.
The number of ImportOperations in the imported state.
The number of resources in the rejected state.
The number of ImportOperations in the rejected state.
The number of resources in the canceled state.
The number of ImportOperations in the canceled state.
The number of resources in the processing state.
The number of ImportOperations in the processing state.
The number of resources in the validationFailed state.
The number of ImportOperations in the validationFailed state.
The number of resources in the unresolved state.
The number of ImportOperations in the unresolved state.
The number of resources in the waitForMasterVariant state.
The number of ImportOperations in the waitForMasterVariant state.
The number of resources in the imported state.
The number of ImportOperations in the imported state.
The number of resources in the rejected state.
The number of ImportOperations in the rejected state.
The number of resources in the canceled state.
The number of ImportOperations in the canceled state.
The number of resources in the processing state.
The number of ImportOperations in the processing state.
The number of resources in the validationFailed state.
The number of ImportOperations in the validationFailed state.
The number of resources in the unresolved state.
The number of ImportOperations in the unresolved state.
The number of resources in the waitForMasterVariant state.
The number of ImportOperations in the waitForMasterVariant state.
The number of resources in the imported state.
The number of ImportOperations in the imported state.
The number of resources in the rejected state.
The number of ImportOperations in the rejected state.
The number of resources in the canceled state.
The number of ImportOperations in the canceled state.
User-defined unique identifier. If an InventoryEntry with this key exists, it will be updated with the imported data.
User-defined unique identifier. If an InventoryEntry with this key exists, it is updated with the imported data.
Maps to Inventory.sku
Maps to InventoryEntry.sku
Maps to Inventory.quantityOnStock
Maps to InventoryEntry.quantityOnStock
Maps to Inventory.restockableInDays
Maps to InventoryEntry.restockableInDays
Maps to Inventory.expectedDelivery
Maps to InventoryEntry.expectedDelivery
Maps to Inventory.supplyChannel
Maps to InventoryEntry.supplyChannel. If the referenced Channel does not exist, the state of the ImportOperation will be set to unresolved until the referenced Channel is created.
Maps to Inventory.custom.
Maps to InventoryEntry.custom.
User-defined unique identifier. If an InventoryEntry with this key exists, it will be updated with the imported data.
User-defined unique identifier. If an InventoryEntry with this key exists, it is updated with the imported data.
Maps to Inventory.sku
Maps to InventoryEntry.sku
Maps to Inventory.quantityOnStock
Maps to InventoryEntry.quantityOnStock
Maps to Inventory.restockableInDays
Maps to InventoryEntry.restockableInDays
Maps to Inventory.expectedDelivery
Maps to InventoryEntry.expectedDelivery
Maps to Inventory.supplyChannel
Maps to InventoryEntry.supplyChannel. If the referenced Channel does not exist, the state of the ImportOperation will be set to unresolved until the referenced Channel is created.
Maps to Inventory.custom.
Maps to InventoryEntry.custom.
User-defined unique identifier. If an InventoryEntry with this key exists, it will be updated with the imported data.
User-defined unique identifier. If an InventoryEntry with this key exists, it is updated with the imported data.
Maps to Inventory.sku
Maps to InventoryEntry.sku
Maps to Inventory.quantityOnStock
Maps to InventoryEntry.quantityOnStock
Maps to Inventory.restockableInDays
Maps to InventoryEntry.restockableInDays
Maps to Inventory.expectedDelivery
Maps to InventoryEntry.expectedDelivery
Maps to Inventory.supplyChannel
Maps to InventoryEntry.supplyChannel. If the referenced Channel does not exist, the state of the ImportOperation will be set to unresolved until the referenced Channel is created.
Maps to Inventory.custom.
Maps to InventoryEntry.custom.
Unique identifier of the Delivery.
+ * * @return null|string */ public function getDeliveryId(); /** + *Address to which Parcels are delivered.
+ * * @return null|Address */ diff --git a/lib/commercetools-import/src/Models/OrderPatches/DeliveryAddressDraftBuilder.php b/lib/commercetools-import/src/Models/OrderPatches/DeliveryAddressDraftBuilder.php index 84153dc3695..abbf7ba4738 100644 --- a/lib/commercetools-import/src/Models/OrderPatches/DeliveryAddressDraftBuilder.php +++ b/lib/commercetools-import/src/Models/OrderPatches/DeliveryAddressDraftBuilder.php @@ -35,6 +35,8 @@ final class DeliveryAddressDraftBuilder implements Builder private $address; /** + *Unique identifier of the Delivery.
+ * * @return null|string */ @@ -44,6 +46,8 @@ public function getDeliveryId() } /** + *Address to which Parcels are delivered.
+ * * @return null|Address */ diff --git a/lib/commercetools-import/src/Models/OrderPatches/DeliveryAddressDraftModel.php b/lib/commercetools-import/src/Models/OrderPatches/DeliveryAddressDraftModel.php index 60097b2ca8b..13c6d76f7e8 100644 --- a/lib/commercetools-import/src/Models/OrderPatches/DeliveryAddressDraftModel.php +++ b/lib/commercetools-import/src/Models/OrderPatches/DeliveryAddressDraftModel.php @@ -46,6 +46,8 @@ public function __construct( } /** + *Unique identifier of the Delivery.
+ * * * @return null|string */ @@ -64,6 +66,8 @@ public function getDeliveryId() } /** + *Address to which Parcels are delivered.
+ * * * @return null|Address */ diff --git a/lib/commercetools-import/src/Models/OrderPatches/DeliveryDraft.php b/lib/commercetools-import/src/Models/OrderPatches/DeliveryDraft.php index 4fa72d3c3e9..7a9d0f69c74 100644 --- a/lib/commercetools-import/src/Models/OrderPatches/DeliveryDraft.php +++ b/lib/commercetools-import/src/Models/OrderPatches/DeliveryDraft.php @@ -20,18 +20,24 @@ interface DeliveryDraft extends JsonObject public const FIELD_PARCELS = 'parcels'; /** + *Line Items or Custom Line Items to deliver. It can also be specified individually for each Parcel.
+ * * @return null|DeliveryItemCollection */ public function getItems(); /** + *Address to which the Parcels are delivered.
+ * * @return null|Address */ public function getAddress(); /** + *Information regarding the appearance, content, and shipment of a parcel.
+ * * @return null|DeliveryParcelDraftCollection */ diff --git a/lib/commercetools-import/src/Models/OrderPatches/DeliveryDraftBuilder.php b/lib/commercetools-import/src/Models/OrderPatches/DeliveryDraftBuilder.php index fe7e89b6c29..8d9a66c0978 100644 --- a/lib/commercetools-import/src/Models/OrderPatches/DeliveryDraftBuilder.php +++ b/lib/commercetools-import/src/Models/OrderPatches/DeliveryDraftBuilder.php @@ -42,6 +42,8 @@ final class DeliveryDraftBuilder implements Builder private $parcels; /** + *Line Items or Custom Line Items to deliver. It can also be specified individually for each Parcel.
+ * * @return null|DeliveryItemCollection */ @@ -51,6 +53,8 @@ public function getItems() } /** + *Address to which the Parcels are delivered.
+ * * @return null|Address */ @@ -60,6 +64,8 @@ public function getAddress() } /** + *Information regarding the appearance, content, and shipment of a parcel.
+ * * @return null|DeliveryParcelDraftCollection */ diff --git a/lib/commercetools-import/src/Models/OrderPatches/DeliveryDraftModel.php b/lib/commercetools-import/src/Models/OrderPatches/DeliveryDraftModel.php index 40256d13bc9..e89e8c6c238 100644 --- a/lib/commercetools-import/src/Models/OrderPatches/DeliveryDraftModel.php +++ b/lib/commercetools-import/src/Models/OrderPatches/DeliveryDraftModel.php @@ -55,6 +55,8 @@ public function __construct( } /** + *Line Items or Custom Line Items to deliver. It can also be specified individually for each Parcel.
+ * * * @return null|DeliveryItemCollection */ @@ -73,6 +75,8 @@ public function getItems() } /** + *Address to which the Parcels are delivered.
+ * * * @return null|Address */ @@ -92,6 +96,8 @@ public function getAddress() } /** + *Information regarding the appearance, content, and shipment of a parcel.
+ * * * @return null|DeliveryParcelDraftCollection */ diff --git a/lib/commercetools-import/src/Models/OrderPatches/DeliveryParcel.php b/lib/commercetools-import/src/Models/OrderPatches/DeliveryParcel.php index a9e9797054c..2bd0e3193db 100644 --- a/lib/commercetools-import/src/Models/OrderPatches/DeliveryParcel.php +++ b/lib/commercetools-import/src/Models/OrderPatches/DeliveryParcel.php @@ -22,24 +22,32 @@ interface DeliveryParcel extends JsonObject public const FIELD_ITEMS = 'items'; /** + *Unique identifier of the Delivery.
+ * * @return null|string */ public function getDeliveryId(); /** + *Information about the dimensions of the Parcel.
+ * * @return null|ParcelMeasurements */ public function getMeasurements(); /** + *Shipment tracking information of the Parcel.
+ * * @return null|TrackingData */ public function getTrackingData(); /** + *Line Items or Custom Line Items delivered in this Parcel.
+ * * @return null|DeliveryItemCollection */ diff --git a/lib/commercetools-import/src/Models/OrderPatches/DeliveryParcelBuilder.php b/lib/commercetools-import/src/Models/OrderPatches/DeliveryParcelBuilder.php index 09103fb10a0..65793f25a99 100644 --- a/lib/commercetools-import/src/Models/OrderPatches/DeliveryParcelBuilder.php +++ b/lib/commercetools-import/src/Models/OrderPatches/DeliveryParcelBuilder.php @@ -50,6 +50,8 @@ final class DeliveryParcelBuilder implements Builder private $items; /** + *Unique identifier of the Delivery.
+ * * @return null|string */ @@ -59,6 +61,8 @@ public function getDeliveryId() } /** + *Information about the dimensions of the Parcel.
+ * * @return null|ParcelMeasurements */ @@ -68,6 +72,8 @@ public function getMeasurements() } /** + *Shipment tracking information of the Parcel.
+ * * @return null|TrackingData */ @@ -77,6 +83,8 @@ public function getTrackingData() } /** + *Line Items or Custom Line Items delivered in this Parcel.
+ * * @return null|DeliveryItemCollection */ diff --git a/lib/commercetools-import/src/Models/OrderPatches/DeliveryParcelDraft.php b/lib/commercetools-import/src/Models/OrderPatches/DeliveryParcelDraft.php index 0f8dbd6a24a..35fcc75390f 100644 --- a/lib/commercetools-import/src/Models/OrderPatches/DeliveryParcelDraft.php +++ b/lib/commercetools-import/src/Models/OrderPatches/DeliveryParcelDraft.php @@ -21,18 +21,24 @@ interface DeliveryParcelDraft extends JsonObject public const FIELD_ITEMS = 'items'; /** + *Information about the dimensions for the Parcel.
+ * * @return null|ParcelMeasurements */ public function getMeasurements(); /** + *Shipment tracking information for the Parcel.
+ * * @return null|TrackingData */ public function getTrackingData(); /** + *Line Items or Custom Line Items delivered in this Parcel.
+ * * @return null|DeliveryItemCollection */ diff --git a/lib/commercetools-import/src/Models/OrderPatches/DeliveryParcelDraftBuilder.php b/lib/commercetools-import/src/Models/OrderPatches/DeliveryParcelDraftBuilder.php index 9cc0c3bea9b..0dc574a577c 100644 --- a/lib/commercetools-import/src/Models/OrderPatches/DeliveryParcelDraftBuilder.php +++ b/lib/commercetools-import/src/Models/OrderPatches/DeliveryParcelDraftBuilder.php @@ -44,6 +44,8 @@ final class DeliveryParcelDraftBuilder implements Builder private $items; /** + *Information about the dimensions for the Parcel.
+ * * @return null|ParcelMeasurements */ @@ -53,6 +55,8 @@ public function getMeasurements() } /** + *Shipment tracking information for the Parcel.
+ * * @return null|TrackingData */ @@ -62,6 +66,8 @@ public function getTrackingData() } /** + *Line Items or Custom Line Items delivered in this Parcel.
+ * * @return null|DeliveryItemCollection */ diff --git a/lib/commercetools-import/src/Models/OrderPatches/DeliveryParcelDraftModel.php b/lib/commercetools-import/src/Models/OrderPatches/DeliveryParcelDraftModel.php index b76ef9ae253..2165f5adb17 100644 --- a/lib/commercetools-import/src/Models/OrderPatches/DeliveryParcelDraftModel.php +++ b/lib/commercetools-import/src/Models/OrderPatches/DeliveryParcelDraftModel.php @@ -57,6 +57,8 @@ public function __construct( } /** + *Information about the dimensions for the Parcel.
+ * * * @return null|ParcelMeasurements */ @@ -76,6 +78,8 @@ public function getMeasurements() } /** + *Shipment tracking information for the Parcel.
+ * * * @return null|TrackingData */ @@ -95,6 +99,8 @@ public function getTrackingData() } /** + *Line Items or Custom Line Items delivered in this Parcel.
+ * * * @return null|DeliveryItemCollection */ diff --git a/lib/commercetools-import/src/Models/OrderPatches/DeliveryParcelModel.php b/lib/commercetools-import/src/Models/OrderPatches/DeliveryParcelModel.php index 9dd46de032c..0f47f8539a9 100644 --- a/lib/commercetools-import/src/Models/OrderPatches/DeliveryParcelModel.php +++ b/lib/commercetools-import/src/Models/OrderPatches/DeliveryParcelModel.php @@ -65,6 +65,8 @@ public function __construct( } /** + *Unique identifier of the Delivery.
+ * * * @return null|string */ @@ -83,6 +85,8 @@ public function getDeliveryId() } /** + *Information about the dimensions of the Parcel.
+ * * * @return null|ParcelMeasurements */ @@ -102,6 +106,8 @@ public function getMeasurements() } /** + *Shipment tracking information of the Parcel.
+ * * * @return null|TrackingData */ @@ -121,6 +127,8 @@ public function getTrackingData() } /** + *Line Items or Custom Line Items delivered in this Parcel.
+ * * * @return null|DeliveryItemCollection */ diff --git a/lib/commercetools-import/src/Models/OrderPatches/OrderPatchImport.php b/lib/commercetools-import/src/Models/OrderPatches/OrderPatchImport.php index a8165bc6275..58b85514cb7 100644 --- a/lib/commercetools-import/src/Models/OrderPatches/OrderPatchImport.php +++ b/lib/commercetools-import/src/Models/OrderPatches/OrderPatchImport.php @@ -17,7 +17,7 @@ interface OrderPatchImport extends JsonObject public const FIELD_FIELDS = 'fields'; /** - *Maps to Order.orderNumber, String that uniquely identifies an order, unique across a project.
User-defined unique identifier. If an Order with this orderNumber exists, it is updated with the imported data.
Each field referenced must be defined in an already existing order in the project or the import operation state is set to validationFailed.
Each field referenced must be defined in an existing Order or the ImportOperationState is set to validationFailed.
Maps to Order.orderNumber, String that uniquely identifies an order, unique across a project.
User-defined unique identifier. If an Order with this orderNumber exists, it is updated with the imported data.
Each field referenced must be defined in an already existing order in the project or the import operation state is set to validationFailed.
Each field referenced must be defined in an existing Order or the ImportOperationState is set to validationFailed.
Maps to Order.orderNumber, String that uniquely identifies an order, unique across a project.
User-defined unique identifier. If an Order with this orderNumber exists, it is updated with the imported data.
Each field referenced must be defined in an already existing order in the project or the import operation state is set to validationFailed.
Each field referenced must be defined in an existing Order or the ImportOperationState is set to validationFailed.
id of an existing Parcel.
Items in the Parcel.
+ * * @return null|DeliveryItemCollection */ diff --git a/lib/commercetools-import/src/Models/OrderPatches/ParcelItemsBuilder.php b/lib/commercetools-import/src/Models/OrderPatches/ParcelItemsBuilder.php index 566876c72db..0a52d3f8726 100644 --- a/lib/commercetools-import/src/Models/OrderPatches/ParcelItemsBuilder.php +++ b/lib/commercetools-import/src/Models/OrderPatches/ParcelItemsBuilder.php @@ -34,6 +34,8 @@ final class ParcelItemsBuilder implements Builder private $items; /** + *id of an existing Parcel.
Items in the Parcel.
+ * * @return null|DeliveryItemCollection */ diff --git a/lib/commercetools-import/src/Models/OrderPatches/ParcelItemsModel.php b/lib/commercetools-import/src/Models/OrderPatches/ParcelItemsModel.php index 3d206df7010..cd17be1bc16 100644 --- a/lib/commercetools-import/src/Models/OrderPatches/ParcelItemsModel.php +++ b/lib/commercetools-import/src/Models/OrderPatches/ParcelItemsModel.php @@ -45,6 +45,8 @@ public function __construct( } /** + *id of an existing Parcel.
Items in the Parcel.
+ * * * @return null|DeliveryItemCollection */ diff --git a/lib/commercetools-import/src/Models/OrderPatches/ParcelMeasurementDraft.php b/lib/commercetools-import/src/Models/OrderPatches/ParcelMeasurementDraft.php index 81b51217c3a..8392bbf3a0e 100644 --- a/lib/commercetools-import/src/Models/OrderPatches/ParcelMeasurementDraft.php +++ b/lib/commercetools-import/src/Models/OrderPatches/ParcelMeasurementDraft.php @@ -18,12 +18,16 @@ interface ParcelMeasurementDraft extends JsonObject public const FIELD_MEASUREMENTS = 'measurements'; /** + *id of an existing Parcel.
Information about the dimensions of the Parcel.
+ * * @return null|ParcelMeasurements */ diff --git a/lib/commercetools-import/src/Models/OrderPatches/ParcelMeasurementDraftBuilder.php b/lib/commercetools-import/src/Models/OrderPatches/ParcelMeasurementDraftBuilder.php index 954e99a1cc2..0a26071bcbd 100644 --- a/lib/commercetools-import/src/Models/OrderPatches/ParcelMeasurementDraftBuilder.php +++ b/lib/commercetools-import/src/Models/OrderPatches/ParcelMeasurementDraftBuilder.php @@ -35,6 +35,8 @@ final class ParcelMeasurementDraftBuilder implements Builder private $measurements; /** + *id of an existing Parcel.
Information about the dimensions of the Parcel.
+ * * @return null|ParcelMeasurements */ diff --git a/lib/commercetools-import/src/Models/OrderPatches/ParcelMeasurementDraftModel.php b/lib/commercetools-import/src/Models/OrderPatches/ParcelMeasurementDraftModel.php index 3f14664d03b..507b1fdc08e 100644 --- a/lib/commercetools-import/src/Models/OrderPatches/ParcelMeasurementDraftModel.php +++ b/lib/commercetools-import/src/Models/OrderPatches/ParcelMeasurementDraftModel.php @@ -46,6 +46,8 @@ public function __construct( } /** + *id of an existing Parcel.
Information about the dimensions of the Parcel.
+ * * * @return null|ParcelMeasurements */ diff --git a/lib/commercetools-import/src/Models/OrderPatches/ParcelTrackingData.php b/lib/commercetools-import/src/Models/OrderPatches/ParcelTrackingData.php index d0503902aae..5b9bf484a41 100644 --- a/lib/commercetools-import/src/Models/OrderPatches/ParcelTrackingData.php +++ b/lib/commercetools-import/src/Models/OrderPatches/ParcelTrackingData.php @@ -18,12 +18,16 @@ interface ParcelTrackingData extends JsonObject public const FIELD_TRACKING_DATA = 'trackingData'; /** + *id of an existing Parcel.
Information that helps track a Parcel.
+ * * @return null|TrackingData */ diff --git a/lib/commercetools-import/src/Models/OrderPatches/ParcelTrackingDataBuilder.php b/lib/commercetools-import/src/Models/OrderPatches/ParcelTrackingDataBuilder.php index 0b6729ac6c4..e40ab262d85 100644 --- a/lib/commercetools-import/src/Models/OrderPatches/ParcelTrackingDataBuilder.php +++ b/lib/commercetools-import/src/Models/OrderPatches/ParcelTrackingDataBuilder.php @@ -35,6 +35,8 @@ final class ParcelTrackingDataBuilder implements Builder private $trackingData; /** + *id of an existing Parcel.
Information that helps track a Parcel.
+ * * @return null|TrackingData */ diff --git a/lib/commercetools-import/src/Models/OrderPatches/ParcelTrackingDataModel.php b/lib/commercetools-import/src/Models/OrderPatches/ParcelTrackingDataModel.php index 35c85517f1f..b77622d9032 100644 --- a/lib/commercetools-import/src/Models/OrderPatches/ParcelTrackingDataModel.php +++ b/lib/commercetools-import/src/Models/OrderPatches/ParcelTrackingDataModel.php @@ -46,6 +46,8 @@ public function __construct( } /** + *id of an existing Parcel.
Information that helps track a Parcel.
+ * * * @return null|TrackingData */ diff --git a/lib/commercetools-import/src/Models/OrderPatches/RemoveParcelFromDeliveryDraft.php b/lib/commercetools-import/src/Models/OrderPatches/RemoveParcelFromDeliveryDraft.php index 2ce1e602c63..6b69a8a3106 100644 --- a/lib/commercetools-import/src/Models/OrderPatches/RemoveParcelFromDeliveryDraft.php +++ b/lib/commercetools-import/src/Models/OrderPatches/RemoveParcelFromDeliveryDraft.php @@ -16,6 +16,8 @@ interface RemoveParcelFromDeliveryDraft extends JsonObject public const FIELD_PARCEL_ID = 'parcelId'; /** + *id of the Parcel to be removed from the Delivery.
id of the Parcel to be removed from the Delivery.
id of the Parcel to be removed from the Delivery.
Information on the Line Items or Custom Line Items returned.
+ * * @return null|ReturnItemDraftCollection */ public function getItems(); /** - *Maps to ReturnInfo.returnTrackingId
User-defined identifier to track the return.
* * @return null|string @@ -33,7 +35,7 @@ public function getItems(); public function getReturnTrackingId(); /** - *Maps to ReturnInfo.returnDate
Date and time (UTC) the return is initiated.
* * @return null|DateTimeImmutable diff --git a/lib/commercetools-import/src/Models/OrderPatches/ReturnInfoBuilder.php b/lib/commercetools-import/src/Models/OrderPatches/ReturnInfoBuilder.php index e41015d110c..7e16e0ac4e3 100644 --- a/lib/commercetools-import/src/Models/OrderPatches/ReturnInfoBuilder.php +++ b/lib/commercetools-import/src/Models/OrderPatches/ReturnInfoBuilder.php @@ -40,6 +40,8 @@ final class ReturnInfoBuilder implements Builder private $returnDate; /** + *Information on the Line Items or Custom Line Items returned.
+ * * @return null|ReturnItemDraftCollection */ @@ -49,7 +51,7 @@ public function getItems() } /** - *Maps to ReturnInfo.returnTrackingId
User-defined identifier to track the return.
* * @return null|string @@ -60,7 +62,7 @@ public function getReturnTrackingId() } /** - *Maps to ReturnInfo.returnDate
Date and time (UTC) the return is initiated.
* * @return null|DateTimeImmutable diff --git a/lib/commercetools-import/src/Models/OrderPatches/ReturnInfoModel.php b/lib/commercetools-import/src/Models/OrderPatches/ReturnInfoModel.php index 9bb07f31cf3..1bd637f85a3 100644 --- a/lib/commercetools-import/src/Models/OrderPatches/ReturnInfoModel.php +++ b/lib/commercetools-import/src/Models/OrderPatches/ReturnInfoModel.php @@ -53,6 +53,8 @@ public function __construct( } /** + *Information on the Line Items or Custom Line Items returned.
+ * * * @return null|ReturnItemDraftCollection */ @@ -71,7 +73,7 @@ public function getItems() } /** - *Maps to ReturnInfo.returnTrackingId
User-defined identifier to track the return.
* * * @return null|string @@ -91,7 +93,7 @@ public function getReturnTrackingId() } /** - *Maps to ReturnInfo.returnDate
Date and time (UTC) the return is initiated.
* * * @return null|DateTimeImmutable diff --git a/lib/commercetools-import/src/Models/OrderPatches/ReturnItemDraft.php b/lib/commercetools-import/src/Models/OrderPatches/ReturnItemDraft.php index b5f079e2eed..0084e8a82f0 100644 --- a/lib/commercetools-import/src/Models/OrderPatches/ReturnItemDraft.php +++ b/lib/commercetools-import/src/Models/OrderPatches/ReturnItemDraft.php @@ -20,31 +20,41 @@ interface ReturnItemDraft extends JsonObject public const FIELD_SHIPMENT_STATE = 'shipmentState'; /** + *Number of Line Items or Custom Line Items to return.
+ * * @return null|int */ public function getQuantity(); /** + *id of the LineItem to return.
Required if Line Items are returned, to create a LineItemReturnItem.
+ * * @return null|string */ public function getLineItemId(); /** + *id of the CustomLineItem to return.
Required if Custom Line Items are returned, to create a CustomLineItemReturnItem.
+ * * @return null|string */ public function getCustomLineItemId(); /** + *User-defined description for the return.
+ * * @return null|string */ public function getComment(); /** - *Maps to ReturnItem.shipmentState
Shipment status of the item to be returned.
* * @return null|string diff --git a/lib/commercetools-import/src/Models/OrderPatches/ReturnItemDraftBuilder.php b/lib/commercetools-import/src/Models/OrderPatches/ReturnItemDraftBuilder.php index 06b49f538b1..ee8813a6add 100644 --- a/lib/commercetools-import/src/Models/OrderPatches/ReturnItemDraftBuilder.php +++ b/lib/commercetools-import/src/Models/OrderPatches/ReturnItemDraftBuilder.php @@ -51,6 +51,8 @@ final class ReturnItemDraftBuilder implements Builder private $shipmentState; /** + *Number of Line Items or Custom Line Items to return.
+ * * @return null|int */ @@ -60,6 +62,9 @@ public function getQuantity() } /** + *id of the LineItem to return.
Required if Line Items are returned, to create a LineItemReturnItem.
+ * * @return null|string */ @@ -69,6 +74,9 @@ public function getLineItemId() } /** + *id of the CustomLineItem to return.
Required if Custom Line Items are returned, to create a CustomLineItemReturnItem.
+ * * @return null|string */ @@ -78,6 +86,8 @@ public function getCustomLineItemId() } /** + *User-defined description for the return.
+ * * @return null|string */ @@ -87,7 +97,7 @@ public function getComment() } /** - *Maps to ReturnItem.shipmentState
Shipment status of the item to be returned.
* * @return null|string diff --git a/lib/commercetools-import/src/Models/OrderPatches/ReturnItemDraftModel.php b/lib/commercetools-import/src/Models/OrderPatches/ReturnItemDraftModel.php index 89dc6a7490f..ba4356d58cb 100644 --- a/lib/commercetools-import/src/Models/OrderPatches/ReturnItemDraftModel.php +++ b/lib/commercetools-import/src/Models/OrderPatches/ReturnItemDraftModel.php @@ -68,6 +68,8 @@ public function __construct( } /** + *Number of Line Items or Custom Line Items to return.
+ * * * @return null|int */ @@ -86,6 +88,9 @@ public function getQuantity() } /** + *id of the LineItem to return.
Required if Line Items are returned, to create a LineItemReturnItem.
+ * * * @return null|string */ @@ -104,6 +109,9 @@ public function getLineItemId() } /** + *id of the CustomLineItem to return.
Required if Custom Line Items are returned, to create a CustomLineItemReturnItem.
+ * * * @return null|string */ @@ -122,6 +130,8 @@ public function getCustomLineItemId() } /** + *User-defined description for the return.
+ * * * @return null|string */ @@ -140,7 +150,7 @@ public function getComment() } /** - *Maps to ReturnItem.shipmentState
Shipment status of the item to be returned.
* * * @return null|string diff --git a/lib/commercetools-import/src/Models/Orders/CustomLineItemDraft.php b/lib/commercetools-import/src/Models/Orders/CustomLineItemDraft.php index d86db31d1c6..d264fd08ad4 100644 --- a/lib/commercetools-import/src/Models/Orders/CustomLineItemDraft.php +++ b/lib/commercetools-import/src/Models/Orders/CustomLineItemDraft.php @@ -31,12 +31,7 @@ interface CustomLineItemDraft extends JsonObject public const FIELD_SHIPPING_DETAILS = 'shippingDetails'; /** - *A localized string is a JSON object where the keys are of IETF language tag, and the values the corresponding strings used for that language.
- *{
- * "de": "Hundefutter",
- * "en": "dog food"
- * }
- *
+ * Maps to CustomLineItem.name.
Maps to CustomLineItem.money.
Maps to CustomLineItem.taxedPrice.
Maps to CustomLineItem.totalPrice.
Maps to CustomLineItem.slug.
Maps to CustomLineItem.quantity.
Maps to CustomLineItem.state.
References a tax category by key.
+ *Maps to CustomLineItem.taxCategory. References a tax category by key. If the referenced TaxCategory does not exist, the state of the ImportOperation will be set to unresolved until the referenced TaxCategory is created.
Maps to CustomLineItem.taxRate.
External Tax Rate for the Custom Line Item if the Cart has the External TaxMode.
Maps to CustomLineItem.discountedPricePerQuantity.
Maps to CustomLineItem.shippingDetails.
A localized string is a JSON object where the keys are of IETF language tag, and the values the corresponding strings used for that language.
- *{
- * "de": "Hundefutter",
- * "en": "dog food"
- * }
- *
+ * Maps to CustomLineItem.name.
Maps to CustomLineItem.money.
Maps to CustomLineItem.taxedPrice.
Maps to CustomLineItem.totalPrice.
Maps to CustomLineItem.slug.
Maps to CustomLineItem.quantity.
Maps to CustomLineItem.state.
References a tax category by key.
+ *Maps to CustomLineItem.taxCategory. References a tax category by key. If the referenced TaxCategory does not exist, the state of the ImportOperation will be set to unresolved until the referenced TaxCategory is created.
Maps to CustomLineItem.taxRate.
External Tax Rate for the Custom Line Item if the Cart has the External TaxMode.
Maps to CustomLineItem.discountedPricePerQuantity.
Maps to CustomLineItem.shippingDetails.
A localized string is a JSON object where the keys are of IETF language tag, and the values the corresponding strings used for that language.
- *{
- * "de": "Hundefutter",
- * "en": "dog food"
- * }
- *
+ * Maps to CustomLineItem.name.
Maps to CustomLineItem.money.
Maps to CustomLineItem.taxedPrice.
Maps to CustomLineItem.totalPrice.
Maps to CustomLineItem.slug.
Maps to CustomLineItem.quantity.
Maps to CustomLineItem.state.
References a tax category by key.
+ *Maps to CustomLineItem.taxCategory. References a tax category by key. If the referenced TaxCategory does not exist, the state of the ImportOperation will be set to unresolved until the referenced TaxCategory is created.
Maps to CustomLineItem.taxRate.
External Tax Rate for the Custom Line Item if the Cart has the External TaxMode.
Maps to CustomLineItem.discountedPricePerQuantity.
Maps to CustomLineItem.shippingDetails.
Unique identifier of the Delivery.
+ * * @return null|string */ public function getId(); /** + *Date and time (UTC) the Delivery was created.
+ * * @return null|DateTimeImmutable */ public function getCreatedAt(); /** + *Line Items or Custom Line Items that are delivered.
+ * * @return null|DeliveryItemCollection */ public function getItems(); /** + *Information regarding the appearance, content, and shipment of a Parcel.
+ * * @return null|ParcelCollection */ public function getParcels(); /** + *Address to which Parcels are delivered.
+ * * @return null|Address */ diff --git a/lib/commercetools-import/src/Models/Orders/DeliveryBuilder.php b/lib/commercetools-import/src/Models/Orders/DeliveryBuilder.php index a510f81c3ec..251079e14b0 100644 --- a/lib/commercetools-import/src/Models/Orders/DeliveryBuilder.php +++ b/lib/commercetools-import/src/Models/Orders/DeliveryBuilder.php @@ -54,6 +54,8 @@ final class DeliveryBuilder implements Builder private $address; /** + *Unique identifier of the Delivery.
+ * * @return null|string */ @@ -63,6 +65,8 @@ public function getId() } /** + *Date and time (UTC) the Delivery was created.
+ * * @return null|DateTimeImmutable */ @@ -72,6 +76,8 @@ public function getCreatedAt() } /** + *Line Items or Custom Line Items that are delivered.
+ * * @return null|DeliveryItemCollection */ @@ -81,6 +87,8 @@ public function getItems() } /** + *Information regarding the appearance, content, and shipment of a Parcel.
+ * * @return null|ParcelCollection */ @@ -90,6 +98,8 @@ public function getParcels() } /** + *Address to which Parcels are delivered.
+ * * @return null|Address */ diff --git a/lib/commercetools-import/src/Models/Orders/DeliveryItem.php b/lib/commercetools-import/src/Models/Orders/DeliveryItem.php index 3341f9eaea8..e9c30f06f97 100644 --- a/lib/commercetools-import/src/Models/Orders/DeliveryItem.php +++ b/lib/commercetools-import/src/Models/Orders/DeliveryItem.php @@ -17,12 +17,16 @@ interface DeliveryItem extends JsonObject public const FIELD_QUANTITY = 'quantity'; /** + *id of the LineItem or CustomLineItem delivered.
Number of Line Items or Custom Line Items delivered.
+ * * @return null|int */ diff --git a/lib/commercetools-import/src/Models/Orders/DeliveryItemBuilder.php b/lib/commercetools-import/src/Models/Orders/DeliveryItemBuilder.php index 9ac5246166c..83ad680f2b4 100644 --- a/lib/commercetools-import/src/Models/Orders/DeliveryItemBuilder.php +++ b/lib/commercetools-import/src/Models/Orders/DeliveryItemBuilder.php @@ -33,6 +33,8 @@ final class DeliveryItemBuilder implements Builder private $quantity; /** + *id of the LineItem or CustomLineItem delivered.
Number of Line Items or Custom Line Items delivered.
+ * * @return null|int */ diff --git a/lib/commercetools-import/src/Models/Orders/DeliveryItemModel.php b/lib/commercetools-import/src/Models/Orders/DeliveryItemModel.php index dc15e6f52cc..b4b57293101 100644 --- a/lib/commercetools-import/src/Models/Orders/DeliveryItemModel.php +++ b/lib/commercetools-import/src/Models/Orders/DeliveryItemModel.php @@ -44,6 +44,8 @@ public function __construct( } /** + *id of the LineItem or CustomLineItem delivered.
Number of Line Items or Custom Line Items delivered.
+ * * * @return null|int */ diff --git a/lib/commercetools-import/src/Models/Orders/DeliveryModel.php b/lib/commercetools-import/src/Models/Orders/DeliveryModel.php index 11020860dc1..abab873a460 100644 --- a/lib/commercetools-import/src/Models/Orders/DeliveryModel.php +++ b/lib/commercetools-import/src/Models/Orders/DeliveryModel.php @@ -71,6 +71,8 @@ public function __construct( } /** + *Unique identifier of the Delivery.
+ * * * @return null|string */ @@ -89,6 +91,8 @@ public function getId() } /** + *Date and time (UTC) the Delivery was created.
+ * * * @return null|DateTimeImmutable */ @@ -111,6 +115,8 @@ public function getCreatedAt() } /** + *Line Items or Custom Line Items that are delivered.
+ * * * @return null|DeliveryItemCollection */ @@ -129,6 +135,8 @@ public function getItems() } /** + *Information regarding the appearance, content, and shipment of a Parcel.
+ * * * @return null|ParcelCollection */ @@ -147,6 +155,8 @@ public function getParcels() } /** + *Address to which Parcels are delivered.
+ * * * @return null|Address */ diff --git a/lib/commercetools-import/src/Models/Orders/DiscountCodeInfo.php b/lib/commercetools-import/src/Models/Orders/DiscountCodeInfo.php index 9e1aa5016d1..e90f99065dd 100644 --- a/lib/commercetools-import/src/Models/Orders/DiscountCodeInfo.php +++ b/lib/commercetools-import/src/Models/Orders/DiscountCodeInfo.php @@ -18,7 +18,7 @@ interface DiscountCodeInfo extends JsonObject public const FIELD_STATE = 'state'; /** - *References a discount code by key.
+ *References a DiscountCode by key. If the referenced DiscountCode does not exist, the state of the ImportOperation will be set to unresolved until the referenced DiscountCode is created.
References a discount code by key.
+ *References a DiscountCode by key. If the referenced DiscountCode does not exist, the state of the ImportOperation will be set to unresolved until the referenced DiscountCode is created.
References a discount code by key.
+ *References a DiscountCode by key. If the referenced DiscountCode does not exist, the state of the ImportOperation will be set to unresolved until the referenced DiscountCode is created.
References a cart discount by key.
+ *References a cart discount by key. If the referenced CartDiscount does not exist, the state of the ImportOperation will be set to unresolved until the referenced CartDiscount is created.
Money value for the discount applicable.
+ * * @return null|Money */ diff --git a/lib/commercetools-import/src/Models/Orders/DiscountedLineItemPortionBuilder.php b/lib/commercetools-import/src/Models/Orders/DiscountedLineItemPortionBuilder.php index 31921c1ff86..84093d4257b 100644 --- a/lib/commercetools-import/src/Models/Orders/DiscountedLineItemPortionBuilder.php +++ b/lib/commercetools-import/src/Models/Orders/DiscountedLineItemPortionBuilder.php @@ -37,7 +37,7 @@ final class DiscountedLineItemPortionBuilder implements Builder private $discountedAmount; /** - *References a cart discount by key.
+ *References a cart discount by key. If the referenced CartDiscount does not exist, the state of the ImportOperation will be set to unresolved until the referenced CartDiscount is created.
Money value for the discount applicable.
+ * * @return null|Money */ diff --git a/lib/commercetools-import/src/Models/Orders/DiscountedLineItemPortionModel.php b/lib/commercetools-import/src/Models/Orders/DiscountedLineItemPortionModel.php index a4b03a76281..ec9f959aa22 100644 --- a/lib/commercetools-import/src/Models/Orders/DiscountedLineItemPortionModel.php +++ b/lib/commercetools-import/src/Models/Orders/DiscountedLineItemPortionModel.php @@ -48,7 +48,7 @@ public function __construct( } /** - *References a cart discount by key.
+ *References a cart discount by key. If the referenced CartDiscount does not exist, the state of the ImportOperation will be set to unresolved until the referenced CartDiscount is created.
Money value for the discount applicable.
+ * * * @return null|Money */ diff --git a/lib/commercetools-import/src/Models/Orders/DiscountedLineItemPriceDraft.php b/lib/commercetools-import/src/Models/Orders/DiscountedLineItemPriceDraft.php index c7b2e5f5576..4c248facaf8 100644 --- a/lib/commercetools-import/src/Models/Orders/DiscountedLineItemPriceDraft.php +++ b/lib/commercetools-import/src/Models/Orders/DiscountedLineItemPriceDraft.php @@ -18,12 +18,16 @@ interface DiscountedLineItemPriceDraft extends JsonObject public const FIELD_INCLUDED_DISCOUNTS = 'includedDiscounts'; /** + *Discounted money value.
+ * * @return null|Money */ public function getValue(); /** + *Discounts to be applied.
+ * * @return null|DiscountedLineItemPortionCollection */ diff --git a/lib/commercetools-import/src/Models/Orders/DiscountedLineItemPriceDraftBuilder.php b/lib/commercetools-import/src/Models/Orders/DiscountedLineItemPriceDraftBuilder.php index bd0511aff64..aa41c8ca353 100644 --- a/lib/commercetools-import/src/Models/Orders/DiscountedLineItemPriceDraftBuilder.php +++ b/lib/commercetools-import/src/Models/Orders/DiscountedLineItemPriceDraftBuilder.php @@ -35,6 +35,8 @@ final class DiscountedLineItemPriceDraftBuilder implements Builder private $includedDiscounts; /** + *Discounted money value.
+ * * @return null|Money */ @@ -44,6 +46,8 @@ public function getValue() } /** + *Discounts to be applied.
+ * * @return null|DiscountedLineItemPortionCollection */ diff --git a/lib/commercetools-import/src/Models/Orders/DiscountedLineItemPriceDraftModel.php b/lib/commercetools-import/src/Models/Orders/DiscountedLineItemPriceDraftModel.php index 00c919202e5..0345fb27d20 100644 --- a/lib/commercetools-import/src/Models/Orders/DiscountedLineItemPriceDraftModel.php +++ b/lib/commercetools-import/src/Models/Orders/DiscountedLineItemPriceDraftModel.php @@ -46,6 +46,8 @@ public function __construct( } /** + *Discounted money value.
+ * * * @return null|Money */ @@ -65,6 +67,8 @@ public function getValue() } /** + *Discounts to be applied.
+ * * * @return null|DiscountedLineItemPortionCollection */ diff --git a/lib/commercetools-import/src/Models/Orders/ExternalTaxRateDraft.php b/lib/commercetools-import/src/Models/Orders/ExternalTaxRateDraft.php index 760b379ce49..102bf8c1358 100644 --- a/lib/commercetools-import/src/Models/Orders/ExternalTaxRateDraft.php +++ b/lib/commercetools-import/src/Models/Orders/ExternalTaxRateDraft.php @@ -22,36 +22,56 @@ interface ExternalTaxRateDraft extends JsonObject public const FIELD_INCLUDED_IN_PRICE = 'includedInPrice'; /** + *Name of the Tax Rate.
+ * * @return null|string */ public function getName(); /** + *Percentage in the range of 0-1.
+ *subRates are specified, a value must be defined.subRates are specified, this can be omitted or its value must be the sum of all subRates amounts.Country for which the tax applies.
+ * * @return null|string */ public function getCountry(); /** + *State within the specified country.
+ * * @return null|string */ public function getState(); /** + *Used when the total tax is a combination of multiple taxes (for example, local, state/provincial, and/or federal taxes). The total of all subrates must equal the TaxRate amount.
+ * These subrates are used to calculate the taxPortions field of a Cart or Order and the taxedPrice field of LineItems, CustomLineItems, and ShippingInfos.
false, the related price is considered the net price and the provided amount is applied to calculate the gross price.true, the related price is considered the gross price, and the provided amount is applied to calculate the net price.Name of the Tax Rate.
+ * * @return null|string */ @@ -67,6 +69,12 @@ public function getName() } /** + *Percentage in the range of 0-1.
+ *subRates are specified, a value must be defined.subRates are specified, this can be omitted or its value must be the sum of all subRates amounts.Country for which the tax applies.
+ * * @return null|string */ @@ -85,6 +95,8 @@ public function getCountry() } /** + *State within the specified country.
+ * * @return null|string */ @@ -94,6 +106,9 @@ public function getState() } /** + *Used when the total tax is a combination of multiple taxes (for example, local, state/provincial, and/or federal taxes). The total of all subrates must equal the TaxRate amount.
+ * These subrates are used to calculate the taxPortions field of a Cart or Order and the taxedPrice field of LineItems, CustomLineItems, and ShippingInfos.
false, the related price is considered the net price and the provided amount is applied to calculate the gross price.true, the related price is considered the gross price, and the provided amount is applied to calculate the net price.Name of the Tax Rate.
+ * * * @return null|string */ @@ -95,6 +97,12 @@ public function getName() } /** + *Percentage in the range of 0-1.
+ *subRates are specified, a value must be defined.subRates are specified, this can be omitted or its value must be the sum of all subRates amounts.Country for which the tax applies.
+ * * * @return null|string */ @@ -131,6 +141,8 @@ public function getCountry() } /** + *State within the specified country.
+ * * * @return null|string */ @@ -149,6 +161,9 @@ public function getState() } /** + *Used when the total tax is a combination of multiple taxes (for example, local, state/provincial, and/or federal taxes). The total of all subrates must equal the TaxRate amount.
+ * These subrates are used to calculate the taxPortions field of a Cart or Order and the taxedPrice field of LineItems, CustomLineItems, and ShippingInfos.
false, the related price is considered the net price and the provided amount is applied to calculate the gross price.true, the related price is considered the gross price, and the provided amount is applied to calculate the net price.Maps to ItemShippingDetailsDraft.targets.
Holds information on the quantity of Line Items or Custom Line Items and the address it is shipped.
* * @return null|ItemShippingTargetCollection diff --git a/lib/commercetools-import/src/Models/Orders/ItemShippingDetailsDraftBuilder.php b/lib/commercetools-import/src/Models/Orders/ItemShippingDetailsDraftBuilder.php index 643d84b10a1..3ba96b33126 100644 --- a/lib/commercetools-import/src/Models/Orders/ItemShippingDetailsDraftBuilder.php +++ b/lib/commercetools-import/src/Models/Orders/ItemShippingDetailsDraftBuilder.php @@ -27,7 +27,7 @@ final class ItemShippingDetailsDraftBuilder implements Builder private $targets; /** - *Maps to ItemShippingDetailsDraft.targets.
Holds information on the quantity of Line Items or Custom Line Items and the address it is shipped.
* * @return null|ItemShippingTargetCollection diff --git a/lib/commercetools-import/src/Models/Orders/ItemShippingDetailsDraftModel.php b/lib/commercetools-import/src/Models/Orders/ItemShippingDetailsDraftModel.php index c925f4c4ae0..1ed1d61cb63 100644 --- a/lib/commercetools-import/src/Models/Orders/ItemShippingDetailsDraftModel.php +++ b/lib/commercetools-import/src/Models/Orders/ItemShippingDetailsDraftModel.php @@ -36,7 +36,7 @@ public function __construct( } /** - *Maps to ItemShippingDetailsDraft.targets.
Holds information on the quantity of Line Items or Custom Line Items and the address it is shipped.
* * * @return null|ItemShippingTargetCollection diff --git a/lib/commercetools-import/src/Models/Orders/ItemShippingTarget.php b/lib/commercetools-import/src/Models/Orders/ItemShippingTarget.php index 5529ed3399d..a2737b2b519 100644 --- a/lib/commercetools-import/src/Models/Orders/ItemShippingTarget.php +++ b/lib/commercetools-import/src/Models/Orders/ItemShippingTarget.php @@ -17,7 +17,7 @@ interface ItemShippingTarget extends JsonObject public const FIELD_QUANTITY = 'quantity'; /** - *Maps to ItemShippingTarget.addressKey.
Key of the address in the Cart itemShippingAddresses. Duplicate address keys are not allowed.
Maps to ItemShippingTarget.quantity.
Quantity of Line Items or Custom Line Items shipped to the address with the specified addressKey.
Maps to ItemShippingTarget.addressKey.
Key of the address in the Cart itemShippingAddresses. Duplicate address keys are not allowed.
Maps to ItemShippingTarget.quantity.
Quantity of Line Items or Custom Line Items shipped to the address with the specified addressKey.
Maps to ItemShippingTarget.addressKey.
Key of the address in the Cart itemShippingAddresses. Duplicate address keys are not allowed.
Maps to ItemShippingTarget.quantity.
Quantity of Line Items or Custom Line Items shipped to the address with the specified addressKey.
Number of Line Items or Custom Line Items in this State.
+ * * @return null|int */ public function getQuantity(); /** - *Maps to ItemState.state.
State of the Line Items or Custom Line Items in a custom workflow. If the referenced State does not exist, the state of the ImportOperation will be set to unresolved until the referenced State is created.
Number of Line Items or Custom Line Items in this State.
+ * * @return null|int */ @@ -44,7 +46,7 @@ public function getQuantity() } /** - *Maps to ItemState.state.
State of the Line Items or Custom Line Items in a custom workflow. If the referenced State does not exist, the state of the ImportOperation will be set to unresolved until the referenced State is created.
Number of Line Items or Custom Line Items in this State.
+ * * * @return null|int */ @@ -64,7 +66,7 @@ public function getQuantity() } /** - *Maps to ItemState.state.
State of the Line Items or Custom Line Items in a custom workflow. If the referenced State does not exist, the state of the ImportOperation will be set to unresolved until the referenced State is created.
Maps to LineItem.productId.
Maps to LineItem.productId. If the referenced Product does not exist, the state of the ImportOperation will be set to unresolved until the referenced Product is created.
Maps to LineItem.state.
Maps to LineItem.supplyChannel.
- * The Reference to the Supply Channel with which the LineItem is associated.
- * If referenced Supply Channel does not exist, the state of the ImportOperation will be set to unresolved until the necessary Supply Channel is created.
Maps to LineItem.supplyChannel. If the referenced Channel does not exist, the state of the ImportOperation will be set to unresolved until the referenced Channel is created.
Maps to LineItem.distributionChannel.
- * The Reference to the Distribution Channel with which the LineItem is associated.
- * If referenced CustomerGroup does not exist, the state of the ImportOperation will be set to unresolved until the necessary Distribution Channel is created.
Maps to LineItem.distributionChannel. If the referenced Channel does not exist, the state of the ImportOperation will be set to unresolved until the referenced Channel is created.
Maps to LineItem.shippingDetails.
+ *Maps to LineItem.shippingDetails.
Custom Fields for this Line Item.
+ *Maps to LineItem.custom.
Maps to LineItem.productId.
Maps to LineItem.productId. If the referenced Product does not exist, the state of the ImportOperation will be set to unresolved until the referenced Product is created.
Maps to LineItem.state.
Maps to LineItem.supplyChannel.
- * The Reference to the Supply Channel with which the LineItem is associated.
- * If referenced Supply Channel does not exist, the state of the ImportOperation will be set to unresolved until the necessary Supply Channel is created.
Maps to LineItem.supplyChannel. If the referenced Channel does not exist, the state of the ImportOperation will be set to unresolved until the referenced Channel is created.
Maps to LineItem.distributionChannel.
- * The Reference to the Distribution Channel with which the LineItem is associated.
- * If referenced CustomerGroup does not exist, the state of the ImportOperation will be set to unresolved until the necessary Distribution Channel is created.
Maps to LineItem.distributionChannel. If the referenced Channel does not exist, the state of the ImportOperation will be set to unresolved until the referenced Channel is created.
Maps to LineItem.shippingDetails.
+ *Maps to LineItem.shippingDetails.
Custom Fields for this Line Item.
+ *Maps to LineItem.custom.
Maps to LineItem.productId.
Maps to LineItem.productId. If the referenced Product does not exist, the state of the ImportOperation will be set to unresolved until the referenced Product is created.
Maps to LineItem.state.
Maps to LineItem.supplyChannel.
- * The Reference to the Supply Channel with which the LineItem is associated.
- * If referenced Supply Channel does not exist, the state of the ImportOperation will be set to unresolved until the necessary Supply Channel is created.
Maps to LineItem.supplyChannel. If the referenced Channel does not exist, the state of the ImportOperation will be set to unresolved until the referenced Channel is created.
Maps to LineItem.distributionChannel.
- * The Reference to the Distribution Channel with which the LineItem is associated.
- * If referenced CustomerGroup does not exist, the state of the ImportOperation will be set to unresolved until the necessary Distribution Channel is created.
Maps to LineItem.distributionChannel. If the referenced Channel does not exist, the state of the ImportOperation will be set to unresolved until the referenced Channel is created.
Maps to LineItem.shippingDetails.
+ *Maps to LineItem.shippingDetails.
Custom Fields for this Line Item.
+ *Maps to LineItem.custom.
References a customer group by key.
+ *Maps to Price.customerGroup. References a customer group by key. If the referenced CustomerGroup does not exist, the state of the ImportOperation will be set to unresolved until the referenced CustomerGroup is created.
References a channel by key.
+ *Maps to Price.channel. References a channel by key. If the referenced Channel does not exist, the state of the ImportOperation will be set to unresolved until the referenced Channel is created.
The tiered prices for this price.
+ *Maps to Price.tiers.
References a customer group by key.
+ *Maps to Price.customerGroup. References a customer group by key. If the referenced CustomerGroup does not exist, the state of the ImportOperation will be set to unresolved until the referenced CustomerGroup is created.
References a channel by key.
+ *Maps to Price.channel. References a channel by key. If the referenced Channel does not exist, the state of the ImportOperation will be set to unresolved until the referenced Channel is created.
The tiered prices for this price.
+ *Maps to Price.tiers.
References a customer group by key.
+ *Maps to Price.customerGroup. References a customer group by key. If the referenced CustomerGroup does not exist, the state of the ImportOperation will be set to unresolved until the referenced CustomerGroup is created.
References a channel by key.
+ *Maps to Price.channel. References a channel by key. If the referenced Channel does not exist, the state of the ImportOperation will be set to unresolved until the referenced Channel is created.
The tiered prices for this price.
+ *Maps to Price.tiers.
Maps to ProductVariant.product.
Maps to ProductVariant.product. If the referenced ProductVariant does not exist, the state of the ImportOperation will be set to unresolved until the referenced ProductVariant is created.
Maps to ProductVariant.product.
Maps to ProductVariant.product. If the referenced ProductVariant does not exist, the state of the ImportOperation will be set to unresolved until the referenced ProductVariant is created.
Maps to ProductVariant.product.
Maps to ProductVariant.product. If the referenced ProductVariant does not exist, the state of the ImportOperation will be set to unresolved until the referenced ProductVariant is created.
key of the Customer that the Order belongs to. If the referenced Customer does not exist, the state of the ImportOperation will be set to unresolved until the referenced Customer is created.
Maps to Order.customerGroup.
Maps to Order.customerGroup. If the referenced CustomerGroup does not exist, the state of the ImportOperation will be set to unresolved until the referenced CustomerGroup is created.
Reference to the Store in which the Order is associated. If referenced Store does not exist, the state of the ImportOperation will be set to unresolved until the necessary Store exists.
Maps to Order.store. If the referenced Store does not exist, the state of the ImportOperation will be set to unresolved until the referenced Store is created.
Reference to a State in a custom workflow.
+ *Maps to Order.state. If the referenced State does not exist, the state of the ImportOperation will be set to unresolved until the referenced State is created.
key of the Customer that the Order belongs to. If the referenced Customer does not exist, the state of the ImportOperation will be set to unresolved until the referenced Customer is created.
Maps to Order.customerGroup.
Maps to Order.customerGroup. If the referenced CustomerGroup does not exist, the state of the ImportOperation will be set to unresolved until the referenced CustomerGroup is created.
Reference to the Store in which the Order is associated. If referenced Store does not exist, the state of the ImportOperation will be set to unresolved until the necessary Store exists.
Maps to Order.store. If the referenced Store does not exist, the state of the ImportOperation will be set to unresolved until the referenced Store is created.
Reference to a State in a custom workflow.
+ *Maps to Order.state. If the referenced State does not exist, the state of the ImportOperation will be set to unresolved until the referenced State is created.
key of the Customer that the Order belongs to. If the referenced Customer does not exist, the state of the ImportOperation will be set to unresolved until the referenced Customer is created.
Maps to Order.customerGroup.
Maps to Order.customerGroup. If the referenced CustomerGroup does not exist, the state of the ImportOperation will be set to unresolved until the referenced CustomerGroup is created.
Reference to the Store in which the Order is associated. If referenced Store does not exist, the state of the ImportOperation will be set to unresolved until the necessary Store exists.
Maps to Order.store. If the referenced Store does not exist, the state of the ImportOperation will be set to unresolved until the referenced Store is created.
Reference to a State in a custom workflow.
+ *Maps to Order.state. If the referenced State does not exist, the state of the ImportOperation will be set to unresolved until the referenced State is created.
Unique identifier of the Parcel.
+ * * @return null|string */ public function getId(); /** + *Date and time (UTC) the Parcel was created.
+ * * @return null|DateTimeImmutable */ public function getCreatedAt(); /** + *Information about the dimensions of the Parcel.
+ * * @return null|ParcelMeasurements */ public function getMeasurements(); /** + *Shipment tracking information of the Parcel.
+ * * @return null|TrackingData */ public function getTrackingData(); /** + *Line Items or Custom Line Items delivered in this Parcel.
+ * * @return null|DeliveryItemCollection */ public function getItems(); /** - *The representation to be sent to the server when creating a resource with Custom Fields.
+ *Custom Fields of the Parcel.
* * @return null|Custom diff --git a/lib/commercetools-import/src/Models/Orders/ParcelBuilder.php b/lib/commercetools-import/src/Models/Orders/ParcelBuilder.php index 87e40711461..9d8983dddfb 100644 --- a/lib/commercetools-import/src/Models/Orders/ParcelBuilder.php +++ b/lib/commercetools-import/src/Models/Orders/ParcelBuilder.php @@ -60,6 +60,8 @@ final class ParcelBuilder implements Builder private $custom; /** + *Unique identifier of the Parcel.
+ * * @return null|string */ @@ -69,6 +71,8 @@ public function getId() } /** + *Date and time (UTC) the Parcel was created.
+ * * @return null|DateTimeImmutable */ @@ -78,6 +82,8 @@ public function getCreatedAt() } /** + *Information about the dimensions of the Parcel.
+ * * @return null|ParcelMeasurements */ @@ -87,6 +93,8 @@ public function getMeasurements() } /** + *Shipment tracking information of the Parcel.
+ * * @return null|TrackingData */ @@ -96,6 +104,8 @@ public function getTrackingData() } /** + *Line Items or Custom Line Items delivered in this Parcel.
+ * * @return null|DeliveryItemCollection */ @@ -105,7 +115,7 @@ public function getItems() } /** - *The representation to be sent to the server when creating a resource with Custom Fields.
+ *Custom Fields of the Parcel.
* * @return null|Custom diff --git a/lib/commercetools-import/src/Models/Orders/ParcelMeasurements.php b/lib/commercetools-import/src/Models/Orders/ParcelMeasurements.php index b899bbcc98c..3b469f0a437 100644 --- a/lib/commercetools-import/src/Models/Orders/ParcelMeasurements.php +++ b/lib/commercetools-import/src/Models/Orders/ParcelMeasurements.php @@ -19,24 +19,32 @@ interface ParcelMeasurements extends JsonObject public const FIELD_WEIGHT_IN_GRAM = 'weightInGram'; /** + *Height of the Parcel.
+ * * @return null|int */ public function getHeightInMillimeter(); /** + *Length of the Parcel.
+ * * @return null|int */ public function getLengthInMillimeter(); /** + *Width of the Parcel.
+ * * @return null|int */ public function getWidthInMillimeter(); /** + *Weight of the Parcel.
+ * * @return null|int */ diff --git a/lib/commercetools-import/src/Models/Orders/ParcelMeasurementsBuilder.php b/lib/commercetools-import/src/Models/Orders/ParcelMeasurementsBuilder.php index c9636843ff7..48ab45d801d 100644 --- a/lib/commercetools-import/src/Models/Orders/ParcelMeasurementsBuilder.php +++ b/lib/commercetools-import/src/Models/Orders/ParcelMeasurementsBuilder.php @@ -45,6 +45,8 @@ final class ParcelMeasurementsBuilder implements Builder private $weightInGram; /** + *Height of the Parcel.
+ * * @return null|int */ @@ -54,6 +56,8 @@ public function getHeightInMillimeter() } /** + *Length of the Parcel.
+ * * @return null|int */ @@ -63,6 +67,8 @@ public function getLengthInMillimeter() } /** + *Width of the Parcel.
+ * * @return null|int */ @@ -72,6 +78,8 @@ public function getWidthInMillimeter() } /** + *Weight of the Parcel.
+ * * @return null|int */ diff --git a/lib/commercetools-import/src/Models/Orders/ParcelMeasurementsModel.php b/lib/commercetools-import/src/Models/Orders/ParcelMeasurementsModel.php index f34f2982e91..82fde49c70d 100644 --- a/lib/commercetools-import/src/Models/Orders/ParcelMeasurementsModel.php +++ b/lib/commercetools-import/src/Models/Orders/ParcelMeasurementsModel.php @@ -60,6 +60,8 @@ public function __construct( } /** + *Height of the Parcel.
+ * * * @return null|int */ @@ -78,6 +80,8 @@ public function getHeightInMillimeter() } /** + *Length of the Parcel.
+ * * * @return null|int */ @@ -96,6 +100,8 @@ public function getLengthInMillimeter() } /** + *Width of the Parcel.
+ * * * @return null|int */ @@ -114,6 +120,8 @@ public function getWidthInMillimeter() } /** + *Weight of the Parcel.
+ * * * @return null|int */ diff --git a/lib/commercetools-import/src/Models/Orders/ParcelModel.php b/lib/commercetools-import/src/Models/Orders/ParcelModel.php index d5a9006c66b..7d3682e86ca 100644 --- a/lib/commercetools-import/src/Models/Orders/ParcelModel.php +++ b/lib/commercetools-import/src/Models/Orders/ParcelModel.php @@ -79,6 +79,8 @@ public function __construct( } /** + *Unique identifier of the Parcel.
+ * * * @return null|string */ @@ -97,6 +99,8 @@ public function getId() } /** + *Date and time (UTC) the Parcel was created.
+ * * * @return null|DateTimeImmutable */ @@ -119,6 +123,8 @@ public function getCreatedAt() } /** + *Information about the dimensions of the Parcel.
+ * * * @return null|ParcelMeasurements */ @@ -138,6 +144,8 @@ public function getMeasurements() } /** + *Shipment tracking information of the Parcel.
+ * * * @return null|TrackingData */ @@ -157,6 +165,8 @@ public function getTrackingData() } /** + *Line Items or Custom Line Items delivered in this Parcel.
+ * * * @return null|DeliveryItemCollection */ @@ -175,7 +185,7 @@ public function getItems() } /** - *The representation to be sent to the server when creating a resource with Custom Fields.
+ *Custom Fields of the Parcel.
* * * @return null|Custom diff --git a/lib/commercetools-import/src/Models/Orders/ShippingInfoImportDraft.php b/lib/commercetools-import/src/Models/Orders/ShippingInfoImportDraft.php index 52c66c04ce2..9a1ebe0ce06 100644 --- a/lib/commercetools-import/src/Models/Orders/ShippingInfoImportDraft.php +++ b/lib/commercetools-import/src/Models/Orders/ShippingInfoImportDraft.php @@ -28,31 +28,39 @@ interface ShippingInfoImportDraft extends JsonObject public const FIELD_SHIPPING_METHOD_STATE = 'shippingMethodState'; /** + *Maps to shippingInfo.shippingMethodName.
Maps to shippingInfo.price.
Used to determine the price.
+ * * @return null|ShippingRateDraft */ public function getShippingRate(); /** + *Maps to shippingInfo.taxRate.
References a tax category by key.
+ *Maps to shippingInfo.taxCategory. If the referenced TaxCategory does not exist, the state of the ImportOperation will be set to unresolved until the referenced TaxCategory is created.
References a shipping method by key.
+ *Maps to shippingInfo.shippingMethod. If the referenced ShippingMethod does not exist, the state of the ImportOperation will be set to unresolved until the referenced ShippingMethod is created.
Note that you can not add a DeliveryItem on import, as LineItems and CustomLineItems are not yet referenceable by an id.
Maps to shippingInfo.deliveries. You cannot add a DeliveryItem on import, as LineItems and CustomLineItems are not yet referenceable by an id.
Maps to shippingInfo.discountedPrice.
Maps to shippingInfo.shippingMethodState.
Maps to shippingInfo.shippingMethodName.
Maps to shippingInfo.price.
Used to determine the price.
+ * * @return null|ShippingRateDraft */ @@ -110,6 +116,8 @@ public function getShippingRate() } /** + *Maps to shippingInfo.taxRate.
References a tax category by key.
+ *Maps to shippingInfo.taxCategory. If the referenced TaxCategory does not exist, the state of the ImportOperation will be set to unresolved until the referenced TaxCategory is created.
References a shipping method by key.
+ *Maps to shippingInfo.shippingMethod. If the referenced ShippingMethod does not exist, the state of the ImportOperation will be set to unresolved until the referenced ShippingMethod is created.
Note that you can not add a DeliveryItem on import, as LineItems and CustomLineItems are not yet referenceable by an id.
Maps to shippingInfo.deliveries. You cannot add a DeliveryItem on import, as LineItems and CustomLineItems are not yet referenceable by an id.
Maps to shippingInfo.discountedPrice.
Maps to shippingInfo.shippingMethodState.
Maps to shippingInfo.shippingMethodName.
Maps to shippingInfo.price.
Used to determine the price.
+ * * * @return null|ShippingRateDraft */ @@ -164,6 +170,8 @@ public function getShippingRate() } /** + *Maps to shippingInfo.taxRate.
References a tax category by key.
+ *Maps to shippingInfo.taxCategory. If the referenced TaxCategory does not exist, the state of the ImportOperation will be set to unresolved until the referenced TaxCategory is created.
References a shipping method by key.
+ *Maps to shippingInfo.shippingMethod. If the referenced ShippingMethod does not exist, the state of the ImportOperation will be set to unresolved until the referenced ShippingMethod is created.
Note that you can not add a DeliveryItem on import, as LineItems and CustomLineItems are not yet referenceable by an id.
Maps to shippingInfo.deliveries. You cannot add a DeliveryItem on import, as LineItems and CustomLineItems are not yet referenceable by an id.
Maps to shippingInfo.discountedPrice.
Maps to shippingInfo.shippingMethodState.
Currency amount of the ShippingRate.
+ * * @return null|Money */ public function getPrice(); /** + *Free shipping is applied if the sum of the (Custom) Line Item Prices reaches the specified value.
+ * * @return null|Money */ public function getFreeAbove(); /** + *Price tiers for the ShippingRate.
+ * * @return null|ShippingRatePriceTierCollection */ diff --git a/lib/commercetools-import/src/Models/Orders/ShippingRateDraftBuilder.php b/lib/commercetools-import/src/Models/Orders/ShippingRateDraftBuilder.php index ef6d31377fd..3fe2f72db04 100644 --- a/lib/commercetools-import/src/Models/Orders/ShippingRateDraftBuilder.php +++ b/lib/commercetools-import/src/Models/Orders/ShippingRateDraftBuilder.php @@ -41,6 +41,8 @@ final class ShippingRateDraftBuilder implements Builder private $tiers; /** + *Currency amount of the ShippingRate.
+ * * @return null|Money */ @@ -50,6 +52,8 @@ public function getPrice() } /** + *Free shipping is applied if the sum of the (Custom) Line Item Prices reaches the specified value.
+ * * @return null|Money */ @@ -59,6 +63,8 @@ public function getFreeAbove() } /** + *Price tiers for the ShippingRate.
+ * * @return null|ShippingRatePriceTierCollection */ diff --git a/lib/commercetools-import/src/Models/Orders/ShippingRateDraftModel.php b/lib/commercetools-import/src/Models/Orders/ShippingRateDraftModel.php index 4c199ac13ac..1d75fd7b2db 100644 --- a/lib/commercetools-import/src/Models/Orders/ShippingRateDraftModel.php +++ b/lib/commercetools-import/src/Models/Orders/ShippingRateDraftModel.php @@ -54,6 +54,8 @@ public function __construct( } /** + *Currency amount of the ShippingRate.
+ * * * @return null|Money */ @@ -73,6 +75,8 @@ public function getPrice() } /** + *Free shipping is applied if the sum of the (Custom) Line Item Prices reaches the specified value.
+ * * * @return null|Money */ @@ -92,6 +96,8 @@ public function getFreeAbove() } /** + *Price tiers for the ShippingRate.
+ * * * @return null|ShippingRatePriceTierCollection */ diff --git a/lib/commercetools-import/src/Models/Orders/SyncInfo.php b/lib/commercetools-import/src/Models/Orders/SyncInfo.php index ab22edd59fc..c334f89ac07 100644 --- a/lib/commercetools-import/src/Models/Orders/SyncInfo.php +++ b/lib/commercetools-import/src/Models/Orders/SyncInfo.php @@ -20,7 +20,7 @@ interface SyncInfo extends JsonObject public const FIELD_SYNCED_AT = 'syncedAt'; /** - *Maps to SyncInfo.channel
Maps to SyncInfo.channel. If the referenced Channel does not exist, the state of the ImportOperation will be set to unresolved until the referenced Channel is created.
Maps to SyncInfo.channel
Maps to SyncInfo.channel. If the referenced Channel does not exist, the state of the ImportOperation will be set to unresolved until the referenced Channel is created.
Maps to SyncInfo.channel
Maps to SyncInfo.channel. If the referenced Channel does not exist, the state of the ImportOperation will be set to unresolved until the referenced Channel is created.
Name of the tax portion.
+ * * @return null|string */ public function getName(); /** + *A number in the range 0-1.
+ * * @return null|float */ public function getRate(); /** + *Money value of the tax portion.
+ * * @return null|TypedMoney */ diff --git a/lib/commercetools-import/src/Models/Orders/TaxPortionBuilder.php b/lib/commercetools-import/src/Models/Orders/TaxPortionBuilder.php index 628d1ed6f30..c7f7b50a43a 100644 --- a/lib/commercetools-import/src/Models/Orders/TaxPortionBuilder.php +++ b/lib/commercetools-import/src/Models/Orders/TaxPortionBuilder.php @@ -41,6 +41,8 @@ final class TaxPortionBuilder implements Builder private $amount; /** + *Name of the tax portion.
+ * * @return null|string */ @@ -50,6 +52,8 @@ public function getName() } /** + *A number in the range 0-1.
+ * * @return null|float */ @@ -59,6 +63,8 @@ public function getRate() } /** + *Money value of the tax portion.
+ * * @return null|TypedMoney */ diff --git a/lib/commercetools-import/src/Models/Orders/TaxPortionModel.php b/lib/commercetools-import/src/Models/Orders/TaxPortionModel.php index b1623fccd06..b5df9df4ff7 100644 --- a/lib/commercetools-import/src/Models/Orders/TaxPortionModel.php +++ b/lib/commercetools-import/src/Models/Orders/TaxPortionModel.php @@ -54,6 +54,8 @@ public function __construct( } /** + *Name of the tax portion.
+ * * * @return null|string */ @@ -72,6 +74,8 @@ public function getName() } /** + *A number in the range 0-1.
+ * * * @return null|float */ @@ -90,6 +94,8 @@ public function getRate() } /** + *Money value of the tax portion.
+ * * * @return null|TypedMoney */ diff --git a/lib/commercetools-import/src/Models/Orders/TrackingData.php b/lib/commercetools-import/src/Models/Orders/TrackingData.php index 23383d7392e..ddcf663fc26 100644 --- a/lib/commercetools-import/src/Models/Orders/TrackingData.php +++ b/lib/commercetools-import/src/Models/Orders/TrackingData.php @@ -20,30 +20,43 @@ interface TrackingData extends JsonObject public const FIELD_IS_RETURN = 'isReturn'; /** + *Identifier to track the Parcel.
+ * * @return null|string */ public function getTrackingId(); /** + *Name of the carrier that delivers the Parcel.
+ * * @return null|string */ public function getCarrier(); /** + *Name of the provider that serves as facade to several carriers.
+ * * @return null|string */ public function getProvider(); /** + *Transaction identifier with the provider.
true, the Parcel is being returned.false, the Parcel is being delivered to the customer.Identifier to track the Parcel.
+ * * @return null|string */ @@ -60,6 +62,8 @@ public function getTrackingId() } /** + *Name of the carrier that delivers the Parcel.
+ * * @return null|string */ @@ -69,6 +73,8 @@ public function getCarrier() } /** + *Name of the provider that serves as facade to several carriers.
+ * * @return null|string */ @@ -78,6 +84,8 @@ public function getProvider() } /** + *Transaction identifier with the provider.
true, the Parcel is being returned.false, the Parcel is being delivered to the customer.Identifier to track the Parcel.
+ * * * @return null|string */ @@ -86,6 +88,8 @@ public function getTrackingId() } /** + *Name of the carrier that delivers the Parcel.
+ * * * @return null|string */ @@ -104,6 +108,8 @@ public function getCarrier() } /** + *Name of the provider that serves as facade to several carriers.
+ * * * @return null|string */ @@ -122,6 +128,8 @@ public function getProvider() } /** + *Transaction identifier with the provider.
true, the Parcel is being returned.false, the Parcel is being delivered to the customer.User-defined unique identifier for the Embedded Price. If a Price with this key exists on the specified productVariant, it will be updated with the imported data.
User-defined unique identifier for the Embedded Price. If a Price with this key exists on the specified productVariant, it is updated with the imported data.
The Reference to the CustomerGroup with which the Price is associated.
- * If referenced CustomerGroup does not exist, the state of the ImportOperation will be set to unresolved until the necessary CustomerGroup is created.
Maps to Price.customerGroup. If the referenced CustomerGroup does not exist, the state of the ImportOperation will be set to unresolved until the referenced CustomerGroup is created.
The Reference to the Channel with which the Price is associated.
- * If referenced Channel does not exist, the state of the ImportOperation will be set to unresolved until the necessary Channel is created.
Maps to Price.channel. If the referenced Channel does not exist, the state of the ImportOperation will be set to unresolved until the referenced Channel is created.
false to update both the current and staged projections of the Product with the new Price data.false to update both the current and staged projections of the Product with the new Price data.true to only update the staged projection.The custom fields for this price.
+ *Maps to Price.custom.
The ProductVariant in which this Embedded Price is contained.
- * The Reference to the ProductVariant with which the Price is associated.
- * If the referenced ProductVariant does not exist, the state of the ImportOperation will be set to unresolved until the necessary ProductVariant is created.
The ProductVariant which contains this Embedded Price. If the referenced ProductVariant does not exist, the state of the ImportOperation will be set to unresolved until the referenced ProductVariant is created.
The Product in which the Product Variant containing this Embedded Price is contained. Maps to ProductVariant.product.
- * The Reference to the Product with which the Price is associated.
- * If referenced Product does not exist, the state of the ImportOperation will be set to unresolved until the necessary Product is created.
The Product which contains the productVariant. If the referenced Product does not exist, the state of the ImportOperation will be set to unresolved until the referenced Product is created.
User-defined unique identifier for the Embedded Price. If a Price with this key exists on the specified productVariant, it will be updated with the imported data.
User-defined unique identifier for the Embedded Price. If a Price with this key exists on the specified productVariant, it is updated with the imported data.
The Reference to the CustomerGroup with which the Price is associated.
- * If referenced CustomerGroup does not exist, the state of the ImportOperation will be set to unresolved until the necessary CustomerGroup is created.
Maps to Price.customerGroup. If the referenced CustomerGroup does not exist, the state of the ImportOperation will be set to unresolved until the referenced CustomerGroup is created.
The Reference to the Channel with which the Price is associated.
- * If referenced Channel does not exist, the state of the ImportOperation will be set to unresolved until the necessary Channel is created.
Maps to Price.channel. If the referenced Channel does not exist, the state of the ImportOperation will be set to unresolved until the referenced Channel is created.
false to update both the current and staged projections of the Product with the new Price data.false to update both the current and staged projections of the Product with the new Price data.true to only update the staged projection.The custom fields for this price.
+ *Maps to Price.custom.
The ProductVariant in which this Embedded Price is contained.
- * The Reference to the ProductVariant with which the Price is associated.
- * If the referenced ProductVariant does not exist, the state of the ImportOperation will be set to unresolved until the necessary ProductVariant is created.
The ProductVariant which contains this Embedded Price. If the referenced ProductVariant does not exist, the state of the ImportOperation will be set to unresolved until the referenced ProductVariant is created.
The Product in which the Product Variant containing this Embedded Price is contained. Maps to ProductVariant.product.
- * The Reference to the Product with which the Price is associated.
- * If referenced Product does not exist, the state of the ImportOperation will be set to unresolved until the necessary Product is created.
The Product which contains the productVariant. If the referenced Product does not exist, the state of the ImportOperation will be set to unresolved until the referenced Product is created.
User-defined unique identifier for the Embedded Price. If a Price with this key exists on the specified productVariant, it will be updated with the imported data.
User-defined unique identifier for the Embedded Price. If a Price with this key exists on the specified productVariant, it is updated with the imported data.
The Reference to the CustomerGroup with which the Price is associated.
- * If referenced CustomerGroup does not exist, the state of the ImportOperation will be set to unresolved until the necessary CustomerGroup is created.
Maps to Price.customerGroup. If the referenced CustomerGroup does not exist, the state of the ImportOperation will be set to unresolved until the referenced CustomerGroup is created.
The Reference to the Channel with which the Price is associated.
- * If referenced Channel does not exist, the state of the ImportOperation will be set to unresolved until the necessary Channel is created.
Maps to Price.channel. If the referenced Channel does not exist, the state of the ImportOperation will be set to unresolved until the referenced Channel is created.
false to update both the current and staged projections of the Product with the new Price data.false to update both the current and staged projections of the Product with the new Price data.true to only update the staged projection.The custom fields for this price.
+ *Maps to Price.custom.
The ProductVariant in which this Embedded Price is contained.
- * The Reference to the ProductVariant with which the Price is associated.
- * If the referenced ProductVariant does not exist, the state of the ImportOperation will be set to unresolved until the necessary ProductVariant is created.
The ProductVariant which contains this Embedded Price. If the referenced ProductVariant does not exist, the state of the ImportOperation will be set to unresolved until the referenced ProductVariant is created.
The Product in which the Product Variant containing this Embedded Price is contained. Maps to ProductVariant.product.
- * The Reference to the Product with which the Price is associated.
- * If referenced Product does not exist, the state of the ImportOperation will be set to unresolved until the necessary Product is created.
The Product which contains the productVariant. If the referenced Product does not exist, the state of the ImportOperation will be set to unresolved until the referenced Product is created.
Name of the SubRate.
+ * * @return null|string */ diff --git a/lib/commercetools-import/src/Models/Prices/SubRateBuilder.php b/lib/commercetools-import/src/Models/Prices/SubRateBuilder.php index 24a9240aae5..94acf731cdc 100644 --- a/lib/commercetools-import/src/Models/Prices/SubRateBuilder.php +++ b/lib/commercetools-import/src/Models/Prices/SubRateBuilder.php @@ -33,6 +33,8 @@ final class SubRateBuilder implements Builder private $amount; /** + *Name of the SubRate.
+ * * @return null|string */ diff --git a/lib/commercetools-import/src/Models/Prices/SubRateModel.php b/lib/commercetools-import/src/Models/Prices/SubRateModel.php index 8f9ee91a8e3..25edc1f267c 100644 --- a/lib/commercetools-import/src/Models/Prices/SubRateModel.php +++ b/lib/commercetools-import/src/Models/Prices/SubRateModel.php @@ -44,6 +44,8 @@ public function __construct( } /** + *Name of the SubRate.
+ * * * @return null|string */ diff --git a/lib/commercetools-import/src/Models/ProductSelections/ProductSelectionAssignment.php b/lib/commercetools-import/src/Models/ProductSelections/ProductSelectionAssignment.php new file mode 100644 index 00000000000..2260a54bb02 --- /dev/null +++ b/lib/commercetools-import/src/Models/ProductSelections/ProductSelectionAssignment.php @@ -0,0 +1,59 @@ +Reference to the Product by key. + * + + * @return null|ProductKeyReference + */ + public function getProduct(); + + /** + *Variant selection specifying included SKUs.
+ * + + * @return null|VariantSelection + */ + public function getVariantSelection(); + + /** + *Variant exclusion specifying excluded SKUs.
+ * + + * @return null|VariantExclusion + */ + public function getVariantExclusion(); + + /** + * @param ?ProductKeyReference $product + */ + public function setProduct(?ProductKeyReference $product): void; + + /** + * @param ?VariantSelection $variantSelection + */ + public function setVariantSelection(?VariantSelection $variantSelection): void; + + /** + * @param ?VariantExclusion $variantExclusion + */ + public function setVariantExclusion(?VariantExclusion $variantExclusion): void; +} diff --git a/lib/commercetools-import/src/Models/ProductSelections/ProductSelectionAssignmentBuilder.php b/lib/commercetools-import/src/Models/ProductSelections/ProductSelectionAssignmentBuilder.php new file mode 100644 index 00000000000..deeaaf05181 --- /dev/null +++ b/lib/commercetools-import/src/Models/ProductSelections/ProductSelectionAssignmentBuilder.php @@ -0,0 +1,155 @@ + + */ +final class ProductSelectionAssignmentBuilder implements Builder +{ + /** + + * @var null|ProductKeyReference|ProductKeyReferenceBuilder + */ + private $product; + + /** + + * @var null|VariantSelection|VariantSelectionBuilder + */ + private $variantSelection; + + /** + + * @var null|VariantExclusion|VariantExclusionBuilder + */ + private $variantExclusion; + + /** + *Reference to the Product by key.
+ * + + * @return null|ProductKeyReference + */ + public function getProduct() + { + return $this->product instanceof ProductKeyReferenceBuilder ? $this->product->build() : $this->product; + } + + /** + *Variant selection specifying included SKUs.
+ * + + * @return null|VariantSelection + */ + public function getVariantSelection() + { + return $this->variantSelection instanceof VariantSelectionBuilder ? $this->variantSelection->build() : $this->variantSelection; + } + + /** + *Variant exclusion specifying excluded SKUs.
+ * + + * @return null|VariantExclusion + */ + public function getVariantExclusion() + { + return $this->variantExclusion instanceof VariantExclusionBuilder ? $this->variantExclusion->build() : $this->variantExclusion; + } + + /** + * @param ?ProductKeyReference $product + * @return $this + */ + public function withProduct(?ProductKeyReference $product) + { + $this->product = $product; + + return $this; + } + + /** + * @param ?VariantSelection $variantSelection + * @return $this + */ + public function withVariantSelection(?VariantSelection $variantSelection) + { + $this->variantSelection = $variantSelection; + + return $this; + } + + /** + * @param ?VariantExclusion $variantExclusion + * @return $this + */ + public function withVariantExclusion(?VariantExclusion $variantExclusion) + { + $this->variantExclusion = $variantExclusion; + + return $this; + } + + /** + * @deprecated use withProduct() instead + * @return $this + */ + public function withProductBuilder(?ProductKeyReferenceBuilder $product) + { + $this->product = $product; + + return $this; + } + + /** + * @deprecated use withVariantSelection() instead + * @return $this + */ + public function withVariantSelectionBuilder(?VariantSelectionBuilder $variantSelection) + { + $this->variantSelection = $variantSelection; + + return $this; + } + + /** + * @deprecated use withVariantExclusion() instead + * @return $this + */ + public function withVariantExclusionBuilder(?VariantExclusionBuilder $variantExclusion) + { + $this->variantExclusion = $variantExclusion; + + return $this; + } + + public function build(): ProductSelectionAssignment + { + return new ProductSelectionAssignmentModel( + $this->product instanceof ProductKeyReferenceBuilder ? $this->product->build() : $this->product, + $this->variantSelection instanceof VariantSelectionBuilder ? $this->variantSelection->build() : $this->variantSelection, + $this->variantExclusion instanceof VariantExclusionBuilder ? $this->variantExclusion->build() : $this->variantExclusion + ); + } + + public static function of(): ProductSelectionAssignmentBuilder + { + return new self(); + } +} diff --git a/lib/commercetools-import/src/Models/ProductSelections/ProductSelectionAssignmentCollection.php b/lib/commercetools-import/src/Models/ProductSelections/ProductSelectionAssignmentCollection.php new file mode 100644 index 00000000000..e9d2850a88c --- /dev/null +++ b/lib/commercetools-import/src/Models/ProductSelections/ProductSelectionAssignmentCollection.php @@ -0,0 +1,56 @@ + + * @method ProductSelectionAssignment current() + * @method ProductSelectionAssignment end() + * @method ProductSelectionAssignment at($offset) + */ +class ProductSelectionAssignmentCollection extends MapperSequence +{ + /** + * @psalm-assert ProductSelectionAssignment $value + * @psalm-param ProductSelectionAssignment|stdClass $value + * @throws InvalidArgumentException + * + * @return ProductSelectionAssignmentCollection + */ + public function add($value) + { + if (!$value instanceof ProductSelectionAssignment) { + throw new InvalidArgumentException(); + } + $this->store($value); + + return $this; + } + + /** + * @psalm-return callable(int):?ProductSelectionAssignment + */ + protected function mapper() + { + return function (?int $index): ?ProductSelectionAssignment { + $data = $this->get($index); + if ($data instanceof stdClass) { + /** @var ProductSelectionAssignment $data */ + $data = ProductSelectionAssignmentModel::of($data); + $this->set($data, $index); + } + + return $data; + }; + } +} diff --git a/lib/commercetools-import/src/Models/ProductSelections/ProductSelectionAssignmentModel.php b/lib/commercetools-import/src/Models/ProductSelections/ProductSelectionAssignmentModel.php new file mode 100644 index 00000000000..2863ec98b4d --- /dev/null +++ b/lib/commercetools-import/src/Models/ProductSelections/ProductSelectionAssignmentModel.php @@ -0,0 +1,143 @@ +product = $product; + $this->variantSelection = $variantSelection; + $this->variantExclusion = $variantExclusion; + } + + /** + *Reference to the Product by key.
+ * + * + * @return null|ProductKeyReference + */ + public function getProduct() + { + if (is_null($this->product)) { + /** @psalm-var stdClass|arrayVariant selection specifying included SKUs.
+ * + * + * @return null|VariantSelection + */ + public function getVariantSelection() + { + if (is_null($this->variantSelection)) { + /** @psalm-var stdClass|arrayVariant exclusion specifying excluded SKUs.
+ * + * + * @return null|VariantExclusion + */ + public function getVariantExclusion() + { + if (is_null($this->variantExclusion)) { + /** @psalm-var stdClass|arraykey exists, it is updated with the imported data.
+ *
+
+ * @return null|string
+ */
+ public function getKey();
+
+ /**
+ * Maps to ProductSelection.name.
Maps to ProductSelection.mode.
Maps to ProductSelection.custom.
List of product assignments.
+ * + + * @return null|ProductSelectionAssignmentCollection + */ + public function getAssignments(); + + /** + * @param ?string $key + */ + public function setKey(?string $key): void; + + /** + * @param ?LocalizedString $name + */ + public function setName(?LocalizedString $name): void; + + /** + * @param ?string $mode + */ + public function setMode(?string $mode): void; + + /** + * @param ?Custom $custom + */ + public function setCustom(?Custom $custom): void; + + /** + * @param ?ProductSelectionAssignmentCollection $assignments + */ + public function setAssignments(?ProductSelectionAssignmentCollection $assignments): void; +} diff --git a/lib/commercetools-import/src/Models/ProductSelections/ProductSelectionImportBuilder.php b/lib/commercetools-import/src/Models/ProductSelections/ProductSelectionImportBuilder.php new file mode 100644 index 00000000000..55937253812 --- /dev/null +++ b/lib/commercetools-import/src/Models/ProductSelections/ProductSelectionImportBuilder.php @@ -0,0 +1,206 @@ + + */ +final class ProductSelectionImportBuilder implements Builder +{ + /** + + * @var ?string + */ + private $key; + + /** + + * @var null|LocalizedString|LocalizedStringBuilder + */ + private $name; + + /** + + * @var ?string + */ + private $mode; + + /** + + * @var null|Custom|CustomBuilder + */ + private $custom; + + /** + + * @var ?ProductSelectionAssignmentCollection + */ + private $assignments; + + /** + *User-defined unique identifier. If an ProductSelection with this key exists, it is updated with the imported data.
Maps to ProductSelection.name.
Maps to ProductSelection.mode.
Maps to ProductSelection.custom.
List of product assignments.
+ * + + * @return null|ProductSelectionAssignmentCollection + */ + public function getAssignments() + { + return $this->assignments; + } + + /** + * @param ?string $key + * @return $this + */ + public function withKey(?string $key) + { + $this->key = $key; + + return $this; + } + + /** + * @param ?LocalizedString $name + * @return $this + */ + public function withName(?LocalizedString $name) + { + $this->name = $name; + + return $this; + } + + /** + * @param ?string $mode + * @return $this + */ + public function withMode(?string $mode) + { + $this->mode = $mode; + + return $this; + } + + /** + * @param ?Custom $custom + * @return $this + */ + public function withCustom(?Custom $custom) + { + $this->custom = $custom; + + return $this; + } + + /** + * @param ?ProductSelectionAssignmentCollection $assignments + * @return $this + */ + public function withAssignments(?ProductSelectionAssignmentCollection $assignments) + { + $this->assignments = $assignments; + + return $this; + } + + /** + * @deprecated use withName() instead + * @return $this + */ + public function withNameBuilder(?LocalizedStringBuilder $name) + { + $this->name = $name; + + return $this; + } + + /** + * @deprecated use withCustom() instead + * @return $this + */ + public function withCustomBuilder(?CustomBuilder $custom) + { + $this->custom = $custom; + + return $this; + } + + public function build(): ProductSelectionImport + { + return new ProductSelectionImportModel( + $this->key, + $this->name instanceof LocalizedStringBuilder ? $this->name->build() : $this->name, + $this->mode, + $this->custom instanceof CustomBuilder ? $this->custom->build() : $this->custom, + $this->assignments + ); + } + + public static function of(): ProductSelectionImportBuilder + { + return new self(); + } +} diff --git a/lib/commercetools-import/src/Models/ProductSelections/ProductSelectionImportCollection.php b/lib/commercetools-import/src/Models/ProductSelections/ProductSelectionImportCollection.php new file mode 100644 index 00000000000..0f278919796 --- /dev/null +++ b/lib/commercetools-import/src/Models/ProductSelections/ProductSelectionImportCollection.php @@ -0,0 +1,56 @@ + + * @method ProductSelectionImport current() + * @method ProductSelectionImport end() + * @method ProductSelectionImport at($offset) + */ +class ProductSelectionImportCollection extends ImportResourceCollection +{ + /** + * @psalm-assert ProductSelectionImport $value + * @psalm-param ProductSelectionImport|stdClass $value + * @throws InvalidArgumentException + * + * @return ProductSelectionImportCollection + */ + public function add($value) + { + if (!$value instanceof ProductSelectionImport) { + throw new InvalidArgumentException(); + } + $this->store($value); + + return $this; + } + + /** + * @psalm-return callable(int):?ProductSelectionImport + */ + protected function mapper() + { + return function (?int $index): ?ProductSelectionImport { + $data = $this->get($index); + if ($data instanceof stdClass) { + /** @var ProductSelectionImport $data */ + $data = ProductSelectionImportModel::of($data); + $this->set($data, $index); + } + + return $data; + }; + } +} diff --git a/lib/commercetools-import/src/Models/ProductSelections/ProductSelectionImportModel.php b/lib/commercetools-import/src/Models/ProductSelections/ProductSelectionImportModel.php new file mode 100644 index 00000000000..f5ec47ca2d6 --- /dev/null +++ b/lib/commercetools-import/src/Models/ProductSelections/ProductSelectionImportModel.php @@ -0,0 +1,218 @@ +key = $key; + $this->name = $name; + $this->mode = $mode; + $this->custom = $custom; + $this->assignments = $assignments; + } + + /** + *User-defined unique identifier. If an ProductSelection with this key exists, it is updated with the imported data.
Maps to ProductSelection.name.
Maps to ProductSelection.mode.
Maps to ProductSelection.custom.
List of product assignments.
+ * + * + * @return null|ProductSelectionAssignmentCollection + */ + public function getAssignments() + { + if (is_null($this->assignments)) { + /** @psalm-var ?listList of SKUs to be excluded.
+ * + + * @return null|array + */ + public function getSkus() + { + return $this->skus; + } + + /** + * @param ?array $skus + * @return $this + */ + public function withSkus(?array $skus) + { + $this->skus = $skus; + + return $this; + } + + + public function build(): VariantExclusion + { + return new VariantExclusionModel( + $this->skus + ); + } + + public static function of(): VariantExclusionBuilder + { + return new self(); + } +} diff --git a/lib/commercetools-import/src/Models/ProductSelections/VariantExclusionCollection.php b/lib/commercetools-import/src/Models/ProductSelections/VariantExclusionCollection.php new file mode 100644 index 00000000000..0c5e65420e4 --- /dev/null +++ b/lib/commercetools-import/src/Models/ProductSelections/VariantExclusionCollection.php @@ -0,0 +1,56 @@ + + * @method VariantExclusion current() + * @method VariantExclusion end() + * @method VariantExclusion at($offset) + */ +class VariantExclusionCollection extends MapperSequence +{ + /** + * @psalm-assert VariantExclusion $value + * @psalm-param VariantExclusion|stdClass $value + * @throws InvalidArgumentException + * + * @return VariantExclusionCollection + */ + public function add($value) + { + if (!$value instanceof VariantExclusion) { + throw new InvalidArgumentException(); + } + $this->store($value); + + return $this; + } + + /** + * @psalm-return callable(int):?VariantExclusion + */ + protected function mapper() + { + return function (?int $index): ?VariantExclusion { + $data = $this->get($index); + if ($data instanceof stdClass) { + /** @var VariantExclusion $data */ + $data = VariantExclusionModel::of($data); + $this->set($data, $index); + } + + return $data; + }; + } +} diff --git a/lib/commercetools-import/src/Models/ProductSelections/VariantExclusionModel.php b/lib/commercetools-import/src/Models/ProductSelections/VariantExclusionModel.php new file mode 100644 index 00000000000..e8f7f174d1b --- /dev/null +++ b/lib/commercetools-import/src/Models/ProductSelections/VariantExclusionModel.php @@ -0,0 +1,66 @@ +skus = $skus; + } + + /** + *List of SKUs to be excluded.
+ * + * + * @return null|array + */ + public function getSkus() + { + if (is_null($this->skus)) { + /** @psalm-var ?listList of SKUs to include or exclude.
+ * + + * @return null|array + */ + public function getSkus(); + + /** + * @param ?string $type + */ + public function setType(?string $type): void; + + /** + * @param ?array $skus + */ + public function setSkus(?array $skus): void; +} diff --git a/lib/commercetools-import/src/Models/ProductSelections/VariantSelectionBuilder.php b/lib/commercetools-import/src/Models/ProductSelections/VariantSelectionBuilder.php new file mode 100644 index 00000000000..40a701acb5d --- /dev/null +++ b/lib/commercetools-import/src/Models/ProductSelections/VariantSelectionBuilder.php @@ -0,0 +1,92 @@ + + */ +final class VariantSelectionBuilder implements Builder +{ + /** + + * @var ?string + */ + private $type; + + /** + + * @var ?array + */ + private $skus; + + /** + *Type of variant selection.
+ * + + * @return null|string + */ + public function getType() + { + return $this->type; + } + + /** + *List of SKUs to include or exclude.
+ * + + * @return null|array + */ + public function getSkus() + { + return $this->skus; + } + + /** + * @param ?string $type + * @return $this + */ + public function withType(?string $type) + { + $this->type = $type; + + return $this; + } + + /** + * @param ?array $skus + * @return $this + */ + public function withSkus(?array $skus) + { + $this->skus = $skus; + + return $this; + } + + + public function build(): VariantSelection + { + return new VariantSelectionModel( + $this->type, + $this->skus + ); + } + + public static function of(): VariantSelectionBuilder + { + return new self(); + } +} diff --git a/lib/commercetools-import/src/Models/ProductSelections/VariantSelectionCollection.php b/lib/commercetools-import/src/Models/ProductSelections/VariantSelectionCollection.php new file mode 100644 index 00000000000..a33c4d707d0 --- /dev/null +++ b/lib/commercetools-import/src/Models/ProductSelections/VariantSelectionCollection.php @@ -0,0 +1,56 @@ + + * @method VariantSelection current() + * @method VariantSelection end() + * @method VariantSelection at($offset) + */ +class VariantSelectionCollection extends MapperSequence +{ + /** + * @psalm-assert VariantSelection $value + * @psalm-param VariantSelection|stdClass $value + * @throws InvalidArgumentException + * + * @return VariantSelectionCollection + */ + public function add($value) + { + if (!$value instanceof VariantSelection) { + throw new InvalidArgumentException(); + } + $this->store($value); + + return $this; + } + + /** + * @psalm-return callable(int):?VariantSelection + */ + protected function mapper() + { + return function (?int $index): ?VariantSelection { + $data = $this->get($index); + if ($data instanceof stdClass) { + /** @var VariantSelection $data */ + $data = VariantSelectionModel::of($data); + $this->set($data, $index); + } + + return $data; + }; + } +} diff --git a/lib/commercetools-import/src/Models/ProductSelections/VariantSelectionModel.php b/lib/commercetools-import/src/Models/ProductSelections/VariantSelectionModel.php new file mode 100644 index 00000000000..02538edeb3f --- /dev/null +++ b/lib/commercetools-import/src/Models/ProductSelections/VariantSelectionModel.php @@ -0,0 +1,102 @@ +type = $type; + $this->skus = $skus; + } + + /** + *Type of variant selection.
+ * + * + * @return null|string + */ + public function getType() + { + if (is_null($this->type)) { + /** @psalm-var ?string $data */ + $data = $this->raw(self::FIELD_TYPE); + if (is_null($data)) { + return null; + } + $this->type = (string) $data; + } + + return $this->type; + } + + /** + *List of SKUs to include or exclude.
+ * + * + * @return null|array + */ + public function getSkus() + { + if (is_null($this->skus)) { + /** @psalm-var ?listMoney value of this Price.
+ * * @return null|TypedMoney */ public function getValue(); /** - *A two-digit country code as per ISO 3166-1 alpha-2.
+ *Set this field if this Price is only valid for the specified country.
* * @return null|string @@ -46,7 +48,7 @@ public function getValue(); public function getCountry(); /** - *References a customer group by key.
+ *Set this field if this Price is only valid for the referenced CustomerGroup. If the referenced CustomerGroup does not exist, the state of the ImportOperation will be set to unresolved until the referenced CustomerGroup is created.
References a channel by key.
+ *Set this field if this Price is only valid for the referenced ProductDistribution Channel. If the referenced Channel does not exist, the state of the ImportOperation will be set to unresolved until the referenced Channel is created.
Set this field if this Price is only valid from the specified date and time. Must be at least 1 ms earlier than validUntil.
Set this field if this Price is only valid until the specified date and time. Must be at least 1 ms later than validFrom.
The custom fields for this category.
+ *Custom Fields for the Embedded Price.
* * @return null|Custom @@ -82,7 +88,7 @@ public function getValidUntil(); public function getCustom(); /** - *Sets a discounted price from an external service.
+ *Set this field to add a DiscountedPrice from an external service.
* * @return null|DiscountedPrice diff --git a/lib/commercetools-import/src/Models/Productdrafts/PriceDraftImportBuilder.php b/lib/commercetools-import/src/Models/Productdrafts/PriceDraftImportBuilder.php index e076c32529f..e5d9bd8926e 100644 --- a/lib/commercetools-import/src/Models/Productdrafts/PriceDraftImportBuilder.php +++ b/lib/commercetools-import/src/Models/Productdrafts/PriceDraftImportBuilder.php @@ -93,6 +93,8 @@ final class PriceDraftImportBuilder implements Builder private $key; /** + *Money value of this Price.
+ * * @return null|TypedMoney */ @@ -102,7 +104,7 @@ public function getValue() } /** - *A two-digit country code as per ISO 3166-1 alpha-2.
+ *Set this field if this Price is only valid for the specified country.
* * @return null|string @@ -113,7 +115,7 @@ public function getCountry() } /** - *References a customer group by key.
+ *Set this field if this Price is only valid for the referenced CustomerGroup. If the referenced CustomerGroup does not exist, the state of the ImportOperation will be set to unresolved until the referenced CustomerGroup is created.
References a channel by key.
+ *Set this field if this Price is only valid for the referenced ProductDistribution Channel. If the referenced Channel does not exist, the state of the ImportOperation will be set to unresolved until the referenced Channel is created.
Set this field if this Price is only valid from the specified date and time. Must be at least 1 ms earlier than validUntil.
Set this field if this Price is only valid until the specified date and time. Must be at least 1 ms later than validFrom.
The custom fields for this category.
+ *Custom Fields for the Embedded Price.
* * @return null|Custom @@ -164,7 +170,7 @@ public function getCustom() } /** - *Sets a discounted price from an external service.
+ *Set this field to add a DiscountedPrice from an external service.
* * @return null|DiscountedPrice diff --git a/lib/commercetools-import/src/Models/Productdrafts/PriceDraftImportModel.php b/lib/commercetools-import/src/Models/Productdrafts/PriceDraftImportModel.php index 03de346ff07..8010667f006 100644 --- a/lib/commercetools-import/src/Models/Productdrafts/PriceDraftImportModel.php +++ b/lib/commercetools-import/src/Models/Productdrafts/PriceDraftImportModel.php @@ -120,6 +120,8 @@ public function __construct( } /** + *Money value of this Price.
+ * * * @return null|TypedMoney */ @@ -139,7 +141,7 @@ public function getValue() } /** - *A two-digit country code as per ISO 3166-1 alpha-2.
+ *Set this field if this Price is only valid for the specified country.
* * * @return null|string @@ -159,7 +161,7 @@ public function getCountry() } /** - *References a customer group by key.
+ *Set this field if this Price is only valid for the referenced CustomerGroup. If the referenced CustomerGroup does not exist, the state of the ImportOperation will be set to unresolved until the referenced CustomerGroup is created.
References a channel by key.
+ *Set this field if this Price is only valid for the referenced ProductDistribution Channel. If the referenced Channel does not exist, the state of the ImportOperation will be set to unresolved until the referenced Channel is created.
Set this field if this Price is only valid from the specified date and time. Must be at least 1 ms earlier than validUntil.
Set this field if this Price is only valid until the specified date and time. Must be at least 1 ms later than validFrom.
The custom fields for this category.
+ *Custom Fields for the Embedded Price.
* * * @return null|Custom @@ -266,7 +272,7 @@ public function getCustom() } /** - *Sets a discounted price from an external service.
+ *Set this field to add a DiscountedPrice from an external service.
* * * @return null|DiscountedPrice diff --git a/lib/commercetools-import/src/Models/Productdrafts/ProductDraftImport.php b/lib/commercetools-import/src/Models/Productdrafts/ProductDraftImport.php index d92b4638d34..de6f97b7783 100644 --- a/lib/commercetools-import/src/Models/Productdrafts/ProductDraftImport.php +++ b/lib/commercetools-import/src/Models/Productdrafts/ProductDraftImport.php @@ -39,7 +39,7 @@ interface ProductDraftImport extends ImportResource public const FIELD_PRICE_MODE = 'priceMode'; /** - *User-defined unique identifier. If a Product with this key exists, it will be updated with the imported data.
User-defined unique identifier. If a Product with this key exists, it is updated with the imported data.
The productType of a Product.
- * Maps to Product.productType.
- * The Reference to the ProductType with which the ProductDraft is associated.
- * If referenced ProductType does not exist, the state of the ImportOperation will be set to unresolved until the necessary ProductType is created.
Maps to Product.productType. If the referenced ProductType does not exist, the state of the ImportOperation will be set to unresolved until the referenced ProductType is created.
Maps to ProductData.name.
Human-readable identifiers usually used as deep-link URL to the related product. Each slug must be unique across a project, - * but a product can have the same slug for different languages. Allowed are alphabetic, numeric, underscore (_) and hyphen (-) characters.
+ *Maps to ProductData.slug.
Maps to Product.description.
Maps to ProductData.description.
The Reference to the Categories with which the ProductDraft is associated.
- * If referenced Categories do not exist, the state of the ImportOperation will be set to unresolved until the necessary Categories are created.
Maps to ProductData.categories. If the referenced Categories do not exist, the state of the ImportOperation will be set to unresolved until the referenced Categories are created.
A localized string is a JSON object where the keys are of IETF language tag, and the values the corresponding strings used for that language.
- *{
- * "de": "Hundefutter",
- * "en": "dog food"
- * }
- *
+ * Maps to ProductData.metaTitle.
A localized string is a JSON object where the keys are of IETF language tag, and the values the corresponding strings used for that language.
- *{
- * "de": "Hundefutter",
- * "en": "dog food"
- * }
- *
+ * Maps to ProductData.metaDescription.
A localized string is a JSON object where the keys are of IETF language tag, and the values the corresponding strings used for that language.
- *{
- * "de": "Hundefutter",
- * "en": "dog food"
- * }
- *
+ * Maps to ProductData.metaKeywords.
The master Product variant.
- * Required if the variants array contains a Product Variant.
The master ProductVariant.
+ * Required if variants contains at least one ProductVariant.
An array of related Product Variants.
+ *An array of related ProductVariants.
* * @return null|ProductVariantDraftImportCollection @@ -152,8 +134,7 @@ public function getMasterVariant(); public function getVariants(); /** - *The Reference to the TaxCategory with which the ProductDraft is associated.
- * If referenced TaxCategory does not exist, the state of the ImportOperation will be set to unresolved until the necessary TaxCategory is created.
Maps to Product.taxCategory. If the referenced TaxCategory does not exist, the state of the ImportOperation will be set to unresolved until the referenced TaxCategory is created.
Search keywords are primarily used by the suggester but are also considered for the full-text search. SearchKeywords is a JSON object where the keys are of IETF language tag. The value to a language tag key is an array of SearchKeyword for the specific language.
- *{
- * "en": [
- * { "text": "Multi tool" },
- * { "text": "Swiss Army Knife", "suggestTokenizer": { "type": "whitespace" } }
- * ],
- * "de": [
- * {
- * "text": "Schweizer Messer",
- * "suggestTokenizer": {
- * "type": "custom",
- * "inputs": ["schweizer messer", "offiziersmesser", "sackmesser"]
- * }
- * }
- * ]
- * }
- *
+ * Maps to ProductData.searchKeywords.
The Reference to the State with which the ProductDraft is associated.
- * If referenced State does not exist, the state of the ImportOperation will be set to unresolved until the necessary State is created.
Maps to Product.state. If the referenced State does not exist, the state of the ImportOperation will be set to unresolved until the referenced State is created.
Determines the type of Prices the API uses. If not provided, the existing Product.priceMode is not changed.
Maps to Product.priceMode. If not provided, the existing Product.priceMode is not changed.
User-defined unique identifier. If a Product with this key exists, it will be updated with the imported data.
User-defined unique identifier. If a Product with this key exists, it is updated with the imported data.
The productType of a Product.
- * Maps to Product.productType.
- * The Reference to the ProductType with which the ProductDraft is associated.
- * If referenced ProductType does not exist, the state of the ImportOperation will be set to unresolved until the necessary ProductType is created.
Maps to Product.productType. If the referenced ProductType does not exist, the state of the ImportOperation will be set to unresolved until the referenced ProductType is created.
Maps to ProductData.name.
Human-readable identifiers usually used as deep-link URL to the related product. Each slug must be unique across a project, - * but a product can have the same slug for different languages. Allowed are alphabetic, numeric, underscore (_) and hyphen (-) characters.
+ *Maps to ProductData.slug.
Maps to Product.description.
Maps to ProductData.description.
The Reference to the Categories with which the ProductDraft is associated.
- * If referenced Categories do not exist, the state of the ImportOperation will be set to unresolved until the necessary Categories are created.
Maps to ProductData.categories. If the referenced Categories do not exist, the state of the ImportOperation will be set to unresolved until the referenced Categories are created.
A localized string is a JSON object where the keys are of IETF language tag, and the values the corresponding strings used for that language.
- *{
- * "de": "Hundefutter",
- * "en": "dog food"
- * }
- *
+ * Maps to ProductData.metaTitle.
A localized string is a JSON object where the keys are of IETF language tag, and the values the corresponding strings used for that language.
- *{
- * "de": "Hundefutter",
- * "en": "dog food"
- * }
- *
+ * Maps to ProductData.metaDescription.
A localized string is a JSON object where the keys are of IETF language tag, and the values the corresponding strings used for that language.
- *{
- * "de": "Hundefutter",
- * "en": "dog food"
- * }
- *
+ * Maps to ProductData.metaKeywords.
The master Product variant.
- * Required if the variants array contains a Product Variant.
The master ProductVariant.
+ * Required if variants contains at least one ProductVariant.
An array of related Product Variants.
+ *An array of related ProductVariants.
* * @return null|ProductVariantDraftImportCollection @@ -286,8 +268,7 @@ public function getVariants() } /** - *The Reference to the TaxCategory with which the ProductDraft is associated.
- * If referenced TaxCategory does not exist, the state of the ImportOperation will be set to unresolved until the necessary TaxCategory is created.
Maps to Product.taxCategory. If the referenced TaxCategory does not exist, the state of the ImportOperation will be set to unresolved until the referenced TaxCategory is created.
Search keywords are primarily used by the suggester but are also considered for the full-text search. SearchKeywords is a JSON object where the keys are of IETF language tag. The value to a language tag key is an array of SearchKeyword for the specific language.
- *{
- * "en": [
- * { "text": "Multi tool" },
- * { "text": "Swiss Army Knife", "suggestTokenizer": { "type": "whitespace" } }
- * ],
- * "de": [
- * {
- * "text": "Schweizer Messer",
- * "suggestTokenizer": {
- * "type": "custom",
- * "inputs": ["schweizer messer", "offiziersmesser", "sackmesser"]
- * }
- * }
- * ]
- * }
- *
+ * Maps to ProductData.searchKeywords.
The Reference to the State with which the ProductDraft is associated.
- * If referenced State does not exist, the state of the ImportOperation will be set to unresolved until the necessary State is created.
Maps to Product.state. If the referenced State does not exist, the state of the ImportOperation will be set to unresolved until the referenced State is created.
Determines the type of Prices the API uses. If not provided, the existing Product.priceMode is not changed.
Maps to Product.priceMode. If not provided, the existing Product.priceMode is not changed.
User-defined unique identifier. If a Product with this key exists, it will be updated with the imported data.
User-defined unique identifier. If a Product with this key exists, it is updated with the imported data.
The productType of a Product.
- * Maps to Product.productType.
- * The Reference to the ProductType with which the ProductDraft is associated.
- * If referenced ProductType does not exist, the state of the ImportOperation will be set to unresolved until the necessary ProductType is created.
Maps to Product.productType. If the referenced ProductType does not exist, the state of the ImportOperation will be set to unresolved until the referenced ProductType is created.
Maps to ProductData.name.
Human-readable identifiers usually used as deep-link URL to the related product. Each slug must be unique across a project, - * but a product can have the same slug for different languages. Allowed are alphabetic, numeric, underscore (_) and hyphen (-) characters.
+ *Maps to ProductData.slug.
Maps to Product.description.
Maps to ProductData.description.
The Reference to the Categories with which the ProductDraft is associated.
- * If referenced Categories do not exist, the state of the ImportOperation will be set to unresolved until the necessary Categories are created.
Maps to ProductData.categories. If the referenced Categories do not exist, the state of the ImportOperation will be set to unresolved until the referenced Categories are created.
A localized string is a JSON object where the keys are of IETF language tag, and the values the corresponding strings used for that language.
- *{
- * "de": "Hundefutter",
- * "en": "dog food"
- * }
- *
+ * Maps to ProductData.metaTitle.
A localized string is a JSON object where the keys are of IETF language tag, and the values the corresponding strings used for that language.
- *{
- * "de": "Hundefutter",
- * "en": "dog food"
- * }
- *
+ * Maps to ProductData.metaDescription.
A localized string is a JSON object where the keys are of IETF language tag, and the values the corresponding strings used for that language.
- *{
- * "de": "Hundefutter",
- * "en": "dog food"
- * }
- *
+ * Maps to ProductData.metaKeywords.
The master Product variant.
- * Required if the variants array contains a Product Variant.
The master ProductVariant.
+ * Required if variants contains at least one ProductVariant.
An array of related Product Variants.
+ *An array of related ProductVariants.
* * * @return null|ProductVariantDraftImportCollection @@ -443,8 +425,7 @@ public function getVariants() } /** - *The Reference to the TaxCategory with which the ProductDraft is associated.
- * If referenced TaxCategory does not exist, the state of the ImportOperation will be set to unresolved until the necessary TaxCategory is created.
Maps to Product.taxCategory. If the referenced TaxCategory does not exist, the state of the ImportOperation will be set to unresolved until the referenced TaxCategory is created.
Search keywords are primarily used by the suggester but are also considered for the full-text search. SearchKeywords is a JSON object where the keys are of IETF language tag. The value to a language tag key is an array of SearchKeyword for the specific language.
- *{
- * "en": [
- * { "text": "Multi tool" },
- * { "text": "Swiss Army Knife", "suggestTokenizer": { "type": "whitespace" } }
- * ],
- * "de": [
- * {
- * "text": "Schweizer Messer",
- * "suggestTokenizer": {
- * "type": "custom",
- * "inputs": ["schweizer messer", "offiziersmesser", "sackmesser"]
- * }
- * }
- * ]
- * }
- *
+ * Maps to ProductData.searchKeywords.
The Reference to the State with which the ProductDraft is associated.
- * If referenced State does not exist, the state of the ImportOperation will be set to unresolved until the necessary State is created.
Maps to Product.state. If the referenced State does not exist, the state of the ImportOperation will be set to unresolved until the referenced State is created.
Determines the type of Prices the API uses. If not provided, the existing Product.priceMode is not changed.
Maps to Product.priceMode. If not provided, the existing Product.priceMode is not changed.
User-defined unique SKU of the Product Variant.
+ * * @return null|string */ public function getSku(); /** + *User-defined unique identifier for the ProductVariant.
+ * * @return null|string */ public function getKey(); /** + *The Embedded Prices for the Product Variant.
+ * Each Price must have its unique Price scope (with same currency, country, Customer Group, Channel, validFrom and validUntil).
Attributes according to the respective AttributeDefinition.
+ * * @return null|AttributeCollection */ public function getAttributes(); /** + *Images for the Product Variant.
+ * * @return null|ImageCollection */ public function getImages(); /** + *Media assets for the Product Variant.
+ * * @return null|AssetCollection */ diff --git a/lib/commercetools-import/src/Models/Productdrafts/ProductVariantDraftImportBuilder.php b/lib/commercetools-import/src/Models/Productdrafts/ProductVariantDraftImportBuilder.php index 2a3f85ed375..a71a6ce6d75 100644 --- a/lib/commercetools-import/src/Models/Productdrafts/ProductVariantDraftImportBuilder.php +++ b/lib/commercetools-import/src/Models/Productdrafts/ProductVariantDraftImportBuilder.php @@ -60,6 +60,8 @@ final class ProductVariantDraftImportBuilder implements Builder private $assets; /** + *User-defined unique SKU of the Product Variant.
+ * * @return null|string */ @@ -69,6 +71,8 @@ public function getSku() } /** + *User-defined unique identifier for the ProductVariant.
+ * * @return null|string */ @@ -78,6 +82,9 @@ public function getKey() } /** + *The Embedded Prices for the Product Variant.
+ * Each Price must have its unique Price scope (with same currency, country, Customer Group, Channel, validFrom and validUntil).
Attributes according to the respective AttributeDefinition.
+ * * @return null|AttributeCollection */ @@ -96,6 +105,8 @@ public function getAttributes() } /** + *Images for the Product Variant.
+ * * @return null|ImageCollection */ @@ -105,6 +116,8 @@ public function getImages() } /** + *Media assets for the Product Variant.
+ * * @return null|AssetCollection */ diff --git a/lib/commercetools-import/src/Models/Productdrafts/ProductVariantDraftImportModel.php b/lib/commercetools-import/src/Models/Productdrafts/ProductVariantDraftImportModel.php index b46b9bbf59d..0b2c0171e86 100644 --- a/lib/commercetools-import/src/Models/Productdrafts/ProductVariantDraftImportModel.php +++ b/lib/commercetools-import/src/Models/Productdrafts/ProductVariantDraftImportModel.php @@ -79,6 +79,8 @@ public function __construct( } /** + *User-defined unique SKU of the Product Variant.
+ * * * @return null|string */ @@ -97,6 +99,8 @@ public function getSku() } /** + *User-defined unique identifier for the ProductVariant.
+ * * * @return null|string */ @@ -115,6 +119,9 @@ public function getKey() } /** + *The Embedded Prices for the Product Variant.
+ * Each Price must have its unique Price scope (with same currency, country, Customer Group, Channel, validFrom and validUntil).
Attributes according to the respective AttributeDefinition.
+ * * * @return null|AttributeCollection */ @@ -151,6 +160,8 @@ public function getAttributes() } /** + *Images for the Product Variant.
+ * * * @return null|ImageCollection */ @@ -169,6 +180,8 @@ public function getImages() } /** + *Media assets for the Product Variant.
+ * * * @return null|AssetCollection */ diff --git a/lib/commercetools-import/src/Models/Products/ProductImport.php b/lib/commercetools-import/src/Models/Products/ProductImport.php index c8fecd44d3a..564e8486488 100644 --- a/lib/commercetools-import/src/Models/Products/ProductImport.php +++ b/lib/commercetools-import/src/Models/Products/ProductImport.php @@ -36,7 +36,7 @@ interface ProductImport extends ImportResource public const FIELD_PRICE_MODE = 'priceMode'; /** - *User-defined unique identifier. If a Product with this key exists, it will be updated with the imported data.
User-defined unique identifier. If a Product with this key exists, it is updated with the imported data.
Maps to Product.name.
Maps to ProductData.name.
The productType of a Product.
- * Maps to Product.productType.
- * The Reference to the ProductType with which the Product is associated.
- * If referenced ProductType does not exist, the state of the ImportOperation will be set to unresolved until the necessary ProductType is created.
Maps to Product.productType. If the referenced ProductType does not exist, the state of the ImportOperation will be set to unresolved until the referenced ProductType is created.
Human-readable identifiers usually used as deep-link URL to the related product. Each slug must be unique across a Project, - * but a product can have the same slug for different languages. Allowed are alphabetic, numeric, underscore (_) and hyphen (-) characters.
+ *Maps to ProductData.slug.
Maps to Product.description.
Maps to ProductData.description.
Maps to Product.categories.
- * The References to the Categories with which the Product is associated.
- * If referenced Categories do not exist, the state of the ImportOperation will be set to unresolved until the necessary Categories are created.
Maps to ProductData.categories. If the referenced Categories do not exist, the state of the ImportOperation will be set to unresolved until the referenced Categories are created.
A localized string is a JSON object where the keys are of IETF language tag, and the values the corresponding strings used for that language.
- *{
- * "de": "Hundefutter",
- * "en": "dog food"
- * }
- *
+ * Maps to ProductData.metaTitle.
A localized string is a JSON object where the keys are of IETF language tag, and the values the corresponding strings used for that language.
- *{
- * "de": "Hundefutter",
- * "en": "dog food"
- * }
- *
+ * Maps to ProductData.metaDescription.
A localized string is a JSON object where the keys are of IETF language tag, and the values the corresponding strings used for that language.
- *{
- * "de": "Hundefutter",
- * "en": "dog food"
- * }
- *
+ * Maps to ProductData.metaKeywords.
The Reference to the TaxCategory with which the Product is associated.
- * If referenced TaxCategory does not exist, the state of the ImportOperation will be set to unresolved until the necessary TaxCategory is created.
Maps to Product.taxCategory. If the referenced TaxCategory does not exist, the state of the ImportOperation will be set to unresolved until the referenced TaxCategory is created.
Search keywords are primarily used by the suggester but are also considered for the full-text search. SearchKeywords is a JSON object where the keys are of IETF language tag. The value to a language tag key is an array of SearchKeyword for the specific language.
- *{
- * "en": [
- * { "text": "Multi tool" },
- * { "text": "Swiss Army Knife", "suggestTokenizer": { "type": "whitespace" } }
- * ],
- * "de": [
- * {
- * "text": "Schweizer Messer",
- * "suggestTokenizer": {
- * "type": "custom",
- * "inputs": ["schweizer messer", "offiziersmesser", "sackmesser"]
- * }
- * }
- * ]
- * }
- *
+ * Maps to ProductData.searchKeywords.
The Reference to the State with which the Product is associated.
- * If referenced State does not exist, the state of the ImportOperation will be set to unresolved until the necessary State is created.
Maps to Product.state. If the referenced State does not exist, the state of the ImportOperation will be set to unresolved until the referenced State is created.
Determines the type of Prices the API uses. If not provided, the existing Product.priceMode is not changed.
Maps to Product.priceMode.
User-defined unique identifier. If a Product with this key exists, it will be updated with the imported data.
User-defined unique identifier. If a Product with this key exists, it is updated with the imported data.
Maps to Product.name.
Maps to ProductData.name.
The productType of a Product.
- * Maps to Product.productType.
- * The Reference to the ProductType with which the Product is associated.
- * If referenced ProductType does not exist, the state of the ImportOperation will be set to unresolved until the necessary ProductType is created.
Maps to Product.productType. If the referenced ProductType does not exist, the state of the ImportOperation will be set to unresolved until the referenced ProductType is created.
Human-readable identifiers usually used as deep-link URL to the related product. Each slug must be unique across a Project, - * but a product can have the same slug for different languages. Allowed are alphabetic, numeric, underscore (_) and hyphen (-) characters.
+ *Maps to ProductData.slug.
Maps to Product.description.
Maps to ProductData.description.
Maps to Product.categories.
- * The References to the Categories with which the Product is associated.
- * If referenced Categories do not exist, the state of the ImportOperation will be set to unresolved until the necessary Categories are created.
Maps to ProductData.categories. If the referenced Categories do not exist, the state of the ImportOperation will be set to unresolved until the referenced Categories are created.
A localized string is a JSON object where the keys are of IETF language tag, and the values the corresponding strings used for that language.
- *{
- * "de": "Hundefutter",
- * "en": "dog food"
- * }
- *
+ * Maps to ProductData.metaTitle.
A localized string is a JSON object where the keys are of IETF language tag, and the values the corresponding strings used for that language.
- *{
- * "de": "Hundefutter",
- * "en": "dog food"
- * }
- *
+ * Maps to ProductData.metaDescription.
A localized string is a JSON object where the keys are of IETF language tag, and the values the corresponding strings used for that language.
- *{
- * "de": "Hundefutter",
- * "en": "dog food"
- * }
- *
+ * Maps to ProductData.metaKeywords.
The Reference to the TaxCategory with which the Product is associated.
- * If referenced TaxCategory does not exist, the state of the ImportOperation will be set to unresolved until the necessary TaxCategory is created.
Maps to Product.taxCategory. If the referenced TaxCategory does not exist, the state of the ImportOperation will be set to unresolved until the referenced TaxCategory is created.
Search keywords are primarily used by the suggester but are also considered for the full-text search. SearchKeywords is a JSON object where the keys are of IETF language tag. The value to a language tag key is an array of SearchKeyword for the specific language.
- *{
- * "en": [
- * { "text": "Multi tool" },
- * { "text": "Swiss Army Knife", "suggestTokenizer": { "type": "whitespace" } }
- * ],
- * "de": [
- * {
- * "text": "Schweizer Messer",
- * "suggestTokenizer": {
- * "type": "custom",
- * "inputs": ["schweizer messer", "offiziersmesser", "sackmesser"]
- * }
- * }
- * ]
- * }
- *
+ * Maps to ProductData.searchKeywords.
The Reference to the State with which the Product is associated.
- * If referenced State does not exist, the state of the ImportOperation will be set to unresolved until the necessary State is created.
Maps to Product.state. If the referenced State does not exist, the state of the ImportOperation will be set to unresolved until the referenced State is created.
Determines the type of Prices the API uses. If not provided, the existing Product.priceMode is not changed.
Maps to Product.priceMode.
User-defined unique identifier. If a Product with this key exists, it will be updated with the imported data.
User-defined unique identifier. If a Product with this key exists, it is updated with the imported data.
Maps to Product.name.
Maps to ProductData.name.
The productType of a Product.
- * Maps to Product.productType.
- * The Reference to the ProductType with which the Product is associated.
- * If referenced ProductType does not exist, the state of the ImportOperation will be set to unresolved until the necessary ProductType is created.
Maps to Product.productType. If the referenced ProductType does not exist, the state of the ImportOperation will be set to unresolved until the referenced ProductType is created.
Human-readable identifiers usually used as deep-link URL to the related product. Each slug must be unique across a Project, - * but a product can have the same slug for different languages. Allowed are alphabetic, numeric, underscore (_) and hyphen (-) characters.
+ *Maps to ProductData.slug.
Maps to Product.description.
Maps to ProductData.description.
Maps to Product.categories.
- * The References to the Categories with which the Product is associated.
- * If referenced Categories do not exist, the state of the ImportOperation will be set to unresolved until the necessary Categories are created.
Maps to ProductData.categories. If the referenced Categories do not exist, the state of the ImportOperation will be set to unresolved until the referenced Categories are created.
A localized string is a JSON object where the keys are of IETF language tag, and the values the corresponding strings used for that language.
- *{
- * "de": "Hundefutter",
- * "en": "dog food"
- * }
- *
+ * Maps to ProductData.metaTitle.
A localized string is a JSON object where the keys are of IETF language tag, and the values the corresponding strings used for that language.
- *{
- * "de": "Hundefutter",
- * "en": "dog food"
- * }
- *
+ * Maps to ProductData.metaDescription.
A localized string is a JSON object where the keys are of IETF language tag, and the values the corresponding strings used for that language.
- *{
- * "de": "Hundefutter",
- * "en": "dog food"
- * }
- *
+ * Maps to ProductData.metaKeywords.
The Reference to the TaxCategory with which the Product is associated.
- * If referenced TaxCategory does not exist, the state of the ImportOperation will be set to unresolved until the necessary TaxCategory is created.
Maps to Product.taxCategory. If the referenced TaxCategory does not exist, the state of the ImportOperation will be set to unresolved until the referenced TaxCategory is created.
Search keywords are primarily used by the suggester but are also considered for the full-text search. SearchKeywords is a JSON object where the keys are of IETF language tag. The value to a language tag key is an array of SearchKeyword for the specific language.
- *{
- * "en": [
- * { "text": "Multi tool" },
- * { "text": "Swiss Army Knife", "suggestTokenizer": { "type": "whitespace" } }
- * ],
- * "de": [
- * {
- * "text": "Schweizer Messer",
- * "suggestTokenizer": {
- * "type": "custom",
- * "inputs": ["schweizer messer", "offiziersmesser", "sackmesser"]
- * }
- * }
- * ]
- * }
- *
+ * Maps to ProductData.searchKeywords.
The Reference to the State with which the Product is associated.
- * If referenced State does not exist, the state of the ImportOperation will be set to unresolved until the necessary State is created.
Maps to Product.state. If the referenced State does not exist, the state of the ImportOperation will be set to unresolved until the referenced State is created.
Determines the type of Prices the API uses. If not provided, the existing Product.priceMode is not changed.
Maps to Product.priceMode.
Describes the Type of the Attribute.
+ * * @return null|AttributeType */ public function getType(); /** + *User-defined name of the Attribute that is unique within the Project.
+ * * @return null|string */ public function getName(); /** - *A localized string is a JSON object where the keys are of IETF language tag, and the values the corresponding strings used for that language.
- *{
- * "de": "Hundefutter",
- * "en": "dog food"
- * }
- *
+ * Human-readable label for the Attribute.
* * @return null|LocalizedString @@ -50,24 +49,23 @@ public function getName(); public function getLabel(); /** + *If true, the Attribute must have a value on a ProductVariant.
Specifies how Attributes are validated across all variants of a Product.
+ * * @return null|string */ public function getAttributeConstraint(); /** - *A localized string is a JSON object where the keys are of IETF language tag, and the values the corresponding strings used for that language.
- *{
- * "de": "Hundefutter",
- * "en": "dog food"
- * }
- *
+ * Provides additional Attribute information to aid content managers configure Product details.
* * @return null|LocalizedString @@ -75,12 +73,16 @@ public function getAttributeConstraint(); public function getInputTip(); /** + *Provides a visual representation directive for values of this Attribute (only relevant for AttributeTextType and AttributeLocalizableTextType).
+ * * @return null|string */ public function getInputHint(); /** + *If true, the Attribute's values are available in the Product Search or the Product Projection Search API for use in full-text search queries, filters, and facets.
Describes the Type of the Attribute.
+ * * @return null|AttributeType */ @@ -86,6 +88,8 @@ public function getType() } /** + *User-defined name of the Attribute that is unique within the Project.
+ * * @return null|string */ @@ -95,12 +99,7 @@ public function getName() } /** - *A localized string is a JSON object where the keys are of IETF language tag, and the values the corresponding strings used for that language.
- *{
- * "de": "Hundefutter",
- * "en": "dog food"
- * }
- *
+ * Human-readable label for the Attribute.
* * @return null|LocalizedString @@ -111,6 +110,8 @@ public function getLabel() } /** + *If true, the Attribute must have a value on a ProductVariant.
Specifies how Attributes are validated across all variants of a Product.
+ * * @return null|string */ @@ -129,12 +132,7 @@ public function getAttributeConstraint() } /** - *A localized string is a JSON object where the keys are of IETF language tag, and the values the corresponding strings used for that language.
- *{
- * "de": "Hundefutter",
- * "en": "dog food"
- * }
- *
+ * Provides additional Attribute information to aid content managers configure Product details.
* * @return null|LocalizedString @@ -145,6 +143,8 @@ public function getInputTip() } /** + *Provides a visual representation directive for values of this Attribute (only relevant for AttributeTextType and AttributeLocalizableTextType).
+ * * @return null|string */ @@ -154,6 +154,8 @@ public function getInputHint() } /** + *If true, the Attribute's values are available in the Product Search or the Product Projection Search API for use in full-text search queries, filters, and facets.
Describes the Type of the Attribute.
+ * * * @return null|AttributeType */ @@ -121,6 +123,8 @@ public function getType() } /** + *User-defined name of the Attribute that is unique within the Project.
+ * * * @return null|string */ @@ -139,12 +143,7 @@ public function getName() } /** - *A localized string is a JSON object where the keys are of IETF language tag, and the values the corresponding strings used for that language.
- *{
- * "de": "Hundefutter",
- * "en": "dog food"
- * }
- *
+ * Human-readable label for the Attribute.
* * * @return null|LocalizedString @@ -165,6 +164,8 @@ public function getLabel() } /** + *If true, the Attribute must have a value on a ProductVariant.
Specifies how Attributes are validated across all variants of a Product.
+ * * * @return null|string */ @@ -201,12 +204,7 @@ public function getAttributeConstraint() } /** - *A localized string is a JSON object where the keys are of IETF language tag, and the values the corresponding strings used for that language.
- *{
- * "de": "Hundefutter",
- * "en": "dog food"
- * }
- *
+ * Provides additional Attribute information to aid content managers configure Product details.
* * * @return null|LocalizedString @@ -227,6 +225,8 @@ public function getInputTip() } /** + *Provides a visual representation directive for values of this Attribute (only relevant for AttributeTextType and AttributeLocalizableTextType).
+ * * * @return null|string */ @@ -245,6 +245,8 @@ public function getInputHint() } /** + *If true, the Attribute's values are available in the Product Search or the Product Projection Search API for use in full-text search queries, filters, and facets.
References a product type by key.
+ *References a ProductType by key.
References a product type by key.
+ *References a ProductType by key.
References a product type by key.
+ *References a ProductType by key.
The type of the referenced resource.
+ *Type of referenced resource.
* * @return null|string diff --git a/lib/commercetools-import/src/Models/Producttypes/AttributeReferenceTypeBuilder.php b/lib/commercetools-import/src/Models/Producttypes/AttributeReferenceTypeBuilder.php index 8387fe8298e..f68efc208d2 100644 --- a/lib/commercetools-import/src/Models/Producttypes/AttributeReferenceTypeBuilder.php +++ b/lib/commercetools-import/src/Models/Producttypes/AttributeReferenceTypeBuilder.php @@ -27,7 +27,7 @@ final class AttributeReferenceTypeBuilder implements Builder private $referenceTypeId; /** - *The type of the referenced resource.
+ *Type of referenced resource.
* * @return null|string diff --git a/lib/commercetools-import/src/Models/Producttypes/AttributeReferenceTypeModel.php b/lib/commercetools-import/src/Models/Producttypes/AttributeReferenceTypeModel.php index 588d7ffdf0f..18e105e7a19 100644 --- a/lib/commercetools-import/src/Models/Producttypes/AttributeReferenceTypeModel.php +++ b/lib/commercetools-import/src/Models/Producttypes/AttributeReferenceTypeModel.php @@ -63,7 +63,7 @@ public function getName() } /** - *The type of the referenced resource.
+ *Type of referenced resource.
* * * @return null|string diff --git a/lib/commercetools-import/src/Models/Producttypes/ProductTypeImport.php b/lib/commercetools-import/src/Models/Producttypes/ProductTypeImport.php index 6246c7dfc72..6e24e55684e 100644 --- a/lib/commercetools-import/src/Models/Producttypes/ProductTypeImport.php +++ b/lib/commercetools-import/src/Models/Producttypes/ProductTypeImport.php @@ -19,7 +19,7 @@ interface ProductTypeImport extends ImportResource public const FIELD_ATTRIBUTES = 'attributes'; /** - *User-defined unique identifier. If a ProductType with this key exists, it will be updated with the imported data.
User-defined unique identifier. If a ProductType with this key exists, it is updated with the imported data.
User-defined unique identifier. If a ProductType with this key exists, it will be updated with the imported data.
User-defined unique identifier. If a ProductType with this key exists, it is updated with the imported data.
User-defined unique identifier. If a ProductType with this key exists, it will be updated with the imported data.
User-defined unique identifier. If a ProductType with this key exists, it is updated with the imported data.
The name of this attribute must match a name of the product types attribute definitions. - * The name is required if this type is used in a product variant and must not be set when - * used in a product variant patch.
+ *Required if used for ProductVariantImport. + * Must not be set if used for ProductVariantPatch.
+ *Must match name of an AttributeDefinition of the Product Type.
Must match type of an AttributeDefinition of the Product Type.
+ * The type is required if this type is used in a product variant and must not be set when
+ * used in a product variant patch.
The name of this attribute must match a name of the product types attribute definitions. - * The name is required if this type is used in a product variant and must not be set when - * used in a product variant patch.
+ *Required if used for ProductVariantImport. + * Must not be set if used for ProductVariantPatch.
+ *Must match name of an AttributeDefinition of the Product Type.
The name of this attribute must match a name of the product types attribute definitions. - * The name is required if this type is used in a product variant and must not be set when - * used in a product variant patch.
+ *Required if used for ProductVariantImport. + * Must not be set if used for ProductVariantPatch.
+ *Must match name of an AttributeDefinition of the Product Type.
Must match type of an AttributeDefinition of the Product Type.
+ * The type is required if this type is used in a product variant and must not be set when
+ * used in a product variant patch.
true or false
The name of this attribute must match a name of the product types attribute definitions. - * The name is required if this type is used in a product variant and must not be set when - * used in a product variant patch.
+ *Required if used for ProductVariantImport. + * Must not be set if used for ProductVariantPatch.
+ *Must match name of an AttributeDefinition of the Product Type.
true or false
The name of this attribute must match a name of the product types attribute definitions. - * The name is required if this type is used in a product variant and must not be set when - * used in a product variant patch.
+ *Required if used for ProductVariantImport. + * Must not be set if used for ProductVariantPatch.
+ *Must match name of an AttributeDefinition of the Product Type.
Must match type of an AttributeDefinition of the Product Type.
+ * The type is required if this type is used in a product variant and must not be set when
+ * used in a product variant patch.
true or false
A set of boolean values.
+ * * @return null|array */ diff --git a/lib/commercetools-import/src/Models/Productvariants/BooleanSetAttributeBuilder.php b/lib/commercetools-import/src/Models/Productvariants/BooleanSetAttributeBuilder.php index 31d58989477..7a71eb710c1 100644 --- a/lib/commercetools-import/src/Models/Productvariants/BooleanSetAttributeBuilder.php +++ b/lib/commercetools-import/src/Models/Productvariants/BooleanSetAttributeBuilder.php @@ -33,9 +33,9 @@ final class BooleanSetAttributeBuilder implements Builder private $value; /** - *The name of this attribute must match a name of the product types attribute definitions. - * The name is required if this type is used in a product variant and must not be set when - * used in a product variant patch.
+ *Required if used for ProductVariantImport. + * Must not be set if used for ProductVariantPatch.
+ *Must match name of an AttributeDefinition of the Product Type.
A set of boolean values.
+ * * @return null|array */ diff --git a/lib/commercetools-import/src/Models/Productvariants/BooleanSetAttributeModel.php b/lib/commercetools-import/src/Models/Productvariants/BooleanSetAttributeModel.php index 3c24261d288..99204433fe0 100644 --- a/lib/commercetools-import/src/Models/Productvariants/BooleanSetAttributeModel.php +++ b/lib/commercetools-import/src/Models/Productvariants/BooleanSetAttributeModel.php @@ -53,9 +53,9 @@ public function __construct( } /** - *The name of this attribute must match a name of the product types attribute definitions. - * The name is required if this type is used in a product variant and must not be set when - * used in a product variant patch.
+ *Required if used for ProductVariantImport. + * Must not be set if used for ProductVariantPatch.
+ *Must match name of an AttributeDefinition of the Product Type.
Must match type of an AttributeDefinition of the Product Type.
+ * The type is required if this type is used in a product variant and must not be set when
+ * used in a product variant patch.
A set of boolean values.
+ * * * @return null|array */ diff --git a/lib/commercetools-import/src/Models/Productvariants/DateAttribute.php b/lib/commercetools-import/src/Models/Productvariants/DateAttribute.php index 94156f9fd93..a333f238fe4 100644 --- a/lib/commercetools-import/src/Models/Productvariants/DateAttribute.php +++ b/lib/commercetools-import/src/Models/Productvariants/DateAttribute.php @@ -17,6 +17,8 @@ interface DateAttribute extends Attribute public const FIELD_VALUE = 'value'; /** + *A date in the format YYYY-MM-DD.
The name of this attribute must match a name of the product types attribute definitions. - * The name is required if this type is used in a product variant and must not be set when - * used in a product variant patch.
+ *Required if used for ProductVariantImport. + * Must not be set if used for ProductVariantPatch.
+ *Must match name of an AttributeDefinition of the Product Type.
A date in the format YYYY-MM-DD.
The name of this attribute must match a name of the product types attribute definitions. - * The name is required if this type is used in a product variant and must not be set when - * used in a product variant patch.
+ *Required if used for ProductVariantImport. + * Must not be set if used for ProductVariantPatch.
+ *Must match name of an AttributeDefinition of the Product Type.
Must match type of an AttributeDefinition of the Product Type.
+ * The type is required if this type is used in a product variant and must not be set when
+ * used in a product variant patch.
A date in the format YYYY-MM-DD.
A set of dates in the format YYYY-MM-DD.
The name of this attribute must match a name of the product types attribute definitions. - * The name is required if this type is used in a product variant and must not be set when - * used in a product variant patch.
+ *Required if used for ProductVariantImport. + * Must not be set if used for ProductVariantPatch.
+ *Must match name of an AttributeDefinition of the Product Type.
A set of dates in the format YYYY-MM-DD.
The name of this attribute must match a name of the product types attribute definitions. - * The name is required if this type is used in a product variant and must not be set when - * used in a product variant patch.
+ *Required if used for ProductVariantImport. + * Must not be set if used for ProductVariantPatch.
+ *Must match name of an AttributeDefinition of the Product Type.
Must match type of an AttributeDefinition of the Product Type.
+ * The type is required if this type is used in a product variant and must not be set when
+ * used in a product variant patch.
A set of dates in the format YYYY-MM-DD.
A date with time in the format YYYY-MM-DDTHH:mm:ss.SSSZ.
+ * The time zone is optional and defaults to UTC if not specified.
+ * If the time zone is specified, it must be in the format ±HH:mm or Z for UTC.
The name of this attribute must match a name of the product types attribute definitions. - * The name is required if this type is used in a product variant and must not be set when - * used in a product variant patch.
+ *Required if used for ProductVariantImport. + * Must not be set if used for ProductVariantPatch.
+ *Must match name of an AttributeDefinition of the Product Type.
A date with time in the format YYYY-MM-DDTHH:mm:ss.SSSZ.
+ * The time zone is optional and defaults to UTC if not specified.
+ * If the time zone is specified, it must be in the format ±HH:mm or Z for UTC.
The name of this attribute must match a name of the product types attribute definitions. - * The name is required if this type is used in a product variant and must not be set when - * used in a product variant patch.
+ *Required if used for ProductVariantImport. + * Must not be set if used for ProductVariantPatch.
+ *Must match name of an AttributeDefinition of the Product Type.
Must match type of an AttributeDefinition of the Product Type.
+ * The type is required if this type is used in a product variant and must not be set when
+ * used in a product variant patch.
A date with time in the format YYYY-MM-DDTHH:mm:ss.SSSZ.
+ * The time zone is optional and defaults to UTC if not specified.
+ * If the time zone is specified, it must be in the format ±HH:mm or Z for UTC.
A set of dates with time in the format YYYY-MM-DDTHH:mm:ss.SSSZ.
+ * The time zone is optional and defaults to UTC if not specified.
+ * If the time zone is specified, it must be in the format ±HH:mm or Z for UTC.
The name of this attribute must match a name of the product types attribute definitions. - * The name is required if this type is used in a product variant and must not be set when - * used in a product variant patch.
+ *Required if used for ProductVariantImport. + * Must not be set if used for ProductVariantPatch.
+ *Must match name of an AttributeDefinition of the Product Type.
A set of dates with time in the format YYYY-MM-DDTHH:mm:ss.SSSZ.
+ * The time zone is optional and defaults to UTC if not specified.
+ * If the time zone is specified, it must be in the format ±HH:mm or Z for UTC.
The name of this attribute must match a name of the product types attribute definitions. - * The name is required if this type is used in a product variant and must not be set when - * used in a product variant patch.
+ *Required if used for ProductVariantImport. + * Must not be set if used for ProductVariantPatch.
+ *Must match name of an AttributeDefinition of the Product Type.
Must match type of an AttributeDefinition of the Product Type.
+ * The type is required if this type is used in a product variant and must not be set when
+ * used in a product variant patch.
A set of dates with time in the format YYYY-MM-DDTHH:mm:ss.SSSZ.
+ * The time zone is optional and defaults to UTC if not specified.
+ * If the time zone is specified, it must be in the format ±HH:mm or Z for UTC.
The key of the enum value. + * Must match the key of an AttributePlainEnumValue in the Product Type.
+ * * @return null|string */ diff --git a/lib/commercetools-import/src/Models/Productvariants/EnumAttributeBuilder.php b/lib/commercetools-import/src/Models/Productvariants/EnumAttributeBuilder.php index 8a74ca7998a..160ca40deb9 100644 --- a/lib/commercetools-import/src/Models/Productvariants/EnumAttributeBuilder.php +++ b/lib/commercetools-import/src/Models/Productvariants/EnumAttributeBuilder.php @@ -33,9 +33,9 @@ final class EnumAttributeBuilder implements Builder private $value; /** - *The name of this attribute must match a name of the product types attribute definitions. - * The name is required if this type is used in a product variant and must not be set when - * used in a product variant patch.
+ *Required if used for ProductVariantImport. + * Must not be set if used for ProductVariantPatch.
+ *Must match name of an AttributeDefinition of the Product Type.
The key of the enum value. + * Must match the key of an AttributePlainEnumValue in the Product Type.
+ * * @return null|string */ diff --git a/lib/commercetools-import/src/Models/Productvariants/EnumAttributeModel.php b/lib/commercetools-import/src/Models/Productvariants/EnumAttributeModel.php index a977bcea93d..76570d76e4b 100644 --- a/lib/commercetools-import/src/Models/Productvariants/EnumAttributeModel.php +++ b/lib/commercetools-import/src/Models/Productvariants/EnumAttributeModel.php @@ -53,9 +53,9 @@ public function __construct( } /** - *The name of this attribute must match a name of the product types attribute definitions. - * The name is required if this type is used in a product variant and must not be set when - * used in a product variant patch.
+ *Required if used for ProductVariantImport. + * Must not be set if used for ProductVariantPatch.
+ *Must match name of an AttributeDefinition of the Product Type.
Must match type of an AttributeDefinition of the Product Type.
+ * The type is required if this type is used in a product variant and must not be set when
+ * used in a product variant patch.
The key of the enum value. + * Must match the key of an AttributePlainEnumValue in the Product Type.
+ * * * @return null|string */ diff --git a/lib/commercetools-import/src/Models/Productvariants/EnumSetAttribute.php b/lib/commercetools-import/src/Models/Productvariants/EnumSetAttribute.php index babc3e6f327..e0e528b2eda 100644 --- a/lib/commercetools-import/src/Models/Productvariants/EnumSetAttribute.php +++ b/lib/commercetools-import/src/Models/Productvariants/EnumSetAttribute.php @@ -16,6 +16,9 @@ interface EnumSetAttribute extends Attribute public const FIELD_VALUE = 'value'; /** + *A set of enum values, each represented by its key. + * Each key must match the key of an AttributePlainEnumValue in the Product Type.
+ * * @return null|array */ diff --git a/lib/commercetools-import/src/Models/Productvariants/EnumSetAttributeBuilder.php b/lib/commercetools-import/src/Models/Productvariants/EnumSetAttributeBuilder.php index c0bb97babdb..9bf472c6afa 100644 --- a/lib/commercetools-import/src/Models/Productvariants/EnumSetAttributeBuilder.php +++ b/lib/commercetools-import/src/Models/Productvariants/EnumSetAttributeBuilder.php @@ -33,9 +33,9 @@ final class EnumSetAttributeBuilder implements Builder private $value; /** - *The name of this attribute must match a name of the product types attribute definitions. - * The name is required if this type is used in a product variant and must not be set when - * used in a product variant patch.
+ *Required if used for ProductVariantImport. + * Must not be set if used for ProductVariantPatch.
+ *Must match name of an AttributeDefinition of the Product Type.
A set of enum values, each represented by its key. + * Each key must match the key of an AttributePlainEnumValue in the Product Type.
+ * * @return null|array */ diff --git a/lib/commercetools-import/src/Models/Productvariants/EnumSetAttributeModel.php b/lib/commercetools-import/src/Models/Productvariants/EnumSetAttributeModel.php index bc9a8502a72..a3b56f4236b 100644 --- a/lib/commercetools-import/src/Models/Productvariants/EnumSetAttributeModel.php +++ b/lib/commercetools-import/src/Models/Productvariants/EnumSetAttributeModel.php @@ -53,9 +53,9 @@ public function __construct( } /** - *The name of this attribute must match a name of the product types attribute definitions. - * The name is required if this type is used in a product variant and must not be set when - * used in a product variant patch.
+ *Required if used for ProductVariantImport. + * Must not be set if used for ProductVariantPatch.
+ *Must match name of an AttributeDefinition of the Product Type.
Must match type of an AttributeDefinition of the Product Type.
+ * The type is required if this type is used in a product variant and must not be set when
+ * used in a product variant patch.
A set of enum values, each represented by its key. + * Each key must match the key of an AttributePlainEnumValue in the Product Type.
+ * * * @return null|array */ diff --git a/lib/commercetools-import/src/Models/Productvariants/LocalizableEnumAttribute.php b/lib/commercetools-import/src/Models/Productvariants/LocalizableEnumAttribute.php index 3afe9f1263b..6359d32ea59 100644 --- a/lib/commercetools-import/src/Models/Productvariants/LocalizableEnumAttribute.php +++ b/lib/commercetools-import/src/Models/Productvariants/LocalizableEnumAttribute.php @@ -16,6 +16,9 @@ interface LocalizableEnumAttribute extends Attribute public const FIELD_VALUE = 'value'; /** + *The key of the localized enum value. + * Must match the key of an AttributeLocalizedEnumValue in the Product Type.
+ * * @return null|string */ diff --git a/lib/commercetools-import/src/Models/Productvariants/LocalizableEnumAttributeBuilder.php b/lib/commercetools-import/src/Models/Productvariants/LocalizableEnumAttributeBuilder.php index f0128c7e492..418a380f277 100644 --- a/lib/commercetools-import/src/Models/Productvariants/LocalizableEnumAttributeBuilder.php +++ b/lib/commercetools-import/src/Models/Productvariants/LocalizableEnumAttributeBuilder.php @@ -33,9 +33,9 @@ final class LocalizableEnumAttributeBuilder implements Builder private $value; /** - *The name of this attribute must match a name of the product types attribute definitions. - * The name is required if this type is used in a product variant and must not be set when - * used in a product variant patch.
+ *Required if used for ProductVariantImport. + * Must not be set if used for ProductVariantPatch.
+ *Must match name of an AttributeDefinition of the Product Type.
The key of the localized enum value. + * Must match the key of an AttributeLocalizedEnumValue in the Product Type.
+ * * @return null|string */ diff --git a/lib/commercetools-import/src/Models/Productvariants/LocalizableEnumAttributeModel.php b/lib/commercetools-import/src/Models/Productvariants/LocalizableEnumAttributeModel.php index 368763a937d..95431c710be 100644 --- a/lib/commercetools-import/src/Models/Productvariants/LocalizableEnumAttributeModel.php +++ b/lib/commercetools-import/src/Models/Productvariants/LocalizableEnumAttributeModel.php @@ -53,9 +53,9 @@ public function __construct( } /** - *The name of this attribute must match a name of the product types attribute definitions. - * The name is required if this type is used in a product variant and must not be set when - * used in a product variant patch.
+ *Required if used for ProductVariantImport. + * Must not be set if used for ProductVariantPatch.
+ *Must match name of an AttributeDefinition of the Product Type.
Must match type of an AttributeDefinition of the Product Type.
+ * The type is required if this type is used in a product variant and must not be set when
+ * used in a product variant patch.
The key of the localized enum value. + * Must match the key of an AttributeLocalizedEnumValue in the Product Type.
+ * * * @return null|string */ diff --git a/lib/commercetools-import/src/Models/Productvariants/LocalizableEnumSetAttribute.php b/lib/commercetools-import/src/Models/Productvariants/LocalizableEnumSetAttribute.php index aea7a31de5e..084ff72a4bf 100644 --- a/lib/commercetools-import/src/Models/Productvariants/LocalizableEnumSetAttribute.php +++ b/lib/commercetools-import/src/Models/Productvariants/LocalizableEnumSetAttribute.php @@ -16,6 +16,9 @@ interface LocalizableEnumSetAttribute extends Attribute public const FIELD_VALUE = 'value'; /** + *A set of localized enum values, each represented by its key. + * Each key must match the key of an AttributeLocalizedEnumValue in the Product Type.
+ * * @return null|array */ diff --git a/lib/commercetools-import/src/Models/Productvariants/LocalizableEnumSetAttributeBuilder.php b/lib/commercetools-import/src/Models/Productvariants/LocalizableEnumSetAttributeBuilder.php index 9ff5267239f..b6b6ea768e4 100644 --- a/lib/commercetools-import/src/Models/Productvariants/LocalizableEnumSetAttributeBuilder.php +++ b/lib/commercetools-import/src/Models/Productvariants/LocalizableEnumSetAttributeBuilder.php @@ -33,9 +33,9 @@ final class LocalizableEnumSetAttributeBuilder implements Builder private $value; /** - *The name of this attribute must match a name of the product types attribute definitions. - * The name is required if this type is used in a product variant and must not be set when - * used in a product variant patch.
+ *Required if used for ProductVariantImport. + * Must not be set if used for ProductVariantPatch.
+ *Must match name of an AttributeDefinition of the Product Type.
A set of localized enum values, each represented by its key. + * Each key must match the key of an AttributeLocalizedEnumValue in the Product Type.
+ * * @return null|array */ diff --git a/lib/commercetools-import/src/Models/Productvariants/LocalizableEnumSetAttributeModel.php b/lib/commercetools-import/src/Models/Productvariants/LocalizableEnumSetAttributeModel.php index 7cdbfb0c378..21e5764f619 100644 --- a/lib/commercetools-import/src/Models/Productvariants/LocalizableEnumSetAttributeModel.php +++ b/lib/commercetools-import/src/Models/Productvariants/LocalizableEnumSetAttributeModel.php @@ -53,9 +53,9 @@ public function __construct( } /** - *The name of this attribute must match a name of the product types attribute definitions. - * The name is required if this type is used in a product variant and must not be set when - * used in a product variant patch.
+ *Required if used for ProductVariantImport. + * Must not be set if used for ProductVariantPatch.
+ *Must match name of an AttributeDefinition of the Product Type.
Must match type of an AttributeDefinition of the Product Type.
+ * The type is required if this type is used in a product variant and must not be set when
+ * used in a product variant patch.
A set of localized enum values, each represented by its key. + * Each key must match the key of an AttributeLocalizedEnumValue in the Product Type.
+ * * * @return null|array */ diff --git a/lib/commercetools-import/src/Models/Productvariants/LocalizableTextAttribute.php b/lib/commercetools-import/src/Models/Productvariants/LocalizableTextAttribute.php index 04dbde3bdf2..d7968bf0c4e 100644 --- a/lib/commercetools-import/src/Models/Productvariants/LocalizableTextAttribute.php +++ b/lib/commercetools-import/src/Models/Productvariants/LocalizableTextAttribute.php @@ -17,12 +17,7 @@ interface LocalizableTextAttribute extends Attribute public const FIELD_VALUE = 'value'; /** - *A localized string is a JSON object where the keys are of IETF language tag, and the values the corresponding strings used for that language.
- *{
- * "de": "Hundefutter",
- * "en": "dog food"
- * }
- *
+ * A localized string.
* * @return null|LocalizedString diff --git a/lib/commercetools-import/src/Models/Productvariants/LocalizableTextAttributeBuilder.php b/lib/commercetools-import/src/Models/Productvariants/LocalizableTextAttributeBuilder.php index 21ee0c1bb6f..a1d214a601d 100644 --- a/lib/commercetools-import/src/Models/Productvariants/LocalizableTextAttributeBuilder.php +++ b/lib/commercetools-import/src/Models/Productvariants/LocalizableTextAttributeBuilder.php @@ -35,9 +35,9 @@ final class LocalizableTextAttributeBuilder implements Builder private $value; /** - *The name of this attribute must match a name of the product types attribute definitions. - * The name is required if this type is used in a product variant and must not be set when - * used in a product variant patch.
+ *Required if used for ProductVariantImport. + * Must not be set if used for ProductVariantPatch.
+ *Must match name of an AttributeDefinition of the Product Type.
A localized string is a JSON object where the keys are of IETF language tag, and the values the corresponding strings used for that language.
- *{
- * "de": "Hundefutter",
- * "en": "dog food"
- * }
- *
+ * A localized string.
* * @return null|LocalizedString diff --git a/lib/commercetools-import/src/Models/Productvariants/LocalizableTextAttributeModel.php b/lib/commercetools-import/src/Models/Productvariants/LocalizableTextAttributeModel.php index 85dac39977f..7c3b98edafa 100644 --- a/lib/commercetools-import/src/Models/Productvariants/LocalizableTextAttributeModel.php +++ b/lib/commercetools-import/src/Models/Productvariants/LocalizableTextAttributeModel.php @@ -55,9 +55,9 @@ public function __construct( } /** - *The name of this attribute must match a name of the product types attribute definitions. - * The name is required if this type is used in a product variant and must not be set when - * used in a product variant patch.
+ *Required if used for ProductVariantImport. + * Must not be set if used for ProductVariantPatch.
+ *Must match name of an AttributeDefinition of the Product Type.
Must match type of an AttributeDefinition of the Product Type.
+ * The type is required if this type is used in a product variant and must not be set when
+ * used in a product variant patch.
A localized string is a JSON object where the keys are of IETF language tag, and the values the corresponding strings used for that language.
- *{
- * "de": "Hundefutter",
- * "en": "dog food"
- * }
- *
+ * A localized string.
* * * @return null|LocalizedString diff --git a/lib/commercetools-import/src/Models/Productvariants/LocalizableTextSetAttribute.php b/lib/commercetools-import/src/Models/Productvariants/LocalizableTextSetAttribute.php index aa90774b8fe..58d55d97856 100644 --- a/lib/commercetools-import/src/Models/Productvariants/LocalizableTextSetAttribute.php +++ b/lib/commercetools-import/src/Models/Productvariants/LocalizableTextSetAttribute.php @@ -17,6 +17,8 @@ interface LocalizableTextSetAttribute extends Attribute public const FIELD_VALUE = 'value'; /** + *A set of localized strings.
+ * * @return null|LocalizedStringCollection */ diff --git a/lib/commercetools-import/src/Models/Productvariants/LocalizableTextSetAttributeBuilder.php b/lib/commercetools-import/src/Models/Productvariants/LocalizableTextSetAttributeBuilder.php index abf879b2379..7216ff581db 100644 --- a/lib/commercetools-import/src/Models/Productvariants/LocalizableTextSetAttributeBuilder.php +++ b/lib/commercetools-import/src/Models/Productvariants/LocalizableTextSetAttributeBuilder.php @@ -34,9 +34,9 @@ final class LocalizableTextSetAttributeBuilder implements Builder private $value; /** - *The name of this attribute must match a name of the product types attribute definitions. - * The name is required if this type is used in a product variant and must not be set when - * used in a product variant patch.
+ *Required if used for ProductVariantImport. + * Must not be set if used for ProductVariantPatch.
+ *Must match name of an AttributeDefinition of the Product Type.
A set of localized strings.
+ * * @return null|LocalizedStringCollection */ diff --git a/lib/commercetools-import/src/Models/Productvariants/LocalizableTextSetAttributeModel.php b/lib/commercetools-import/src/Models/Productvariants/LocalizableTextSetAttributeModel.php index 46376452f9a..a7aabb087cd 100644 --- a/lib/commercetools-import/src/Models/Productvariants/LocalizableTextSetAttributeModel.php +++ b/lib/commercetools-import/src/Models/Productvariants/LocalizableTextSetAttributeModel.php @@ -54,9 +54,9 @@ public function __construct( } /** - *The name of this attribute must match a name of the product types attribute definitions. - * The name is required if this type is used in a product variant and must not be set when - * used in a product variant patch.
+ *Required if used for ProductVariantImport. + * Must not be set if used for ProductVariantPatch.
+ *Must match name of an AttributeDefinition of the Product Type.
Must match type of an AttributeDefinition of the Product Type.
+ * The type is required if this type is used in a product variant and must not be set when
+ * used in a product variant patch.
A set of localized strings.
+ * * * @return null|LocalizedStringCollection */ diff --git a/lib/commercetools-import/src/Models/Productvariants/MoneyAttribute.php b/lib/commercetools-import/src/Models/Productvariants/MoneyAttribute.php index d57f075564e..2269995ae73 100644 --- a/lib/commercetools-import/src/Models/Productvariants/MoneyAttribute.php +++ b/lib/commercetools-import/src/Models/Productvariants/MoneyAttribute.php @@ -17,6 +17,8 @@ interface MoneyAttribute extends Attribute public const FIELD_VALUE = 'value'; /** + *A money value in cent precision format.
+ * * @return null|TypedMoney */ diff --git a/lib/commercetools-import/src/Models/Productvariants/MoneyAttributeBuilder.php b/lib/commercetools-import/src/Models/Productvariants/MoneyAttributeBuilder.php index 4dc7f22afcc..d7679f990bf 100644 --- a/lib/commercetools-import/src/Models/Productvariants/MoneyAttributeBuilder.php +++ b/lib/commercetools-import/src/Models/Productvariants/MoneyAttributeBuilder.php @@ -35,9 +35,9 @@ final class MoneyAttributeBuilder implements Builder private $value; /** - *The name of this attribute must match a name of the product types attribute definitions. - * The name is required if this type is used in a product variant and must not be set when - * used in a product variant patch.
+ *Required if used for ProductVariantImport. + * Must not be set if used for ProductVariantPatch.
+ *Must match name of an AttributeDefinition of the Product Type.
A money value in cent precision format.
+ * * @return null|TypedMoney */ diff --git a/lib/commercetools-import/src/Models/Productvariants/MoneyAttributeModel.php b/lib/commercetools-import/src/Models/Productvariants/MoneyAttributeModel.php index e1553e9f737..c86beb193f7 100644 --- a/lib/commercetools-import/src/Models/Productvariants/MoneyAttributeModel.php +++ b/lib/commercetools-import/src/Models/Productvariants/MoneyAttributeModel.php @@ -55,9 +55,9 @@ public function __construct( } /** - *The name of this attribute must match a name of the product types attribute definitions. - * The name is required if this type is used in a product variant and must not be set when - * used in a product variant patch.
+ *Required if used for ProductVariantImport. + * Must not be set if used for ProductVariantPatch.
+ *Must match name of an AttributeDefinition of the Product Type.
Must match type of an AttributeDefinition of the Product Type.
+ * The type is required if this type is used in a product variant and must not be set when
+ * used in a product variant patch.
A money value in cent precision format.
+ * * * @return null|TypedMoney */ diff --git a/lib/commercetools-import/src/Models/Productvariants/MoneySetAttribute.php b/lib/commercetools-import/src/Models/Productvariants/MoneySetAttribute.php index 0a527bcbc0f..3c3ba070eaa 100644 --- a/lib/commercetools-import/src/Models/Productvariants/MoneySetAttribute.php +++ b/lib/commercetools-import/src/Models/Productvariants/MoneySetAttribute.php @@ -17,6 +17,8 @@ interface MoneySetAttribute extends Attribute public const FIELD_VALUE = 'value'; /** + *A set of money values in cent precision format.
+ * * @return null|TypedMoneyCollection */ diff --git a/lib/commercetools-import/src/Models/Productvariants/MoneySetAttributeBuilder.php b/lib/commercetools-import/src/Models/Productvariants/MoneySetAttributeBuilder.php index 505be5dd5a8..0b31e774ab5 100644 --- a/lib/commercetools-import/src/Models/Productvariants/MoneySetAttributeBuilder.php +++ b/lib/commercetools-import/src/Models/Productvariants/MoneySetAttributeBuilder.php @@ -34,9 +34,9 @@ final class MoneySetAttributeBuilder implements Builder private $value; /** - *The name of this attribute must match a name of the product types attribute definitions. - * The name is required if this type is used in a product variant and must not be set when - * used in a product variant patch.
+ *Required if used for ProductVariantImport. + * Must not be set if used for ProductVariantPatch.
+ *Must match name of an AttributeDefinition of the Product Type.
A set of money values in cent precision format.
+ * * @return null|TypedMoneyCollection */ diff --git a/lib/commercetools-import/src/Models/Productvariants/MoneySetAttributeModel.php b/lib/commercetools-import/src/Models/Productvariants/MoneySetAttributeModel.php index 65e45d3b4b7..dd5a444af46 100644 --- a/lib/commercetools-import/src/Models/Productvariants/MoneySetAttributeModel.php +++ b/lib/commercetools-import/src/Models/Productvariants/MoneySetAttributeModel.php @@ -54,9 +54,9 @@ public function __construct( } /** - *The name of this attribute must match a name of the product types attribute definitions. - * The name is required if this type is used in a product variant and must not be set when - * used in a product variant patch.
+ *Required if used for ProductVariantImport. + * Must not be set if used for ProductVariantPatch.
+ *Must match name of an AttributeDefinition of the Product Type.
Must match type of an AttributeDefinition of the Product Type.
+ * The type is required if this type is used in a product variant and must not be set when
+ * used in a product variant patch.
A set of money values in cent precision format.
+ * * * @return null|TypedMoneyCollection */ diff --git a/lib/commercetools-import/src/Models/Productvariants/NumberAttribute.php b/lib/commercetools-import/src/Models/Productvariants/NumberAttribute.php index 025eaf797d7..ad0109878f8 100644 --- a/lib/commercetools-import/src/Models/Productvariants/NumberAttribute.php +++ b/lib/commercetools-import/src/Models/Productvariants/NumberAttribute.php @@ -16,6 +16,9 @@ interface NumberAttribute extends Attribute public const FIELD_VALUE = 'value'; /** + *A number value. + * Can be an integer or a floating-point number.
+ * * @return null|float */ diff --git a/lib/commercetools-import/src/Models/Productvariants/NumberAttributeBuilder.php b/lib/commercetools-import/src/Models/Productvariants/NumberAttributeBuilder.php index 9c8effbb5a3..b85d3711a40 100644 --- a/lib/commercetools-import/src/Models/Productvariants/NumberAttributeBuilder.php +++ b/lib/commercetools-import/src/Models/Productvariants/NumberAttributeBuilder.php @@ -33,9 +33,9 @@ final class NumberAttributeBuilder implements Builder private $value; /** - *The name of this attribute must match a name of the product types attribute definitions. - * The name is required if this type is used in a product variant and must not be set when - * used in a product variant patch.
+ *Required if used for ProductVariantImport. + * Must not be set if used for ProductVariantPatch.
+ *Must match name of an AttributeDefinition of the Product Type.
A number value. + * Can be an integer or a floating-point number.
+ * * @return null|float */ diff --git a/lib/commercetools-import/src/Models/Productvariants/NumberAttributeModel.php b/lib/commercetools-import/src/Models/Productvariants/NumberAttributeModel.php index bdfe79dfc63..d79f0796255 100644 --- a/lib/commercetools-import/src/Models/Productvariants/NumberAttributeModel.php +++ b/lib/commercetools-import/src/Models/Productvariants/NumberAttributeModel.php @@ -53,9 +53,9 @@ public function __construct( } /** - *The name of this attribute must match a name of the product types attribute definitions. - * The name is required if this type is used in a product variant and must not be set when - * used in a product variant patch.
+ *Required if used for ProductVariantImport. + * Must not be set if used for ProductVariantPatch.
+ *Must match name of an AttributeDefinition of the Product Type.
Must match type of an AttributeDefinition of the Product Type.
+ * The type is required if this type is used in a product variant and must not be set when
+ * used in a product variant patch.
A number value. + * Can be an integer or a floating-point number.
+ * * * @return null|float */ diff --git a/lib/commercetools-import/src/Models/Productvariants/NumberSetAttribute.php b/lib/commercetools-import/src/Models/Productvariants/NumberSetAttribute.php index e111873c85b..afdb44c1a20 100644 --- a/lib/commercetools-import/src/Models/Productvariants/NumberSetAttribute.php +++ b/lib/commercetools-import/src/Models/Productvariants/NumberSetAttribute.php @@ -16,6 +16,9 @@ interface NumberSetAttribute extends Attribute public const FIELD_VALUE = 'value'; /** + *A set of number values. + * Each value can be an integer or a floating-point number.
+ * * @return null|array */ diff --git a/lib/commercetools-import/src/Models/Productvariants/NumberSetAttributeBuilder.php b/lib/commercetools-import/src/Models/Productvariants/NumberSetAttributeBuilder.php index 60acdd39845..bbeecda4974 100644 --- a/lib/commercetools-import/src/Models/Productvariants/NumberSetAttributeBuilder.php +++ b/lib/commercetools-import/src/Models/Productvariants/NumberSetAttributeBuilder.php @@ -33,9 +33,9 @@ final class NumberSetAttributeBuilder implements Builder private $value; /** - *The name of this attribute must match a name of the product types attribute definitions. - * The name is required if this type is used in a product variant and must not be set when - * used in a product variant patch.
+ *Required if used for ProductVariantImport. + * Must not be set if used for ProductVariantPatch.
+ *Must match name of an AttributeDefinition of the Product Type.
A set of number values. + * Each value can be an integer or a floating-point number.
+ * * @return null|array */ diff --git a/lib/commercetools-import/src/Models/Productvariants/NumberSetAttributeModel.php b/lib/commercetools-import/src/Models/Productvariants/NumberSetAttributeModel.php index aa2e5e8c9ac..cfbed313663 100644 --- a/lib/commercetools-import/src/Models/Productvariants/NumberSetAttributeModel.php +++ b/lib/commercetools-import/src/Models/Productvariants/NumberSetAttributeModel.php @@ -53,9 +53,9 @@ public function __construct( } /** - *The name of this attribute must match a name of the product types attribute definitions. - * The name is required if this type is used in a product variant and must not be set when - * used in a product variant patch.
+ *Required if used for ProductVariantImport. + * Must not be set if used for ProductVariantPatch.
+ *Must match name of an AttributeDefinition of the Product Type.
Must match type of an AttributeDefinition of the Product Type.
+ * The type is required if this type is used in a product variant and must not be set when
+ * used in a product variant patch.
A set of number values. + * Each value can be an integer or a floating-point number.
+ * * * @return null|array */ diff --git a/lib/commercetools-import/src/Models/Productvariants/ProductVariantImport.php b/lib/commercetools-import/src/Models/Productvariants/ProductVariantImport.php index 93f4fbc230b..f5fbfd0ec4b 100644 --- a/lib/commercetools-import/src/Models/Productvariants/ProductVariantImport.php +++ b/lib/commercetools-import/src/Models/Productvariants/ProductVariantImport.php @@ -26,7 +26,7 @@ interface ProductVariantImport extends ImportResource public const FIELD_PRODUCT = 'product'; /** - *User-defined unique identifier. If a ProductVariant with this key exists on the specified product, it will be updated with the imported data.
User-defined unique identifier. If a ProductVariant with this key exists on the specified product, it is updated with the imported data.
false to update both the current and staged projections of the Product with the new Product Variant data.false to update both the current and staged projections of the Product with the new Product Variant data.true to only update the staged projection.The Product to which this Product Variant belongs. Maps to ProductVariant.product.
- * The Reference to the Product with which the ProductVariant is associated.
- * If referenced Product does not exist, the state of the ImportOperation will be set to unresolved until the necessary Product is created.
The Product containing this ProductVariant. If the referenced Product does not exist, the state of the ImportOperation will be set to unresolved until the referenced Product is created.
User-defined unique identifier. If a ProductVariant with this key exists on the specified product, it will be updated with the imported data.
User-defined unique identifier. If a ProductVariant with this key exists on the specified product, it is updated with the imported data.
false to update both the current and staged projections of the Product with the new Product Variant data.false to update both the current and staged projections of the Product with the new Product Variant data.true to only update the staged projection.The Product to which this Product Variant belongs. Maps to ProductVariant.product.
- * The Reference to the Product with which the ProductVariant is associated.
- * If referenced Product does not exist, the state of the ImportOperation will be set to unresolved until the necessary Product is created.
The Product containing this ProductVariant. If the referenced Product does not exist, the state of the ImportOperation will be set to unresolved until the referenced Product is created.
User-defined unique identifier. If a ProductVariant with this key exists on the specified product, it will be updated with the imported data.
User-defined unique identifier. If a ProductVariant with this key exists on the specified product, it is updated with the imported data.
false to update both the current and staged projections of the Product with the new Product Variant data.false to update both the current and staged projections of the Product with the new Product Variant data.true to only update the staged projection.The Product to which this Product Variant belongs. Maps to ProductVariant.product.
- * The Reference to the Product with which the ProductVariant is associated.
- * If referenced Product does not exist, the state of the ImportOperation will be set to unresolved until the necessary Product is created.
The Product containing this ProductVariant. If the referenced Product does not exist, the state of the ImportOperation will be set to unresolved until the referenced Product is created.
Reference to the ProductVariant to update.
- * If the referenced ProductVariant does not exist, the state of the ImportOperation will be set to unresolved until the necessary ProductVariant is created.
Reference to the ProductVariant to update.
* * @return null|ProductVariantKeyReference @@ -35,7 +34,7 @@ public function getProductVariant(); *state of the ImportOperation will be validationFailed.null will remove the Attribute.null value to a required Attribute will make the import operation fail with an InvalidOperation error.null.null.Reference to the Product that contains the ProductVariant.
+ *Reference to the Product that contains the ProductVariant.
*We recommend to set this value to minimize concurrency errors. * If set, this field is required for every ProductVariantPatch in the ProductVariantPatchRequest.
+ *If the referenced Product does not exist, the state of the ImportOperation will be set to unresolved until the referenced Product is created.
Reference to the ProductVariant to update.
- * If the referenced ProductVariant does not exist, the state of the ImportOperation will be set to unresolved until the necessary ProductVariant is created.
Reference to the ProductVariant to update.
* * @return null|ProductVariantKeyReference @@ -66,7 +65,7 @@ public function getProductVariant() *state of the ImportOperation will be validationFailed.null will remove the Attribute.null value to a required Attribute will make the import operation fail with an InvalidOperation error.null.null.Reference to the Product that contains the ProductVariant.
+ *Reference to the Product that contains the ProductVariant.
*We recommend to set this value to minimize concurrency errors. * If set, this field is required for every ProductVariantPatch in the ProductVariantPatchRequest.
+ *If the referenced Product does not exist, the state of the ImportOperation will be set to unresolved until the referenced Product is created.
Reference to the ProductVariant to update.
- * If the referenced ProductVariant does not exist, the state of the ImportOperation will be set to unresolved until the necessary ProductVariant is created.
Reference to the ProductVariant to update.
* * * @return null|ProductVariantKeyReference @@ -91,7 +90,7 @@ public function getProductVariant() *state of the ImportOperation will be validationFailed.null will remove the Attribute.null value to a required Attribute will make the import operation fail with an InvalidOperation error.null.null.Reference to the Product that contains the ProductVariant.
+ *Reference to the Product that contains the ProductVariant.
*We recommend to set this value to minimize concurrency errors. * If set, this field is required for every ProductVariantPatch in the ProductVariantPatchRequest.
+ *If the referenced Product does not exist, the state of the ImportOperation will be set to unresolved until the referenced Product is created.
The name of this attribute must match a name of the product types attribute definitions. - * The name is required if this type is used in a product variant and must not be set when - * used in a product variant patch.
+ *Required if used for ProductVariantImport. + * Must not be set if used for ProductVariantPatch.
+ *Must match name of an AttributeDefinition of the Product Type.
The name of this attribute must match a name of the product types attribute definitions. - * The name is required if this type is used in a product variant and must not be set when - * used in a product variant patch.
+ *Required if used for ProductVariantImport. + * Must not be set if used for ProductVariantPatch.
+ *Must match name of an AttributeDefinition of the Product Type.
Must match type of an AttributeDefinition of the Product Type.
+ * The type is required if this type is used in a product variant and must not be set when
+ * used in a product variant patch.
A set of references, each referencing a resource by key. + * Each reference must match the key of an existing resource in the project.
+ * * @return null|KeyReferenceCollection */ diff --git a/lib/commercetools-import/src/Models/Productvariants/ReferenceSetAttributeBuilder.php b/lib/commercetools-import/src/Models/Productvariants/ReferenceSetAttributeBuilder.php index 1772ba22a2e..bda5d6c20e3 100644 --- a/lib/commercetools-import/src/Models/Productvariants/ReferenceSetAttributeBuilder.php +++ b/lib/commercetools-import/src/Models/Productvariants/ReferenceSetAttributeBuilder.php @@ -34,9 +34,9 @@ final class ReferenceSetAttributeBuilder implements Builder private $value; /** - *The name of this attribute must match a name of the product types attribute definitions. - * The name is required if this type is used in a product variant and must not be set when - * used in a product variant patch.
+ *Required if used for ProductVariantImport. + * Must not be set if used for ProductVariantPatch.
+ *Must match name of an AttributeDefinition of the Product Type.
A set of references, each referencing a resource by key. + * Each reference must match the key of an existing resource in the project.
+ * * @return null|KeyReferenceCollection */ diff --git a/lib/commercetools-import/src/Models/Productvariants/ReferenceSetAttributeModel.php b/lib/commercetools-import/src/Models/Productvariants/ReferenceSetAttributeModel.php index 1ffcbbadede..30e5db7670c 100644 --- a/lib/commercetools-import/src/Models/Productvariants/ReferenceSetAttributeModel.php +++ b/lib/commercetools-import/src/Models/Productvariants/ReferenceSetAttributeModel.php @@ -54,9 +54,9 @@ public function __construct( } /** - *The name of this attribute must match a name of the product types attribute definitions. - * The name is required if this type is used in a product variant and must not be set when - * used in a product variant patch.
+ *Required if used for ProductVariantImport. + * Must not be set if used for ProductVariantPatch.
+ *Must match name of an AttributeDefinition of the Product Type.
Must match type of an AttributeDefinition of the Product Type.
+ * The type is required if this type is used in a product variant and must not be set when
+ * used in a product variant patch.
A set of references, each referencing a resource by key. + * Each reference must match the key of an existing resource in the project.
+ * * * @return null|KeyReferenceCollection */ diff --git a/lib/commercetools-import/src/Models/Productvariants/TextAttribute.php b/lib/commercetools-import/src/Models/Productvariants/TextAttribute.php index 903324a7acf..c22b8cc9d0b 100644 --- a/lib/commercetools-import/src/Models/Productvariants/TextAttribute.php +++ b/lib/commercetools-import/src/Models/Productvariants/TextAttribute.php @@ -16,6 +16,8 @@ interface TextAttribute extends Attribute public const FIELD_VALUE = 'value'; /** + *A text value.
+ * * @return null|string */ diff --git a/lib/commercetools-import/src/Models/Productvariants/TextAttributeBuilder.php b/lib/commercetools-import/src/Models/Productvariants/TextAttributeBuilder.php index d144aec48b0..e6bbf97e67e 100644 --- a/lib/commercetools-import/src/Models/Productvariants/TextAttributeBuilder.php +++ b/lib/commercetools-import/src/Models/Productvariants/TextAttributeBuilder.php @@ -33,9 +33,9 @@ final class TextAttributeBuilder implements Builder private $value; /** - *The name of this attribute must match a name of the product types attribute definitions. - * The name is required if this type is used in a product variant and must not be set when - * used in a product variant patch.
+ *Required if used for ProductVariantImport. + * Must not be set if used for ProductVariantPatch.
+ *Must match name of an AttributeDefinition of the Product Type.
A text value.
+ * * @return null|string */ diff --git a/lib/commercetools-import/src/Models/Productvariants/TextAttributeModel.php b/lib/commercetools-import/src/Models/Productvariants/TextAttributeModel.php index d1efca5c7c1..89e9a08857e 100644 --- a/lib/commercetools-import/src/Models/Productvariants/TextAttributeModel.php +++ b/lib/commercetools-import/src/Models/Productvariants/TextAttributeModel.php @@ -53,9 +53,9 @@ public function __construct( } /** - *The name of this attribute must match a name of the product types attribute definitions. - * The name is required if this type is used in a product variant and must not be set when - * used in a product variant patch.
+ *Required if used for ProductVariantImport. + * Must not be set if used for ProductVariantPatch.
+ *Must match name of an AttributeDefinition of the Product Type.
Must match type of an AttributeDefinition of the Product Type.
+ * The type is required if this type is used in a product variant and must not be set when
+ * used in a product variant patch.
A text value.
+ * * * @return null|string */ diff --git a/lib/commercetools-import/src/Models/Productvariants/TextSetAttribute.php b/lib/commercetools-import/src/Models/Productvariants/TextSetAttribute.php index 15548ea8fb9..72c87ab6d58 100644 --- a/lib/commercetools-import/src/Models/Productvariants/TextSetAttribute.php +++ b/lib/commercetools-import/src/Models/Productvariants/TextSetAttribute.php @@ -16,6 +16,8 @@ interface TextSetAttribute extends Attribute public const FIELD_VALUE = 'value'; /** + *A set of text values.
+ * * @return null|array */ diff --git a/lib/commercetools-import/src/Models/Productvariants/TextSetAttributeBuilder.php b/lib/commercetools-import/src/Models/Productvariants/TextSetAttributeBuilder.php index 7902f222688..a74819124c2 100644 --- a/lib/commercetools-import/src/Models/Productvariants/TextSetAttributeBuilder.php +++ b/lib/commercetools-import/src/Models/Productvariants/TextSetAttributeBuilder.php @@ -33,9 +33,9 @@ final class TextSetAttributeBuilder implements Builder private $value; /** - *The name of this attribute must match a name of the product types attribute definitions. - * The name is required if this type is used in a product variant and must not be set when - * used in a product variant patch.
+ *Required if used for ProductVariantImport. + * Must not be set if used for ProductVariantPatch.
+ *Must match name of an AttributeDefinition of the Product Type.
A set of text values.
+ * * @return null|array */ diff --git a/lib/commercetools-import/src/Models/Productvariants/TextSetAttributeModel.php b/lib/commercetools-import/src/Models/Productvariants/TextSetAttributeModel.php index f76f7a6903e..dd02c7f7dc6 100644 --- a/lib/commercetools-import/src/Models/Productvariants/TextSetAttributeModel.php +++ b/lib/commercetools-import/src/Models/Productvariants/TextSetAttributeModel.php @@ -53,9 +53,9 @@ public function __construct( } /** - *The name of this attribute must match a name of the product types attribute definitions. - * The name is required if this type is used in a product variant and must not be set when - * used in a product variant patch.
+ *Required if used for ProductVariantImport. + * Must not be set if used for ProductVariantPatch.
+ *Must match name of an AttributeDefinition of the Product Type.
Must match type of an AttributeDefinition of the Product Type.
+ * The type is required if this type is used in a product variant and must not be set when
+ * used in a product variant patch.
A set of text values.
+ * * * @return null|array */ diff --git a/lib/commercetools-import/src/Models/Productvariants/TimeAttribute.php b/lib/commercetools-import/src/Models/Productvariants/TimeAttribute.php index c97c615a58a..4eeaab59b43 100644 --- a/lib/commercetools-import/src/Models/Productvariants/TimeAttribute.php +++ b/lib/commercetools-import/src/Models/Productvariants/TimeAttribute.php @@ -17,6 +17,10 @@ interface TimeAttribute extends Attribute public const FIELD_VALUE = 'value'; /** + *A time value in the format HH:mm:ss.SSS.
+ * The time zone is optional and defaults to UTC if not specified.
+ * If the time zone is specified, it must be in the format ±HH:mm or Z for UTC.
The name of this attribute must match a name of the product types attribute definitions. - * The name is required if this type is used in a product variant and must not be set when - * used in a product variant patch.
+ *Required if used for ProductVariantImport. + * Must not be set if used for ProductVariantPatch.
+ *Must match name of an AttributeDefinition of the Product Type.
A time value in the format HH:mm:ss.SSS.
+ * The time zone is optional and defaults to UTC if not specified.
+ * If the time zone is specified, it must be in the format ±HH:mm or Z for UTC.
The name of this attribute must match a name of the product types attribute definitions. - * The name is required if this type is used in a product variant and must not be set when - * used in a product variant patch.
+ *Required if used for ProductVariantImport. + * Must not be set if used for ProductVariantPatch.
+ *Must match name of an AttributeDefinition of the Product Type.
Must match type of an AttributeDefinition of the Product Type.
+ * The type is required if this type is used in a product variant and must not be set when
+ * used in a product variant patch.
A time value in the format HH:mm:ss.SSS.
+ * The time zone is optional and defaults to UTC if not specified.
+ * If the time zone is specified, it must be in the format ±HH:mm or Z for UTC.
A set of time values in the format HH:mm:ss.SSS.
+ * The time zone is optional and defaults to UTC if not specified.
+ * If the time zone is specified, it must be in the format ±HH:mm or Z for UTC.
The name of this attribute must match a name of the product types attribute definitions. - * The name is required if this type is used in a product variant and must not be set when - * used in a product variant patch.
+ *Required if used for ProductVariantImport. + * Must not be set if used for ProductVariantPatch.
+ *Must match name of an AttributeDefinition of the Product Type.
A set of time values in the format HH:mm:ss.SSS.
+ * The time zone is optional and defaults to UTC if not specified.
+ * If the time zone is specified, it must be in the format ±HH:mm or Z for UTC.
The name of this attribute must match a name of the product types attribute definitions. - * The name is required if this type is used in a product variant and must not be set when - * used in a product variant patch.
+ *Required if used for ProductVariantImport. + * Must not be set if used for ProductVariantPatch.
+ *Must match name of an AttributeDefinition of the Product Type.
Must match type of an AttributeDefinition of the Product Type.
+ * The type is required if this type is used in a product variant and must not be set when
+ * used in a product variant patch.
A set of time values in the format HH:mm:ss.SSS.
+ * The time zone is optional and defaults to UTC if not specified.
+ * If the time zone is specified, it must be in the format ±HH:mm or Z for UTC.
User-defined unique identifier for the Standalone Price. If a StandalonePrice) with this key exists, it will be updated with the imported data.
User-defined unique identifier for the StandalonePrice. If a StandalonePrice) with this key exists, it is updated with the imported data.
Identifies the ProductVariant to which this Standalone Price is associated. This value is not validated to exist in Product Variants.
+ *Maps to StandalonePrice.sku. This value is not validated to exist in Product Variants.
Sets the money value of this Price.
+ *Maps to StandalonePrice.value.
Sets the country for this Price, if the Price does not yet have a country.
- *The country cannot be updated. Attempting to update the an existing country will result in an InvalidFieldsUpdate error.
+ *Maps to StandalonePrice.country. This value cannot be updated. Attempting to update this value will result in an InvalidFieldsUpdate error.
Sets the CustomerGroup for this Price, if the Price does not yet have a CustomerGroup.
- *The CustomerGroup cannot be updated. Attempting to update an existing CustomerGroup will result in an InvalidFieldsUpdate error.
+ *Maps to StandalonePrice.customerGroup. If the referenced CustomerGroup does not exist, the state of the ImportOperation will be set to unresolved until the referenced CustomerGroup is created.
This value cannot be updated. Attempting to update this value will result in an InvalidFieldsUpdate error.
* * @return null|CustomerGroupKeyReference @@ -75,8 +74,8 @@ public function getCountry(); public function getCustomerGroup(); /** - *Sets the product distribution Channel for this Price, if the Price does not yet have a Channel.
- *The Channel cannot be updated. Attempting to update an existing Channel will result in an InvalidFieldsUpdate error.
+ *Maps to StandalonePrice.channel. If the referenced Channel does not exist, the state of the ImportOperation will be set to unresolved until the referenced Channel is created.
This value cannot be updated. Attempting to update this value will result in an InvalidFieldsUpdate error.
* * @return null|ChannelKeyReference @@ -84,7 +83,7 @@ public function getCustomerGroup(); public function getChannel(); /** - *Sets the date from which the Price is valid.
+ *Maps to StandalonePrice.validFrom.
Sets the date until the Price is valid.
+ *Maps to StandalonePrice.validUntil.
Sets price tiers.
+ *Maps to StandalonePrice.tiers.
Custom Fields for the StandalonePrice.
+ *Maps to StandalonePrice.custom.
User-defined unique identifier for the Standalone Price. If a StandalonePrice) with this key exists, it will be updated with the imported data.
User-defined unique identifier for the StandalonePrice. If a StandalonePrice) with this key exists, it is updated with the imported data.
Identifies the ProductVariant to which this Standalone Price is associated. This value is not validated to exist in Product Variants.
+ *Maps to StandalonePrice.sku. This value is not validated to exist in Product Variants.
Sets the money value of this Price.
+ *Maps to StandalonePrice.value.
Sets the country for this Price, if the Price does not yet have a country.
- *The country cannot be updated. Attempting to update the an existing country will result in an InvalidFieldsUpdate error.
+ *Maps to StandalonePrice.country. This value cannot be updated. Attempting to update this value will result in an InvalidFieldsUpdate error.
Sets the CustomerGroup for this Price, if the Price does not yet have a CustomerGroup.
- *The CustomerGroup cannot be updated. Attempting to update an existing CustomerGroup will result in an InvalidFieldsUpdate error.
+ *Maps to StandalonePrice.customerGroup. If the referenced CustomerGroup does not exist, the state of the ImportOperation will be set to unresolved until the referenced CustomerGroup is created.
This value cannot be updated. Attempting to update this value will result in an InvalidFieldsUpdate error.
* * @return null|CustomerGroupKeyReference @@ -158,8 +157,8 @@ public function getCustomerGroup() } /** - *Sets the product distribution Channel for this Price, if the Price does not yet have a Channel.
- *The Channel cannot be updated. Attempting to update an existing Channel will result in an InvalidFieldsUpdate error.
+ *Maps to StandalonePrice.channel. If the referenced Channel does not exist, the state of the ImportOperation will be set to unresolved until the referenced Channel is created.
This value cannot be updated. Attempting to update this value will result in an InvalidFieldsUpdate error.
* * @return null|ChannelKeyReference @@ -170,7 +169,7 @@ public function getChannel() } /** - *Sets the date from which the Price is valid.
+ *Maps to StandalonePrice.validFrom.
Sets the date until the Price is valid.
+ *Maps to StandalonePrice.validUntil.
Sets price tiers.
+ *Maps to StandalonePrice.tiers.
Custom Fields for the StandalonePrice.
+ *Maps to StandalonePrice.custom.
User-defined unique identifier for the Standalone Price. If a StandalonePrice) with this key exists, it will be updated with the imported data.
User-defined unique identifier for the StandalonePrice. If a StandalonePrice) with this key exists, it is updated with the imported data.
Identifies the ProductVariant to which this Standalone Price is associated. This value is not validated to exist in Product Variants.
+ *Maps to StandalonePrice.sku. This value is not validated to exist in Product Variants.
Sets the money value of this Price.
+ *Maps to StandalonePrice.value.
Sets the country for this Price, if the Price does not yet have a country.
- *The country cannot be updated. Attempting to update the an existing country will result in an InvalidFieldsUpdate error.
+ *Maps to StandalonePrice.country. This value cannot be updated. Attempting to update this value will result in an InvalidFieldsUpdate error.
Sets the CustomerGroup for this Price, if the Price does not yet have a CustomerGroup.
- *The CustomerGroup cannot be updated. Attempting to update an existing CustomerGroup will result in an InvalidFieldsUpdate error.
+ *Maps to StandalonePrice.customerGroup. If the referenced CustomerGroup does not exist, the state of the ImportOperation will be set to unresolved until the referenced CustomerGroup is created.
This value cannot be updated. Attempting to update this value will result in an InvalidFieldsUpdate error.
* * * @return null|CustomerGroupKeyReference @@ -234,8 +233,8 @@ public function getCustomerGroup() } /** - *Sets the product distribution Channel for this Price, if the Price does not yet have a Channel.
- *The Channel cannot be updated. Attempting to update an existing Channel will result in an InvalidFieldsUpdate error.
+ *Maps to StandalonePrice.channel. If the referenced Channel does not exist, the state of the ImportOperation will be set to unresolved until the referenced Channel is created.
This value cannot be updated. Attempting to update this value will result in an InvalidFieldsUpdate error.
* * * @return null|ChannelKeyReference @@ -256,7 +255,7 @@ public function getChannel() } /** - *Sets the date from which the Price is valid.
+ *Maps to StandalonePrice.validFrom.
Sets the date until the Price is valid.
+ *Maps to StandalonePrice.validUntil.
Sets price tiers.
+ *Maps to StandalonePrice.tiers.
Custom Fields for the StandalonePrice.
+ *Maps to StandalonePrice.custom.
Name of the field type. Must be unique for a given ResourceTypeId. In case there is a FieldDefinition with the same name in another Type, both FieldDefinitions must have the same type. This value cannot be changed after the Type is imported.
Name of the field type. Must be unique for a given ResourceTypeId. In case there is a FieldDefinition with the same name in another Type, both FieldDefinitions must have the same type. This value cannot be changed after the Type is imported.
Name of the field type. Must be unique for a given ResourceTypeId. In case there is a FieldDefinition with the same name in another Type, both FieldDefinitions must have the same type. This value cannot be changed after the Type is imported.
Name of the field type. Must be unique for a given ResourceTypeId. In case there is a FieldDefinition with the same name in another Type, both FieldDefinitions must have the same type. This value cannot be changed after the Type is imported.
Name of the field type. Must be unique for a given ResourceTypeId. In case there is a FieldDefinition with the same name in another Type, both FieldDefinitions must have the same type. This value cannot be changed after the Type is imported.
Name of the field type. Must be unique for a given ResourceTypeId. In case there is a FieldDefinition with the same name in another Type, both FieldDefinitions must have the same type. This value cannot be changed after the Type is imported.
Name of the field type. Must be unique for a given ResourceTypeId. In case there is a FieldDefinition with the same name in another Type, both FieldDefinitions must have the same type. This value cannot be changed after the Type is imported.
Name of the field type. Must be unique for a given ResourceTypeId. In case there is a FieldDefinition with the same name in another Type, both FieldDefinitions must have the same type. This value cannot be changed after the Type is imported.
Name of the field type. Must be unique for a given ResourceTypeId. In case there is a FieldDefinition with the same name in another Type, both FieldDefinitions must have the same type. This value cannot be changed after the Type is imported.
Name of the field type. Must be unique for a given ResourceTypeId. In case there is a FieldDefinition with the same name in another Type, both FieldDefinitions must have the same type. This value cannot be changed after the Type is imported.
Name of the field type. Must be unique for a given ResourceTypeId. In case there is a FieldDefinition with the same name in another Type, both FieldDefinitions must have the same type. This value cannot be changed after the Type is imported.
Name of the field type. Must be unique for a given ResourceTypeId. In case there is a FieldDefinition with the same name in another Type, both FieldDefinitions must have the same type. This value cannot be changed after the Type is imported.
Provides a visual representation type for this field. It is only relevant for string-based field types like CustomFieldStringType and CustomFieldLocalizedStringType.
+ *Provides a visual representation type for this field. It is only relevant for string-based field types like CustomFieldStringType and CustomFieldLocalizedStringType.
* * @return null|string diff --git a/lib/commercetools-import/src/Models/Types/FieldDefinitionBuilder.php b/lib/commercetools-import/src/Models/Types/FieldDefinitionBuilder.php index 0decd572403..c6817fa27b7 100644 --- a/lib/commercetools-import/src/Models/Types/FieldDefinitionBuilder.php +++ b/lib/commercetools-import/src/Models/Types/FieldDefinitionBuilder.php @@ -97,7 +97,7 @@ public function getRequired() } /** - *Provides a visual representation type for this field. It is only relevant for string-based field types like CustomFieldStringType and CustomFieldLocalizedStringType.
+ *Provides a visual representation type for this field. It is only relevant for string-based field types like CustomFieldStringType and CustomFieldLocalizedStringType.
* * @return null|string diff --git a/lib/commercetools-import/src/Models/Types/FieldDefinitionModel.php b/lib/commercetools-import/src/Models/Types/FieldDefinitionModel.php index 2f90ce5c79a..8f29b89304e 100644 --- a/lib/commercetools-import/src/Models/Types/FieldDefinitionModel.php +++ b/lib/commercetools-import/src/Models/Types/FieldDefinitionModel.php @@ -152,7 +152,7 @@ public function getRequired() } /** - *Provides a visual representation type for this field. It is only relevant for string-based field types like CustomFieldStringType and CustomFieldLocalizedStringType.
+ *Provides a visual representation type for this field. It is only relevant for string-based field types like CustomFieldStringType and CustomFieldLocalizedStringType.
* * * @return null|string diff --git a/lib/commercetools-import/src/Models/Types/FieldType.php b/lib/commercetools-import/src/Models/Types/FieldType.php index cfddfaa9811..11b6555e00b 100644 --- a/lib/commercetools-import/src/Models/Types/FieldType.php +++ b/lib/commercetools-import/src/Models/Types/FieldType.php @@ -17,6 +17,8 @@ interface FieldType extends JsonObject public const FIELD_NAME = 'name'; /** + *Name of the field type. Must be unique for a given ResourceTypeId. In case there is a FieldDefinition with the same name in another Type, both FieldDefinitions must have the same type. This value cannot be changed after the Type is imported.
Name of the field type. Must be unique for a given ResourceTypeId. In case there is a FieldDefinition with the same name in another Type, both FieldDefinitions must have the same type. This value cannot be changed after the Type is imported.
User-defined unique identifier for the Type. If a Type with this key exists, it will be updated with the imported data.
User-defined unique identifier for the Type. If a Type with this key exists, it is updated with the imported data.
User-defined unique identifier for the Type. If a Type with this key exists, it will be updated with the imported data.
User-defined unique identifier for the Type. If a Type with this key exists, it is updated with the imported data.
User-defined unique identifier for the Type. If a Type with this key exists, it will be updated with the imported data.
User-defined unique identifier for the Type. If a Type with this key exists, it is updated with the imported data.