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}`
**History changes** diff --git a/lib/commercetools-api/src/Models/Common/Asset.php b/lib/commercetools-api/src/Models/Common/Asset.php index bd251f4c191..66cbe4eb25d 100644 --- a/lib/commercetools-api/src/Models/Common/Asset.php +++ b/lib/commercetools-api/src/Models/Common/Asset.php @@ -23,7 +23,7 @@ interface Asset extends JsonObject public const FIELD_KEY = '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/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 array $headers + */ + public function __construct(string $projectKey, string $importContainerKey, $body = null, array $headers = [], ?ClientInterface $client = null) + { + $uri = str_replace(['{projectKey}', '{importContainerKey}'], [$projectKey, $importContainerKey], '{projectKey}/product-selections/import-containers/{importContainerKey}'); + parent::__construct($client, 'POST', $uri, $headers, is_object($body) || is_array($body) ? json_encode($body) : $body); + } + + /** + * @template T of JsonObject + * @psalm-param ?class-string $resultType + * @return ErrorResponse|ImportResponse|JsonObject|T|null + */ + public function mapFromResponse(?ResponseInterface $response, ?string $resultType = null) + { + if (is_null($response)) { + return null; + } + if (is_null($resultType)) { + switch ($response->getStatusCode()) { + case '201': + $resultType = ImportResponseModel::class; + + break; + case '400': + $resultType = ErrorResponseModel::class; + + break; + default: + $resultType = JsonObjectModel::class; + + break; + } + } + + return $resultType::of($this->responseData($response)); + } + + /** + * @template T of JsonObject + * @psalm-param ?class-string $resultType + * + * @return null|T|ErrorResponse|ImportResponse|JsonObject + */ + public function execute(array $options = [], ?string $resultType = null) + { + try { + $response = $this->send($options); + } catch (ServerException $e) { + $response = $e->getResponse(); + $e = ExceptionFactory::createServerException($e, $this, $response, $this->mapFromResponse($response, $resultType)); + throw $e; + } catch (ClientException $e) { + $response = $e->getResponse(); + $e = ExceptionFactory::createClientException($e, $this, $response, $this->mapFromResponse($response, $resultType)); + throw $e; + } + + return $this->mapFromResponse($response, $resultType); + } + + /** + * @template T of JsonObject + * @psalm-param ?class-string $resultType + * + * @return PromiseInterface + */ + public function executeAsync(array $options = [], ?string $resultType = null) + { + return $this->sendAsync($options)->then( + function (ResponseInterface $response) use ($resultType) { + return $this->mapFromResponse($response, $resultType); + }, + function (RequestException $e) use ($resultType) { + $response = $e->getResponse(); + if ($e instanceof ServerException) { + $e = ExceptionFactory::createServerException($e, $this, $response, $this->mapFromResponse($response, $resultType)); + } + if ($e instanceof ClientException) { + $e = ExceptionFactory::createClientException($e, $this, $response, $this->mapFromResponse($response, $resultType)); + } + throw $e; + } + ); + } +} diff --git a/lib/commercetools-import/src/Client/Resource/ResourceByProjectKey.php b/lib/commercetools-import/src/Client/Resource/ResourceByProjectKey.php index 4a20bcdd324..c59123abbf4 100644 --- a/lib/commercetools-import/src/Client/Resource/ResourceByProjectKey.php +++ b/lib/commercetools-import/src/Client/Resource/ResourceByProjectKey.php @@ -153,4 +153,12 @@ public function discountCodes(): ResourceByProjectKeyDiscountCodes return new ResourceByProjectKeyDiscountCodes($args, $this->getClient()); } + /** + */ + public function productSelections(): ResourceByProjectKeyProductSelections + { + $args = $this->getArgs(); + + return new ResourceByProjectKeyProductSelections($args, $this->getClient()); + } } diff --git a/lib/commercetools-import/src/Client/Resource/ResourceByProjectKeyProductSelections.php b/lib/commercetools-import/src/Client/Resource/ResourceByProjectKeyProductSelections.php new file mode 100644 index 00000000000..7c8eeb124cc --- /dev/null +++ b/lib/commercetools-import/src/Client/Resource/ResourceByProjectKeyProductSelections.php @@ -0,0 +1,36 @@ + $args + */ + public function __construct(array $args = [], ?ClientInterface $client = null) + { + parent::__construct('/{projectKey}/product-selections', $args, $client); + } + + /** + */ + public function importContainers(): ResourceByProjectKeyProductSelectionsImportContainers + { + $args = $this->getArgs(); + + return new ResourceByProjectKeyProductSelectionsImportContainers($args, $this->getClient()); + } +} diff --git a/lib/commercetools-import/src/Client/Resource/ResourceByProjectKeyProductSelectionsImportContainers.php b/lib/commercetools-import/src/Client/Resource/ResourceByProjectKeyProductSelectionsImportContainers.php new file mode 100644 index 00000000000..772aa2a1187 --- /dev/null +++ b/lib/commercetools-import/src/Client/Resource/ResourceByProjectKeyProductSelectionsImportContainers.php @@ -0,0 +1,39 @@ + $args + */ + public function __construct(array $args = [], ?ClientInterface $client = null) + { + parent::__construct('/{projectKey}/product-selections/import-containers', $args, $client); + } + + /** + */ + public function withImportContainerKeyValue(?string $importContainerKey = null): ResourceByProjectKeyProductSelectionsImportContainersByImportContainerKey + { + $args = $this->getArgs(); + if (!is_null($importContainerKey)) { + $args['importContainerKey'] = $importContainerKey; + } + + return new ResourceByProjectKeyProductSelectionsImportContainersByImportContainerKey($args, $this->getClient()); + } +} diff --git a/lib/commercetools-import/src/Client/Resource/ResourceByProjectKeyProductSelectionsImportContainersByImportContainerKey.php b/lib/commercetools-import/src/Client/Resource/ResourceByProjectKeyProductSelectionsImportContainersByImportContainerKey.php new file mode 100644 index 00000000000..b193e735871 --- /dev/null +++ b/lib/commercetools-import/src/Client/Resource/ResourceByProjectKeyProductSelectionsImportContainersByImportContainerKey.php @@ -0,0 +1,39 @@ + $args + */ + public function __construct(array $args = [], ?ClientInterface $client = null) + { + parent::__construct('/{projectKey}/product-selections/import-containers/{importContainerKey}', $args, $client); + } + + /** + * @psalm-param ?ProductSelectionImportRequest $body + * @psalm-param array $headers + */ + public function post(?ProductSelectionImportRequest $body = null, array $headers = []): ByProjectKeyProductSelectionsImportContainersByImportContainerKeyPost + { + $args = $this->getArgs(); + + return new ByProjectKeyProductSelectionsImportContainersByImportContainerKeyPost($args['projectKey'], $args['importContainerKey'], $body, $headers, $this->getClient()); + } +} diff --git a/lib/commercetools-import/src/Client/Resource/SecuredByManageProductSelections.php b/lib/commercetools-import/src/Client/Resource/SecuredByManageProductSelections.php new file mode 100644 index 00000000000..3a3a823827e --- /dev/null +++ b/lib/commercetools-import/src/Client/Resource/SecuredByManageProductSelections.php @@ -0,0 +1,19 @@ + + */ +interface SecuredByManageProductSelections extends ApiRequestInterface +{ +} diff --git a/lib/commercetools-import/src/Models/Categories/CategoryImport.php b/lib/commercetools-import/src/Models/Categories/CategoryImport.php index 8d3d33b5e1f..30baaefae5b 100644 --- a/lib/commercetools-import/src/Models/Categories/CategoryImport.php +++ b/lib/commercetools-import/src/Models/Categories/CategoryImport.php @@ -31,7 +31,7 @@ interface CategoryImport extends ImportResource public const FIELD_CUSTOM = '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.

* * @return null|string @@ -47,8 +47,7 @@ public function getKey(); public function getName(); /** - *

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}+$.

* * @return null|LocalizedString @@ -64,9 +63,7 @@ public function getSlug(); public function getDescription(); /** - *

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.

* * @return null|CategoryKeyReference @@ -122,7 +119,7 @@ public function getMetaKeywords(); public function getAssets(); /** - *

The custom fields for this Category.

+ *

Maps to Category.custom.

* * @return null|Custom diff --git a/lib/commercetools-import/src/Models/Categories/CategoryImportBuilder.php b/lib/commercetools-import/src/Models/Categories/CategoryImportBuilder.php index d34a9d0e6fb..e332836bafc 100644 --- a/lib/commercetools-import/src/Models/Categories/CategoryImportBuilder.php +++ b/lib/commercetools-import/src/Models/Categories/CategoryImportBuilder.php @@ -102,7 +102,7 @@ final class CategoryImportBuilder implements Builder private $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.

* * @return null|string @@ -124,8 +124,7 @@ public function getName() } /** - *

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}+$.

* * @return null|LocalizedString @@ -147,9 +146,7 @@ public function getDescription() } /** - *

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.

* * @return null|CategoryKeyReference @@ -226,7 +223,7 @@ public function getAssets() } /** - *

The custom fields for this Category.

+ *

Maps to Category.custom.

* * @return null|Custom diff --git a/lib/commercetools-import/src/Models/Categories/CategoryImportModel.php b/lib/commercetools-import/src/Models/Categories/CategoryImportModel.php index 13d60277b0f..7989a0dfcfb 100644 --- a/lib/commercetools-import/src/Models/Categories/CategoryImportModel.php +++ b/lib/commercetools-import/src/Models/Categories/CategoryImportModel.php @@ -133,7 +133,7 @@ public function __construct( } /** - *

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.

* * * @return null|string @@ -174,8 +174,7 @@ public function getName() } /** - *

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}+$.

* * * @return null|LocalizedString @@ -217,9 +216,7 @@ public function getDescription() } /** - *

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.

* * * @return null|CategoryKeyReference @@ -363,7 +360,7 @@ public function getAssets() } /** - *

The custom fields for this Category.

+ *

Maps to Category.custom.

* * * @return null|Custom diff --git a/lib/commercetools-import/src/Models/Common/Address.php b/lib/commercetools-import/src/Models/Common/Address.php index db1edb923ab..d57c75914eb 100644 --- a/lib/commercetools-import/src/Models/Common/Address.php +++ b/lib/commercetools-import/src/Models/Common/Address.php @@ -42,85 +42,113 @@ interface Address extends JsonObject public const FIELD_CUSTOM = '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.

+ * * @return null|string */ public function getId(); /** + *

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.

+ * * @return null|string */ public function getKey(); /** + *

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.

+ * * @return null|string */ @@ -188,6 +192,8 @@ public function getId() } /** + *

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.

+ * * @return null|string */ @@ -197,6 +203,8 @@ public function getKey() } /** + *

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.

+ * * * @return null|string */ @@ -256,6 +260,8 @@ public function getId() } /** + *

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.

+ * * * @return null|string */ @@ -274,6 +280,8 @@ public function getKey() } /** + *

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.

+ * * @return null|string */ public function getContainer(); + /** + * @param ?string $key + */ + public function setKey(?string $key): void; + /** * @param ?string $container */ diff --git a/lib/commercetools-import/src/Models/Common/CustomObjectKeyReferenceBuilder.php b/lib/commercetools-import/src/Models/Common/CustomObjectKeyReferenceBuilder.php index 16dc46e5127..014d6b13007 100644 --- a/lib/commercetools-import/src/Models/Common/CustomObjectKeyReferenceBuilder.php +++ b/lib/commercetools-import/src/Models/Common/CustomObjectKeyReferenceBuilder.php @@ -33,6 +33,8 @@ final class CustomObjectKeyReferenceBuilder implements Builder private $container; /** + *

User-defined unique identifier of the referenced CustomObject.

+ * * @return null|string */ @@ -42,6 +44,8 @@ public function getKey() } /** + *

The container of the referenced CustomObject.

+ * * @return null|string */ diff --git a/lib/commercetools-import/src/Models/Common/CustomObjectKeyReferenceModel.php b/lib/commercetools-import/src/Models/Common/CustomObjectKeyReferenceModel.php index 7e2836b3d08..479ba208409 100644 --- a/lib/commercetools-import/src/Models/Common/CustomObjectKeyReferenceModel.php +++ b/lib/commercetools-import/src/Models/Common/CustomObjectKeyReferenceModel.php @@ -53,6 +53,8 @@ public function __construct( } /** + *

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.

+ * * * @return null|string */ diff --git a/lib/commercetools-import/src/Models/Common/CustomerGroupKeyReference.php b/lib/commercetools-import/src/Models/Common/CustomerGroupKeyReference.php index ceaf515b262..868a7d25efc 100644 --- a/lib/commercetools-import/src/Models/Common/CustomerGroupKeyReference.php +++ b/lib/commercetools-import/src/Models/Common/CustomerGroupKeyReference.php @@ -13,4 +13,16 @@ interface CustomerGroupKeyReference extends KeyReference { + /** + *

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.

* * @return null|ProductDiscountKeyReference diff --git a/lib/commercetools-import/src/Models/Common/DiscountedPriceBuilder.php b/lib/commercetools-import/src/Models/Common/DiscountedPriceBuilder.php index 09f89854a1c..8cbdc61a9f6 100644 --- a/lib/commercetools-import/src/Models/Common/DiscountedPriceBuilder.php +++ b/lib/commercetools-import/src/Models/Common/DiscountedPriceBuilder.php @@ -44,7 +44,7 @@ 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.

* * @return null|ProductDiscountKeyReference diff --git a/lib/commercetools-import/src/Models/Common/DiscountedPriceModel.php b/lib/commercetools-import/src/Models/Common/DiscountedPriceModel.php index c75403a9307..7d80b3f67c4 100644 --- a/lib/commercetools-import/src/Models/Common/DiscountedPriceModel.php +++ b/lib/commercetools-import/src/Models/Common/DiscountedPriceModel.php @@ -65,7 +65,7 @@ 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.

* * * @return null|ProductDiscountKeyReference diff --git a/lib/commercetools-import/src/Models/Common/HighPrecisionMoneyBuilder.php b/lib/commercetools-import/src/Models/Common/HighPrecisionMoneyBuilder.php index 41a5ebd1663..073132d01f5 100644 --- a/lib/commercetools-import/src/Models/Common/HighPrecisionMoneyBuilder.php +++ b/lib/commercetools-import/src/Models/Common/HighPrecisionMoneyBuilder.php @@ -45,6 +45,10 @@ final class HighPrecisionMoneyBuilder implements Builder private $preciseAmount; /** + *

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.

+ * * @return null|int */ @@ -54,6 +58,12 @@ public function getFractionDigits() } /** + *

Amount in the smallest indivisible unit of a currency, such as:

+ *
    + *
  • Cents for EUR and USD, pence for GBP, or centime for CHF (5 CHF is specified as 500).
  • + *
  • The value in the major unit for currencies without minor units, like JPY (5 JPY is specified as 5).
  • + *
+ * * @return null|int */ diff --git a/lib/commercetools-import/src/Models/Common/HighPrecisionMoneyModel.php b/lib/commercetools-import/src/Models/Common/HighPrecisionMoneyModel.php index fbdf66a590b..f021b2129fa 100644 --- a/lib/commercetools-import/src/Models/Common/HighPrecisionMoneyModel.php +++ b/lib/commercetools-import/src/Models/Common/HighPrecisionMoneyModel.php @@ -69,6 +69,8 @@ public function __construct( } /** + *

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.

+ * * * @return null|string */ @@ -87,6 +89,10 @@ public function getType() } /** + *

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.

+ * * * @return null|int */ @@ -105,6 +111,12 @@ public function getFractionDigits() } /** + *

Amount in the smallest indivisible unit of a currency, such as:

+ *
    + *
  • Cents for EUR and USD, pence for GBP, or centime for CHF (5 CHF is specified as 500).
  • + *
  • The value in the major unit for currencies without minor units, like JPY (5 JPY is specified as 5).
  • + *
+ * * * @return null|int */ diff --git a/lib/commercetools-import/src/Models/Common/ImportResource.php b/lib/commercetools-import/src/Models/Common/ImportResource.php index bf7e1d36adf..ddf4abd797c 100644 --- a/lib/commercetools-import/src/Models/Common/ImportResource.php +++ b/lib/commercetools-import/src/Models/Common/ImportResource.php @@ -17,6 +17,7 @@ use Commercetools\Import\Models\Prices\PriceImport; use Commercetools\Import\Models\Productdrafts\ProductDraftImport; use Commercetools\Import\Models\Products\ProductImport; +use Commercetools\Import\Models\ProductSelections\ProductSelectionImport; use Commercetools\Import\Models\Producttypes\ProductTypeImport; use Commercetools\Import\Models\Productvariants\ProductVariantImport; use Commercetools\Import\Models\StandalonePrices\StandalonePriceImport; diff --git a/lib/commercetools-import/src/Models/Common/ImportResourceBuilder.php b/lib/commercetools-import/src/Models/Common/ImportResourceBuilder.php index efd4f3ab271..3d708f72bc5 100644 --- a/lib/commercetools-import/src/Models/Common/ImportResourceBuilder.php +++ b/lib/commercetools-import/src/Models/Common/ImportResourceBuilder.php @@ -27,6 +27,8 @@ use Commercetools\Import\Models\Productdrafts\ProductDraftImportBuilder; use Commercetools\Import\Models\Products\ProductImport; use Commercetools\Import\Models\Products\ProductImportBuilder; +use Commercetools\Import\Models\ProductSelections\ProductSelectionImport; +use Commercetools\Import\Models\ProductSelections\ProductSelectionImportBuilder; use Commercetools\Import\Models\Producttypes\ProductTypeImport; use Commercetools\Import\Models\Producttypes\ProductTypeImportBuilder; use Commercetools\Import\Models\Productvariants\ProductVariantImport; diff --git a/lib/commercetools-import/src/Models/Common/ImportResourceModel.php b/lib/commercetools-import/src/Models/Common/ImportResourceModel.php index b10cef32bdc..41d395bd8bc 100644 --- a/lib/commercetools-import/src/Models/Common/ImportResourceModel.php +++ b/lib/commercetools-import/src/Models/Common/ImportResourceModel.php @@ -26,6 +26,8 @@ use Commercetools\Import\Models\Productdrafts\ProductDraftImportModel; use Commercetools\Import\Models\Products\ProductImport; use Commercetools\Import\Models\Products\ProductImportModel; +use Commercetools\Import\Models\ProductSelections\ProductSelectionImport; +use Commercetools\Import\Models\ProductSelections\ProductSelectionImportModel; use Commercetools\Import\Models\Producttypes\ProductTypeImport; use Commercetools\Import\Models\Producttypes\ProductTypeImportModel; use Commercetools\Import\Models\Productvariants\ProductVariantImport; diff --git a/lib/commercetools-import/src/Models/Common/KeyReference.php b/lib/commercetools-import/src/Models/Common/KeyReference.php index 0f4a79272f0..a91dfe8bf14 100644 --- a/lib/commercetools-import/src/Models/Common/KeyReference.php +++ b/lib/commercetools-import/src/Models/Common/KeyReference.php @@ -18,13 +18,16 @@ interface KeyReference extends JsonObject public const FIELD_TYPE_ID = 'typeId'; /** + *

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.

+ * * @return null|string */ 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/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.

+ * * @return null|string */ diff --git a/lib/commercetools-import/src/Models/Common/KeyReferenceModel.php b/lib/commercetools-import/src/Models/Common/KeyReferenceModel.php index 89268c34718..faa4ad2cc87 100644 --- a/lib/commercetools-import/src/Models/Common/KeyReferenceModel.php +++ b/lib/commercetools-import/src/Models/Common/KeyReferenceModel.php @@ -71,6 +71,9 @@ public function __construct( } /** + *

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.

+ * * * @return null|string */ @@ -89,7 +92,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/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.

+ * * @return null|int */ @@ -48,6 +52,12 @@ public function getFractionDigits() } /** + *

Amount in the smallest indivisible unit of a currency, such as:

+ *
    + *
  • Cents for EUR and USD, pence for GBP, or centime for CHF (5 CHF is specified as 500).
  • + *
  • The value in the major unit for currencies without minor units, like JPY (5 JPY is specified as 5).
  • + *
+ * * @return null|int */ diff --git a/lib/commercetools-import/src/Models/Common/MoneyModel.php b/lib/commercetools-import/src/Models/Common/MoneyModel.php index b644958212e..39d03a47d01 100644 --- a/lib/commercetools-import/src/Models/Common/MoneyModel.php +++ b/lib/commercetools-import/src/Models/Common/MoneyModel.php @@ -61,6 +61,8 @@ public function __construct( } /** + *

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.

+ * * * @return null|string */ @@ -79,6 +81,10 @@ public function getType() } /** + *

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.

+ * * * @return null|int */ @@ -97,6 +103,12 @@ public function getFractionDigits() } /** + *

Amount in the smallest indivisible unit of a currency, such as:

+ *
    + *
  • Cents for EUR and USD, pence for GBP, or centime for CHF (5 CHF is specified as 500).
  • + *
  • The value in the major unit for currencies without minor units, like JPY (5 JPY is specified as 5).
  • + *
+ * * * @return null|int */ diff --git a/lib/commercetools-import/src/Models/Common/OrderKeyReferenceBuilder.php b/lib/commercetools-import/src/Models/Common/OrderKeyReferenceBuilder.php index 4ef38fe4833..eecd8200c36 100644 --- a/lib/commercetools-import/src/Models/Common/OrderKeyReferenceBuilder.php +++ b/lib/commercetools-import/src/Models/Common/OrderKeyReferenceBuilder.php @@ -27,6 +27,9 @@ final class OrderKeyReferenceBuilder 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.

+ * * @return null|string */ diff --git a/lib/commercetools-import/src/Models/Common/OrderKeyReferenceModel.php b/lib/commercetools-import/src/Models/Common/OrderKeyReferenceModel.php index 1b9af3c03cd..ec62958f501 100644 --- a/lib/commercetools-import/src/Models/Common/OrderKeyReferenceModel.php +++ b/lib/commercetools-import/src/Models/Common/OrderKeyReferenceModel.php @@ -45,6 +45,9 @@ public function __construct( } /** + *

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.

+ * * * @return null|string */ @@ -63,7 +66,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/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.

+ * * @return null|string */ public function getType(); /** + *

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.

+ * * @return null|int */ public function getFractionDigits(); /** + *

Amount in the smallest indivisible unit of a currency, such as:

+ *
    + *
  • Cents for EUR and USD, pence for GBP, or centime for CHF (5 CHF is specified as 500).
  • + *
  • The value in the major unit for currencies without minor units, like JPY (5 JPY is specified as 5).
  • + *
+ * * @return null|int */ diff --git a/lib/commercetools-import/src/Models/Common/TypedMoneyBuilder.php b/lib/commercetools-import/src/Models/Common/TypedMoneyBuilder.php index 794325bb2e3..5e98074eb39 100644 --- a/lib/commercetools-import/src/Models/Common/TypedMoneyBuilder.php +++ b/lib/commercetools-import/src/Models/Common/TypedMoneyBuilder.php @@ -39,6 +39,10 @@ final class TypedMoneyBuilder 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.

+ * * @return null|int */ @@ -48,6 +52,12 @@ public function getFractionDigits() } /** + *

Amount in the smallest indivisible unit of a currency, such as:

+ *
    + *
  • Cents for EUR and USD, pence for GBP, or centime for CHF (5 CHF is specified as 500).
  • + *
  • The value in the major unit for currencies without minor units, like JPY (5 JPY is specified as 5).
  • + *
+ * * @return null|int */ diff --git a/lib/commercetools-import/src/Models/Common/TypedMoneyModel.php b/lib/commercetools-import/src/Models/Common/TypedMoneyModel.php index c4701951fed..ec344c34895 100644 --- a/lib/commercetools-import/src/Models/Common/TypedMoneyModel.php +++ b/lib/commercetools-import/src/Models/Common/TypedMoneyModel.php @@ -69,6 +69,8 @@ public function __construct( } /** + *

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.

+ * * * @return null|string */ @@ -87,6 +89,10 @@ public function getType() } /** + *

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.

+ * * * @return null|int */ @@ -105,6 +111,12 @@ public function getFractionDigits() } /** + *

Amount in the smallest indivisible unit of a currency, such as:

+ *
    + *
  • Cents for EUR and USD, pence for GBP, or centime for CHF (5 CHF is specified as 500).
  • + *
  • The value in the major unit for currencies without minor units, like JPY (5 JPY is specified as 5).
  • + *
+ * * * @return null|int */ diff --git a/lib/commercetools-import/src/Models/Common/UnresolvedReferences.php b/lib/commercetools-import/src/Models/Common/UnresolvedReferences.php index 70df4b74ede..794f33c5305 100644 --- a/lib/commercetools-import/src/Models/Common/UnresolvedReferences.php +++ b/lib/commercetools-import/src/Models/Common/UnresolvedReferences.php @@ -17,7 +17,7 @@ interface UnresolvedReferences extends JsonObject public const FIELD_TYPE_ID = 'typeId'; /** - *

The key of the resource.

+ *

key of the unresolved resource.

* * @return null|string @@ -25,7 +25,7 @@ interface UnresolvedReferences extends JsonObject public function getKey(); /** - *

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.

* * @return null|string @@ -44,7 +44,7 @@ public function getKey() } /** - *

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.

* * * @return null|string @@ -64,7 +64,7 @@ public function getKey() } /** - *

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.

+ * Must be unique per customer.

* * @return null|string diff --git a/lib/commercetools-import/src/Models/Customers/CustomerAddressBuilder.php b/lib/commercetools-import/src/Models/Customers/CustomerAddressBuilder.php index 06966352f95..a30986dcc40 100644 --- a/lib/commercetools-import/src/Models/Customers/CustomerAddressBuilder.php +++ b/lib/commercetools-import/src/Models/Customers/CustomerAddressBuilder.php @@ -174,7 +174,7 @@ final class CustomerAddressBuilder implements Builder /** *

User-defined identifier for the address. - * Must follow the pattern [a-zA-Z0-9_-]{2,256} and must be unique per customer.

+ * Must be unique per customer.

* * @return null|string diff --git a/lib/commercetools-import/src/Models/Customers/CustomerAddressModel.php b/lib/commercetools-import/src/Models/Customers/CustomerAddressModel.php index 4faf0f37b75..b56b5edd3ed 100644 --- a/lib/commercetools-import/src/Models/Customers/CustomerAddressModel.php +++ b/lib/commercetools-import/src/Models/Customers/CustomerAddressModel.php @@ -231,7 +231,7 @@ public function __construct( /** *

User-defined identifier for the address. - * Must follow the pattern [a-zA-Z0-9_-]{2,256} and must be unique per customer.

+ * Must be unique per customer.

* * * @return null|string diff --git a/lib/commercetools-import/src/Models/Customers/CustomerImport.php b/lib/commercetools-import/src/Models/Customers/CustomerImport.php index f1495d1505c..c5c664eb0b9 100644 --- a/lib/commercetools-import/src/Models/Customers/CustomerImport.php +++ b/lib/commercetools-import/src/Models/Customers/CustomerImport.php @@ -43,7 +43,7 @@ interface CustomerImport extends ImportResource public const FIELD_AUTHENTICATION_MODE = 'authenticationMode'; /** - *

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.

* * @return null|string @@ -67,7 +67,7 @@ public function getCustomerNumber(); public function getEmail(); /** - *

Required when authenticationMode is set to Password. Maps to Customer.password.

+ *

Maps to Customer.password. Required when authenticationMode is set to Password.

* * @return null|string @@ -75,7 +75,7 @@ public function getEmail(); public function getPassword(); /** - *

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.

* * @return null|StoreKeyReferenceCollection @@ -163,8 +163,7 @@ public function getVatId(); public function getIsEmailVerified(); /** - *

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.

* * @return null|CustomerGroupKeyReference @@ -180,7 +179,7 @@ public function getCustomerGroup(); public function getAddresses(); /** - *

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.

* * @return null|int @@ -188,7 +187,7 @@ public function getAddresses(); public function getDefaultBillingAddress(); /** - *

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.

* * @return null|array @@ -196,7 +195,7 @@ public function getDefaultBillingAddress(); public function getBillingAddresses(); /** - *

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.

* * @return null|int @@ -204,7 +203,7 @@ public function getBillingAddresses(); public function getDefaultShippingAddress(); /** - *

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.

* * @return null|array @@ -220,7 +219,7 @@ public function getShippingAddresses(); public function getLocale(); /** - *

The Custom Fields for this Customer.

+ *

Maps to Customer.custom.

* * @return null|Custom diff --git a/lib/commercetools-import/src/Models/Customers/CustomerImportBuilder.php b/lib/commercetools-import/src/Models/Customers/CustomerImportBuilder.php index 471c52894fc..76a189b65d2 100644 --- a/lib/commercetools-import/src/Models/Customers/CustomerImportBuilder.php +++ b/lib/commercetools-import/src/Models/Customers/CustomerImportBuilder.php @@ -173,7 +173,7 @@ final class CustomerImportBuilder implements Builder private $authenticationMode; /** - *

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.

* * @return null|string @@ -206,7 +206,7 @@ public function getEmail() } /** - *

Required when authenticationMode is set to Password. Maps to Customer.password.

+ *

Maps to Customer.password. Required when authenticationMode is set to Password.

* * @return null|string @@ -217,7 +217,7 @@ public function getPassword() } /** - *

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.

* * @return null|StoreKeyReferenceCollection @@ -338,8 +338,7 @@ public function getIsEmailVerified() } /** - *

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.

* * @return null|CustomerGroupKeyReference @@ -361,7 +360,7 @@ public function getAddresses() } /** - *

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.

* * @return null|int @@ -372,7 +371,7 @@ public function getDefaultBillingAddress() } /** - *

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.

* * @return null|array @@ -383,7 +382,7 @@ public function getBillingAddresses() } /** - *

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.

* * @return null|int @@ -394,7 +393,7 @@ public function getDefaultShippingAddress() } /** - *

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.

* * @return null|array @@ -416,7 +415,7 @@ public function getLocale() } /** - *

The Custom Fields for this Customer.

+ *

Maps to Customer.custom.

* * @return null|Custom diff --git a/lib/commercetools-import/src/Models/Customers/CustomerImportModel.php b/lib/commercetools-import/src/Models/Customers/CustomerImportModel.php index b8b5b9c604d..7a8e93edb88 100644 --- a/lib/commercetools-import/src/Models/Customers/CustomerImportModel.php +++ b/lib/commercetools-import/src/Models/Customers/CustomerImportModel.php @@ -228,7 +228,7 @@ public function __construct( } /** - *

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.

* * * @return null|string @@ -288,7 +288,7 @@ public function getEmail() } /** - *

Required when authenticationMode is set to Password. Maps to Customer.password.

+ *

Maps to Customer.password. Required when authenticationMode is set to Password.

* * * @return null|string @@ -308,7 +308,7 @@ public function getPassword() } /** - *

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.

* * * @return null|StoreKeyReferenceCollection @@ -532,8 +532,7 @@ public function getIsEmailVerified() } /** - *

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.

* * * @return null|CustomerGroupKeyReference @@ -574,7 +573,7 @@ public function getAddresses() } /** - *

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.

* * * @return null|int @@ -594,7 +593,7 @@ public function getDefaultBillingAddress() } /** - *

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.

* * * @return null|array @@ -614,7 +613,7 @@ public function getBillingAddresses() } /** - *

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.

* * * @return null|int @@ -634,7 +633,7 @@ public function getDefaultShippingAddress() } /** - *

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.

* * * @return null|array @@ -674,7 +673,7 @@ public function getLocale() } /** - *

The Custom Fields for this Customer.

+ *

Maps to Customer.custom.

* * * @return null|Custom diff --git a/lib/commercetools-import/src/Models/Customfields/BooleanField.php b/lib/commercetools-import/src/Models/Customfields/BooleanField.php index 5620320ce80..01c55920a3a 100644 --- a/lib/commercetools-import/src/Models/Customfields/BooleanField.php +++ b/lib/commercetools-import/src/Models/Customfields/BooleanField.php @@ -16,6 +16,8 @@ interface BooleanField extends CustomField public const FIELD_VALUE = 'value'; /** + *

true or false

+ * * @return null|bool */ diff --git a/lib/commercetools-import/src/Models/Customfields/BooleanFieldBuilder.php b/lib/commercetools-import/src/Models/Customfields/BooleanFieldBuilder.php index b46e42be6ee..7ed96933ff2 100644 --- a/lib/commercetools-import/src/Models/Customfields/BooleanFieldBuilder.php +++ b/lib/commercetools-import/src/Models/Customfields/BooleanFieldBuilder.php @@ -27,6 +27,8 @@ final class BooleanFieldBuilder implements Builder private $value; /** + *

true or false

+ * * @return null|bool */ diff --git a/lib/commercetools-import/src/Models/Customfields/BooleanFieldModel.php b/lib/commercetools-import/src/Models/Customfields/BooleanFieldModel.php index 0f216452f2f..f640bf7a1de 100644 --- a/lib/commercetools-import/src/Models/Customfields/BooleanFieldModel.php +++ b/lib/commercetools-import/src/Models/Customfields/BooleanFieldModel.php @@ -65,6 +65,8 @@ public function getType() } /** + *

true or false

+ * * * @return null|bool */ diff --git a/lib/commercetools-import/src/Models/Customfields/BooleanSetField.php b/lib/commercetools-import/src/Models/Customfields/BooleanSetField.php index 291ad7f7d64..ebe3a9c0e60 100644 --- a/lib/commercetools-import/src/Models/Customfields/BooleanSetField.php +++ b/lib/commercetools-import/src/Models/Customfields/BooleanSetField.php @@ -16,6 +16,9 @@ interface BooleanSetField extends CustomField public const FIELD_VALUE = '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/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.

* * @return null|TypeKeyReference diff --git a/lib/commercetools-import/src/Models/Customfields/CustomBuilder.php b/lib/commercetools-import/src/Models/Customfields/CustomBuilder.php index ab55daefdcd..3378265fe95 100644 --- a/lib/commercetools-import/src/Models/Customfields/CustomBuilder.php +++ b/lib/commercetools-import/src/Models/Customfields/CustomBuilder.php @@ -35,7 +35,7 @@ final class CustomBuilder implements Builder private $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.

* * @return null|TypeKeyReference diff --git a/lib/commercetools-import/src/Models/Customfields/CustomModel.php b/lib/commercetools-import/src/Models/Customfields/CustomModel.php index 9fd4ac2f0b6..67a10331328 100644 --- a/lib/commercetools-import/src/Models/Customfields/CustomModel.php +++ b/lib/commercetools-import/src/Models/Customfields/CustomModel.php @@ -46,7 +46,7 @@ public function __construct( } /** - *

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.

* * * @return null|TypeKeyReference diff --git a/lib/commercetools-import/src/Models/Customfields/DateField.php b/lib/commercetools-import/src/Models/Customfields/DateField.php index e855d1fd895..b009d9360ea 100644 --- a/lib/commercetools-import/src/Models/Customfields/DateField.php +++ b/lib/commercetools-import/src/Models/Customfields/DateField.php @@ -17,6 +17,8 @@ interface DateField extends CustomField public const FIELD_VALUE = 'value'; /** + *

A date in the format YYYY-MM-DD.

+ * * @return null|DateTimeImmutable */ diff --git a/lib/commercetools-import/src/Models/Customfields/DateFieldBuilder.php b/lib/commercetools-import/src/Models/Customfields/DateFieldBuilder.php index 197befa1873..43c1a29eef9 100644 --- a/lib/commercetools-import/src/Models/Customfields/DateFieldBuilder.php +++ b/lib/commercetools-import/src/Models/Customfields/DateFieldBuilder.php @@ -28,6 +28,8 @@ final class DateFieldBuilder implements Builder private $value; /** + *

A date in the format YYYY-MM-DD.

+ * * @return null|DateTimeImmutable */ diff --git a/lib/commercetools-import/src/Models/Customfields/DateFieldModel.php b/lib/commercetools-import/src/Models/Customfields/DateFieldModel.php index 22b07e6fb5c..d4e336478fb 100644 --- a/lib/commercetools-import/src/Models/Customfields/DateFieldModel.php +++ b/lib/commercetools-import/src/Models/Customfields/DateFieldModel.php @@ -66,6 +66,8 @@ public function getType() } /** + *

A date in the format YYYY-MM-DD.

+ * * * @return null|DateTimeImmutable */ diff --git a/lib/commercetools-import/src/Models/Customfields/DateSetField.php b/lib/commercetools-import/src/Models/Customfields/DateSetField.php index 50900becdd0..3802c994912 100644 --- a/lib/commercetools-import/src/Models/Customfields/DateSetField.php +++ b/lib/commercetools-import/src/Models/Customfields/DateSetField.php @@ -16,6 +16,9 @@ interface DateSetField extends CustomField public const FIELD_VALUE = 'value'; /** + *

JSON array of date values in the format YYYY-MM-DD without duplicates. + * The order of items in the array is not fixed.

+ * * @return null|DateTimeImmutableCollection */ diff --git a/lib/commercetools-import/src/Models/Customfields/DateSetFieldBuilder.php b/lib/commercetools-import/src/Models/Customfields/DateSetFieldBuilder.php index 60ec4972f5a..2bc4eb9aa71 100644 --- a/lib/commercetools-import/src/Models/Customfields/DateSetFieldBuilder.php +++ b/lib/commercetools-import/src/Models/Customfields/DateSetFieldBuilder.php @@ -27,6 +27,9 @@ final class DateSetFieldBuilder implements Builder private $value; /** + *

JSON array of date values in the format YYYY-MM-DD without duplicates. + * The order of items in the array is not fixed.

+ * * @return null|DateTimeImmutableCollection */ diff --git a/lib/commercetools-import/src/Models/Customfields/DateSetFieldModel.php b/lib/commercetools-import/src/Models/Customfields/DateSetFieldModel.php index a05fe1ea4d9..9c1c32443d6 100644 --- a/lib/commercetools-import/src/Models/Customfields/DateSetFieldModel.php +++ b/lib/commercetools-import/src/Models/Customfields/DateSetFieldModel.php @@ -65,6 +65,9 @@ public function getType() } /** + *

JSON array of date values in the format YYYY-MM-DD without duplicates. + * The order of items in the array is not fixed.

+ * * * @return null|DateTimeImmutableCollection */ diff --git a/lib/commercetools-import/src/Models/Customfields/DateTimeField.php b/lib/commercetools-import/src/Models/Customfields/DateTimeField.php index 5055113a4fb..b146e39f0b2 100644 --- a/lib/commercetools-import/src/Models/Customfields/DateTimeField.php +++ b/lib/commercetools-import/src/Models/Customfields/DateTimeField.php @@ -17,6 +17,10 @@ interface DateTimeField extends CustomField public const FIELD_VALUE = 'value'; /** + *

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.

+ * * @return null|DateTimeImmutable */ diff --git a/lib/commercetools-import/src/Models/Customfields/DateTimeFieldBuilder.php b/lib/commercetools-import/src/Models/Customfields/DateTimeFieldBuilder.php index c7a9993c92f..39b6bd51a05 100644 --- a/lib/commercetools-import/src/Models/Customfields/DateTimeFieldBuilder.php +++ b/lib/commercetools-import/src/Models/Customfields/DateTimeFieldBuilder.php @@ -28,6 +28,10 @@ final class DateTimeFieldBuilder implements Builder private $value; /** + *

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.

+ * * @return null|DateTimeImmutable */ diff --git a/lib/commercetools-import/src/Models/Customfields/DateTimeFieldModel.php b/lib/commercetools-import/src/Models/Customfields/DateTimeFieldModel.php index 66daff3f552..8af6fc49599 100644 --- a/lib/commercetools-import/src/Models/Customfields/DateTimeFieldModel.php +++ b/lib/commercetools-import/src/Models/Customfields/DateTimeFieldModel.php @@ -66,6 +66,10 @@ public function getType() } /** + *

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.

+ * * * @return null|DateTimeImmutable */ diff --git a/lib/commercetools-import/src/Models/Customfields/DateTimeSetField.php b/lib/commercetools-import/src/Models/Customfields/DateTimeSetField.php index 8a58c3b1205..4ffb0eeb2f1 100644 --- a/lib/commercetools-import/src/Models/Customfields/DateTimeSetField.php +++ b/lib/commercetools-import/src/Models/Customfields/DateTimeSetField.php @@ -16,6 +16,11 @@ interface DateTimeSetField extends CustomField public const FIELD_VALUE = 'value'; /** + *

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.

+ * * @return null|DateTimeImmutableCollection */ diff --git a/lib/commercetools-import/src/Models/Customfields/DateTimeSetFieldBuilder.php b/lib/commercetools-import/src/Models/Customfields/DateTimeSetFieldBuilder.php index 13babfcc715..1f3dd56c69d 100644 --- a/lib/commercetools-import/src/Models/Customfields/DateTimeSetFieldBuilder.php +++ b/lib/commercetools-import/src/Models/Customfields/DateTimeSetFieldBuilder.php @@ -27,6 +27,11 @@ final class DateTimeSetFieldBuilder implements Builder private $value; /** + *

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.

+ * * @return null|DateTimeImmutableCollection */ diff --git a/lib/commercetools-import/src/Models/Customfields/DateTimeSetFieldModel.php b/lib/commercetools-import/src/Models/Customfields/DateTimeSetFieldModel.php index ea852d3456c..159e5d64138 100644 --- a/lib/commercetools-import/src/Models/Customfields/DateTimeSetFieldModel.php +++ b/lib/commercetools-import/src/Models/Customfields/DateTimeSetFieldModel.php @@ -65,6 +65,11 @@ public function getType() } /** + *

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.

+ * * * @return null|DateTimeImmutableCollection */ diff --git a/lib/commercetools-import/src/Models/Customfields/EnumField.php b/lib/commercetools-import/src/Models/Customfields/EnumField.php index b70f79321c1..194e8e01ec1 100644 --- a/lib/commercetools-import/src/Models/Customfields/EnumField.php +++ b/lib/commercetools-import/src/Models/Customfields/EnumField.php @@ -16,6 +16,9 @@ interface EnumField extends CustomField public const FIELD_VALUE = 'value'; /** + *

The key of the enum value. + * Must be a key of one of the CustomFieldEnumValues defined in the CustomFieldEnumType.

+ * * @return null|string */ diff --git a/lib/commercetools-import/src/Models/Customfields/EnumFieldBuilder.php b/lib/commercetools-import/src/Models/Customfields/EnumFieldBuilder.php index e7edf336e13..90c273943dd 100644 --- a/lib/commercetools-import/src/Models/Customfields/EnumFieldBuilder.php +++ b/lib/commercetools-import/src/Models/Customfields/EnumFieldBuilder.php @@ -27,6 +27,9 @@ final class EnumFieldBuilder implements Builder private $value; /** + *

The key of the enum value. + * Must be a key of one of the CustomFieldEnumValues defined in the CustomFieldEnumType.

+ * * @return null|string */ diff --git a/lib/commercetools-import/src/Models/Customfields/EnumFieldModel.php b/lib/commercetools-import/src/Models/Customfields/EnumFieldModel.php index fdc520b0bd4..a10c98e01dc 100644 --- a/lib/commercetools-import/src/Models/Customfields/EnumFieldModel.php +++ b/lib/commercetools-import/src/Models/Customfields/EnumFieldModel.php @@ -65,6 +65,9 @@ public function getType() } /** + *

The key of the enum value. + * Must be a key of one of the CustomFieldEnumValues defined in the CustomFieldEnumType.

+ * * * @return null|string */ diff --git a/lib/commercetools-import/src/Models/Customfields/EnumSetField.php b/lib/commercetools-import/src/Models/Customfields/EnumSetField.php index 0c1249b9f70..f907f369134 100644 --- a/lib/commercetools-import/src/Models/Customfields/EnumSetField.php +++ b/lib/commercetools-import/src/Models/Customfields/EnumSetField.php @@ -16,6 +16,10 @@ interface EnumSetField extends CustomField public const FIELD_VALUE = '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/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.

+ * * @return null|DateTimeImmutable */ diff --git a/lib/commercetools-import/src/Models/Customfields/TimeFieldBuilder.php b/lib/commercetools-import/src/Models/Customfields/TimeFieldBuilder.php index 644fc5f0728..a557ed218ff 100644 --- a/lib/commercetools-import/src/Models/Customfields/TimeFieldBuilder.php +++ b/lib/commercetools-import/src/Models/Customfields/TimeFieldBuilder.php @@ -28,6 +28,10 @@ final class TimeFieldBuilder implements Builder private $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.

+ * * @return null|DateTimeImmutable */ diff --git a/lib/commercetools-import/src/Models/Customfields/TimeFieldModel.php b/lib/commercetools-import/src/Models/Customfields/TimeFieldModel.php index adad853d5d8..43ac7d8d57b 100644 --- a/lib/commercetools-import/src/Models/Customfields/TimeFieldModel.php +++ b/lib/commercetools-import/src/Models/Customfields/TimeFieldModel.php @@ -66,6 +66,10 @@ public function getType() } /** + *

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.

+ * * * @return null|DateTimeImmutable */ diff --git a/lib/commercetools-import/src/Models/Customfields/TimeSetField.php b/lib/commercetools-import/src/Models/Customfields/TimeSetField.php index a99274cb129..34baf796bba 100644 --- a/lib/commercetools-import/src/Models/Customfields/TimeSetField.php +++ b/lib/commercetools-import/src/Models/Customfields/TimeSetField.php @@ -16,6 +16,11 @@ interface TimeSetField extends CustomField public const FIELD_VALUE = 'value'; /** + *

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.

+ * * @return null|DateTimeImmutableCollection */ diff --git a/lib/commercetools-import/src/Models/Customfields/TimeSetFieldBuilder.php b/lib/commercetools-import/src/Models/Customfields/TimeSetFieldBuilder.php index 09f20b1ae3c..e33800b0bb8 100644 --- a/lib/commercetools-import/src/Models/Customfields/TimeSetFieldBuilder.php +++ b/lib/commercetools-import/src/Models/Customfields/TimeSetFieldBuilder.php @@ -27,6 +27,11 @@ final class TimeSetFieldBuilder implements Builder private $value; /** + *

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.

+ * * @return null|DateTimeImmutableCollection */ diff --git a/lib/commercetools-import/src/Models/Customfields/TimeSetFieldModel.php b/lib/commercetools-import/src/Models/Customfields/TimeSetFieldModel.php index b380a9fa7b2..1730a578bfd 100644 --- a/lib/commercetools-import/src/Models/Customfields/TimeSetFieldModel.php +++ b/lib/commercetools-import/src/Models/Customfields/TimeSetFieldModel.php @@ -65,6 +65,11 @@ public function getType() } /** + *

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.

+ * * * @return null|DateTimeImmutableCollection */ diff --git a/lib/commercetools-import/src/Models/DiscountCodes/DiscountCodeImport.php b/lib/commercetools-import/src/Models/DiscountCodes/DiscountCodeImport.php index 3dc04a19a39..c38403aaeac 100644 --- a/lib/commercetools-import/src/Models/DiscountCodes/DiscountCodeImport.php +++ b/lib/commercetools-import/src/Models/DiscountCodes/DiscountCodeImport.php @@ -32,7 +32,7 @@ interface DiscountCodeImport extends ImportResource public const FIELD_CUSTOM = '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.

* * @return null|string @@ -56,8 +56,7 @@ public function getName(); public function getDescription(); /** - *

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.

* * @return null|string @@ -65,7 +64,7 @@ public function getDescription(); public function getCode(); /** - *

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.

* * @return null|CartDiscountKeyReferenceCollection @@ -73,7 +72,7 @@ public function getCode(); public function getCartDiscounts(); /** - *

DiscountCode can only be applied to Carts that match this predicate.

+ *

Maps to DiscountCode.cartPredicate.

* * @return null|string @@ -81,7 +80,7 @@ public function getCartDiscounts(); public function getCartPredicate(); /** - *

Indicates if the DiscountCode is active and can be applied to the Cart.

+ *

Maps to DiscountCode.isActive.

* * @return null|bool @@ -89,7 +88,7 @@ public function getCartPredicate(); public function getIsActive(); /** - *

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.

* * @return null|int @@ -97,7 +96,7 @@ public function getIsActive(); public function getMaxApplications(); /** - *

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.

* * @return null|int @@ -105,7 +104,7 @@ public function getMaxApplications(); public function getMaxApplicationsPerCustomer(); /** - *

Groups to which the DiscountCode belongs.

+ *

Maps to DiscountCode.groups.

* * @return null|array @@ -113,7 +112,7 @@ public function getMaxApplicationsPerCustomer(); public function getGroups(); /** - *

Date and time (UTC) from which the DiscountCode is effective.

+ *

Maps to DiscountCode.validFrom.

* * @return null|DateTimeImmutable @@ -121,7 +120,7 @@ public function getGroups(); public function getValidFrom(); /** - *

Date and time (UTC) until which the DiscountCode is effective.

+ *

Maps to DiscountCode.validUntil.

* * @return null|DateTimeImmutable @@ -129,7 +128,7 @@ public function getValidFrom(); public function getValidUntil(); /** - *

Custom Fields of the DiscountCode.

+ *

Maps to DiscountCode.custom.

* * @return null|Custom diff --git a/lib/commercetools-import/src/Models/DiscountCodes/DiscountCodeImportBuilder.php b/lib/commercetools-import/src/Models/DiscountCodes/DiscountCodeImportBuilder.php index af51a5f54e6..6d5339e3b10 100644 --- a/lib/commercetools-import/src/Models/DiscountCodes/DiscountCodeImportBuilder.php +++ b/lib/commercetools-import/src/Models/DiscountCodes/DiscountCodeImportBuilder.php @@ -107,7 +107,7 @@ final class DiscountCodeImportBuilder implements Builder private $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.

* * @return null|string @@ -140,8 +140,7 @@ public function getDescription() } /** - *

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.

* * @return null|string @@ -152,7 +151,7 @@ public function getCode() } /** - *

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.

* * @return null|CartDiscountKeyReferenceCollection @@ -163,7 +162,7 @@ public function getCartDiscounts() } /** - *

DiscountCode can only be applied to Carts that match this predicate.

+ *

Maps to DiscountCode.cartPredicate.

* * @return null|string @@ -174,7 +173,7 @@ public function getCartPredicate() } /** - *

Indicates if the DiscountCode is active and can be applied to the Cart.

+ *

Maps to DiscountCode.isActive.

* * @return null|bool @@ -185,7 +184,7 @@ public function getIsActive() } /** - *

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.

* * @return null|int @@ -196,7 +195,7 @@ public function getMaxApplications() } /** - *

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.

* * @return null|int @@ -207,7 +206,7 @@ public function getMaxApplicationsPerCustomer() } /** - *

Groups to which the DiscountCode belongs.

+ *

Maps to DiscountCode.groups.

* * @return null|array @@ -218,7 +217,7 @@ public function getGroups() } /** - *

Date and time (UTC) from which the DiscountCode is effective.

+ *

Maps to DiscountCode.validFrom.

* * @return null|DateTimeImmutable @@ -229,7 +228,7 @@ public function getValidFrom() } /** - *

Date and time (UTC) until which the DiscountCode is effective.

+ *

Maps to DiscountCode.validUntil.

* * @return null|DateTimeImmutable @@ -240,7 +239,7 @@ public function getValidUntil() } /** - *

Custom Fields of the DiscountCode.

+ *

Maps to DiscountCode.custom.

* * @return null|Custom diff --git a/lib/commercetools-import/src/Models/DiscountCodes/DiscountCodeImportModel.php b/lib/commercetools-import/src/Models/DiscountCodes/DiscountCodeImportModel.php index 6945a2c0d5d..1e9651eb826 100644 --- a/lib/commercetools-import/src/Models/DiscountCodes/DiscountCodeImportModel.php +++ b/lib/commercetools-import/src/Models/DiscountCodes/DiscountCodeImportModel.php @@ -140,7 +140,7 @@ public function __construct( } /** - *

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.

* * * @return null|string @@ -202,8 +202,7 @@ public function getDescription() } /** - *

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.

* * * @return null|string @@ -223,7 +222,7 @@ public function getCode() } /** - *

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.

* * * @return null|CartDiscountKeyReferenceCollection @@ -243,7 +242,7 @@ public function getCartDiscounts() } /** - *

DiscountCode can only be applied to Carts that match this predicate.

+ *

Maps to DiscountCode.cartPredicate.

* * * @return null|string @@ -263,7 +262,7 @@ public function getCartPredicate() } /** - *

Indicates if the DiscountCode is active and can be applied to the Cart.

+ *

Maps to DiscountCode.isActive.

* * * @return null|bool @@ -283,7 +282,7 @@ public function getIsActive() } /** - *

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.

* * * @return null|int @@ -303,7 +302,7 @@ public function getMaxApplications() } /** - *

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.

* * * @return null|int @@ -323,7 +322,7 @@ public function getMaxApplicationsPerCustomer() } /** - *

Groups to which the DiscountCode belongs.

+ *

Maps to DiscountCode.groups.

* * * @return null|array @@ -343,7 +342,7 @@ public function getGroups() } /** - *

Date and time (UTC) from which the DiscountCode is effective.

+ *

Maps to DiscountCode.validFrom.

* * * @return null|DateTimeImmutable @@ -367,7 +366,7 @@ public function getValidFrom() } /** - *

Date and time (UTC) until which the DiscountCode is effective.

+ *

Maps to DiscountCode.validUntil.

* * * @return null|DateTimeImmutable @@ -391,7 +390,7 @@ public function getValidUntil() } /** - *

Custom Fields of the DiscountCode.

+ *

Maps to DiscountCode.custom.

* * * @return null|Custom diff --git a/lib/commercetools-import/src/Models/Errors/InvalidFieldError.php b/lib/commercetools-import/src/Models/Errors/InvalidFieldError.php index eb2bb07f78a..24212b14bbb 100644 --- a/lib/commercetools-import/src/Models/Errors/InvalidFieldError.php +++ b/lib/commercetools-import/src/Models/Errors/InvalidFieldError.php @@ -43,6 +43,8 @@ public function getInvalidValue(); 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/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.

* * @return null|string @@ -45,7 +45,7 @@ public function getVersion(); public function getImportContainerKey(); /** - *

The key of the resource.

+ *

key of the resource being imported.

* * @return null|string @@ -53,7 +53,7 @@ public function getImportContainerKey(); public function getResourceKey(); /** - *

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.

* * @return null|string @@ -69,7 +69,7 @@ public function getId(); public function getState(); /** - *

The version of the imported resource when the import was successful.

+ *

The version of the imported resource when the import was successful.

* * @return null|int @@ -77,7 +77,7 @@ public function getState(); public function getResourceVersion(); /** - *

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.

* * @return null|string @@ -112,7 +112,7 @@ public function getImportContainerKey() } /** - *

The key of the resource.

+ *

key of the resource being imported.

* * @return null|string @@ -123,7 +123,7 @@ public function getResourceKey() } /** - *

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.

* * @return null|string @@ -145,7 +145,7 @@ public function getState() } /** - *

The version of the imported resource when the import was successful.

+ *

The version of the imported resource when the import was successful.

* * @return null|int @@ -156,7 +156,7 @@ public function getResourceVersion() } /** - *

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.

* * * @return null|string @@ -159,7 +159,7 @@ public function getImportContainerKey() } /** - *

The key of the resource.

+ *

key of the resource being imported.

* * * @return null|string @@ -179,7 +179,7 @@ public function getResourceKey() } /** - *

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.

* * * @return null|string @@ -219,7 +219,7 @@ public function getState() } /** - *

The version of the imported resource when the import was successful.

+ *

The version of the imported resource when the import was successful.

* * * @return null|int @@ -239,7 +239,7 @@ public function getResourceVersion() } /** - *

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.

* * @return null|string @@ -27,7 +27,7 @@ interface ImportOperationStatus extends JsonObject public function getOperationId(); /** - *

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.

* * @return null|string @@ -51,7 +51,7 @@ public function getOperationId() } /** - *

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.

* * * @return null|string @@ -73,7 +73,7 @@ public function getOperationId() } /** - *

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 ?list $data */ + $data = $this->raw(self::FIELD_RESOURCES); + if (is_null($data)) { + return null; + } + $this->resources = ProductSelectionImportCollection::fromArray($data); + } + + return $this->resources; + } + + + /** + * @param ?ProductSelectionImportCollection $resources + */ + public function setResources(?ProductSelectionImportCollection $resources): void + { + $this->resources = $resources; + } +} diff --git a/lib/commercetools-import/src/Models/Importsummaries/ImportSummary.php b/lib/commercetools-import/src/Models/Importsummaries/ImportSummary.php index cff42cebb9d..84659652358 100644 --- a/lib/commercetools-import/src/Models/Importsummaries/ImportSummary.php +++ b/lib/commercetools-import/src/Models/Importsummaries/ImportSummary.php @@ -17,7 +17,7 @@ interface ImportSummary extends JsonObject public const FIELD_TOTAL = 'total'; /** - *

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 @@ -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.

* * @return null|int diff --git a/lib/commercetools-import/src/Models/Importsummaries/ImportSummaryBuilder.php b/lib/commercetools-import/src/Models/Importsummaries/ImportSummaryBuilder.php index be1f75b3d4d..796128a8db4 100644 --- a/lib/commercetools-import/src/Models/Importsummaries/ImportSummaryBuilder.php +++ b/lib/commercetools-import/src/Models/Importsummaries/ImportSummaryBuilder.php @@ -33,7 +33,7 @@ final class ImportSummaryBuilder implements Builder private $total; /** - *

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.

* * @return null|int diff --git a/lib/commercetools-import/src/Models/Importsummaries/ImportSummaryModel.php b/lib/commercetools-import/src/Models/Importsummaries/ImportSummaryModel.php index 6cf7e5301b3..254c05dc9c0 100644 --- a/lib/commercetools-import/src/Models/Importsummaries/ImportSummaryModel.php +++ b/lib/commercetools-import/src/Models/Importsummaries/ImportSummaryModel.php @@ -44,7 +44,7 @@ public function __construct( } /** - *

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.

* * * @return null|int diff --git a/lib/commercetools-import/src/Models/Importsummaries/OperationStates.php b/lib/commercetools-import/src/Models/Importsummaries/OperationStates.php index 68402a91755..54623ca27c3 100644 --- a/lib/commercetools-import/src/Models/Importsummaries/OperationStates.php +++ b/lib/commercetools-import/src/Models/Importsummaries/OperationStates.php @@ -22,7 +22,7 @@ interface OperationStates extends JsonObject public const FIELD_CANCELED = 'canceled'; /** - *

The number of resources in the processing state.

+ *

The number of ImportOperations in the processing state.

* * @return null|int @@ -30,7 +30,7 @@ interface OperationStates extends JsonObject public function getProcessing(); /** - *

The number of resources in the validationFailed state.

+ *

The number of ImportOperations in the validationFailed state.

* * @return null|int @@ -38,7 +38,7 @@ public function getProcessing(); public function getValidationFailed(); /** - *

The number of resources in the unresolved state.

+ *

The number of ImportOperations in the unresolved state.

* * @return null|int @@ -46,7 +46,7 @@ public function getValidationFailed(); public function getUnresolved(); /** - *

The number of resources in the waitForMasterVariant state.

+ *

The number of ImportOperations in the waitForMasterVariant state.

* * @return null|int @@ -54,7 +54,7 @@ public function getUnresolved(); public function getWaitForMasterVariant(); /** - *

The number of resources in the imported state.

+ *

The number of ImportOperations in the imported state.

* * @return null|int @@ -62,7 +62,7 @@ public function getWaitForMasterVariant(); public function getImported(); /** - *

The number of resources in the rejected state.

+ *

The number of ImportOperations in the rejected state.

* * @return null|int @@ -70,7 +70,7 @@ public function getImported(); public function getRejected(); /** - *

The number of resources in the canceled state.

+ *

The number of ImportOperations in the canceled state.

* * @return null|int diff --git a/lib/commercetools-import/src/Models/Importsummaries/OperationStatesBuilder.php b/lib/commercetools-import/src/Models/Importsummaries/OperationStatesBuilder.php index 43d24094863..fe2e43495a2 100644 --- a/lib/commercetools-import/src/Models/Importsummaries/OperationStatesBuilder.php +++ b/lib/commercetools-import/src/Models/Importsummaries/OperationStatesBuilder.php @@ -63,7 +63,7 @@ final class OperationStatesBuilder implements Builder private $canceled; /** - *

The number of resources in the processing state.

+ *

The number of ImportOperations in the processing state.

* * @return null|int @@ -74,7 +74,7 @@ public function getProcessing() } /** - *

The number of resources in the validationFailed state.

+ *

The number of ImportOperations in the validationFailed state.

* * @return null|int @@ -85,7 +85,7 @@ public function getValidationFailed() } /** - *

The number of resources in the unresolved state.

+ *

The number of ImportOperations in the unresolved state.

* * @return null|int @@ -96,7 +96,7 @@ public function getUnresolved() } /** - *

The number of resources in the waitForMasterVariant state.

+ *

The number of ImportOperations in the waitForMasterVariant state.

* * @return null|int @@ -107,7 +107,7 @@ public function getWaitForMasterVariant() } /** - *

The number of resources in the imported state.

+ *

The number of ImportOperations in the imported state.

* * @return null|int @@ -118,7 +118,7 @@ public function getImported() } /** - *

The number of resources in the rejected state.

+ *

The number of ImportOperations in the rejected state.

* * @return null|int @@ -129,7 +129,7 @@ public function getRejected() } /** - *

The number of resources in the canceled state.

+ *

The number of ImportOperations in the canceled state.

* * @return null|int diff --git a/lib/commercetools-import/src/Models/Importsummaries/OperationStatesModel.php b/lib/commercetools-import/src/Models/Importsummaries/OperationStatesModel.php index 1b50719b061..8526bc3e5b8 100644 --- a/lib/commercetools-import/src/Models/Importsummaries/OperationStatesModel.php +++ b/lib/commercetools-import/src/Models/Importsummaries/OperationStatesModel.php @@ -84,7 +84,7 @@ public function __construct( } /** - *

The number of resources in the processing state.

+ *

The number of ImportOperations in the processing state.

* * * @return null|int @@ -104,7 +104,7 @@ public function getProcessing() } /** - *

The number of resources in the validationFailed state.

+ *

The number of ImportOperations in the validationFailed state.

* * * @return null|int @@ -124,7 +124,7 @@ public function getValidationFailed() } /** - *

The number of resources in the unresolved state.

+ *

The number of ImportOperations in the unresolved state.

* * * @return null|int @@ -144,7 +144,7 @@ public function getUnresolved() } /** - *

The number of resources in the waitForMasterVariant state.

+ *

The number of ImportOperations in the waitForMasterVariant state.

* * * @return null|int @@ -164,7 +164,7 @@ public function getWaitForMasterVariant() } /** - *

The number of resources in the imported state.

+ *

The number of ImportOperations in the imported state.

* * * @return null|int @@ -184,7 +184,7 @@ public function getImported() } /** - *

The number of resources in the rejected state.

+ *

The number of ImportOperations in the rejected state.

* * * @return null|int @@ -204,7 +204,7 @@ public function getRejected() } /** - *

The number of resources in the canceled state.

+ *

The number of ImportOperations in the canceled state.

* * * @return null|int diff --git a/lib/commercetools-import/src/Models/Inventories/InventoryImport.php b/lib/commercetools-import/src/Models/Inventories/InventoryImport.php index 84fadd41f51..b6ec218f48d 100644 --- a/lib/commercetools-import/src/Models/Inventories/InventoryImport.php +++ b/lib/commercetools-import/src/Models/Inventories/InventoryImport.php @@ -25,7 +25,7 @@ interface InventoryImport extends ImportResource public const FIELD_CUSTOM = '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.

* * @return null|string @@ -33,7 +33,7 @@ interface InventoryImport extends ImportResource public function getKey(); /** - *

Maps to Inventory.sku

+ *

Maps to InventoryEntry.sku

* * @return null|string @@ -41,7 +41,7 @@ public function getKey(); public function getSku(); /** - *

Maps to Inventory.quantityOnStock

+ *

Maps to InventoryEntry.quantityOnStock

* * @return null|int @@ -49,7 +49,7 @@ public function getSku(); public function getQuantityOnStock(); /** - *

Maps to Inventory.restockableInDays

+ *

Maps to InventoryEntry.restockableInDays

* * @return null|int @@ -57,7 +57,7 @@ public function getQuantityOnStock(); public function getRestockableInDays(); /** - *

Maps to Inventory.expectedDelivery

+ *

Maps to InventoryEntry.expectedDelivery

* * @return null|DateTimeImmutable @@ -65,7 +65,7 @@ public function getRestockableInDays(); public function getExpectedDelivery(); /** - *

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.

* * @return null|ChannelKeyReference @@ -73,7 +73,7 @@ public function getExpectedDelivery(); public function getSupplyChannel(); /** - *

Maps to Inventory.custom.

+ *

Maps to InventoryEntry.custom.

* * @return null|Custom diff --git a/lib/commercetools-import/src/Models/Inventories/InventoryImportBuilder.php b/lib/commercetools-import/src/Models/Inventories/InventoryImportBuilder.php index 35ba6e62aea..1a9a7324e5e 100644 --- a/lib/commercetools-import/src/Models/Inventories/InventoryImportBuilder.php +++ b/lib/commercetools-import/src/Models/Inventories/InventoryImportBuilder.php @@ -70,7 +70,7 @@ final class InventoryImportBuilder implements Builder private $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.

* * @return null|string @@ -81,7 +81,7 @@ public function getKey() } /** - *

Maps to Inventory.sku

+ *

Maps to InventoryEntry.sku

* * @return null|string @@ -92,7 +92,7 @@ public function getSku() } /** - *

Maps to Inventory.quantityOnStock

+ *

Maps to InventoryEntry.quantityOnStock

* * @return null|int @@ -103,7 +103,7 @@ public function getQuantityOnStock() } /** - *

Maps to Inventory.restockableInDays

+ *

Maps to InventoryEntry.restockableInDays

* * @return null|int @@ -114,7 +114,7 @@ public function getRestockableInDays() } /** - *

Maps to Inventory.expectedDelivery

+ *

Maps to InventoryEntry.expectedDelivery

* * @return null|DateTimeImmutable @@ -125,7 +125,7 @@ public function getExpectedDelivery() } /** - *

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.

* * @return null|ChannelKeyReference @@ -136,7 +136,7 @@ public function getSupplyChannel() } /** - *

Maps to Inventory.custom.

+ *

Maps to InventoryEntry.custom.

* * @return null|Custom diff --git a/lib/commercetools-import/src/Models/Inventories/InventoryImportModel.php b/lib/commercetools-import/src/Models/Inventories/InventoryImportModel.php index 90ee1fbc815..9f943c06bc3 100644 --- a/lib/commercetools-import/src/Models/Inventories/InventoryImportModel.php +++ b/lib/commercetools-import/src/Models/Inventories/InventoryImportModel.php @@ -91,7 +91,7 @@ public function __construct( } /** - *

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.

* * * @return null|string @@ -111,7 +111,7 @@ public function getKey() } /** - *

Maps to Inventory.sku

+ *

Maps to InventoryEntry.sku

* * * @return null|string @@ -131,7 +131,7 @@ public function getSku() } /** - *

Maps to Inventory.quantityOnStock

+ *

Maps to InventoryEntry.quantityOnStock

* * * @return null|int @@ -151,7 +151,7 @@ public function getQuantityOnStock() } /** - *

Maps to Inventory.restockableInDays

+ *

Maps to InventoryEntry.restockableInDays

* * * @return null|int @@ -171,7 +171,7 @@ public function getRestockableInDays() } /** - *

Maps to Inventory.expectedDelivery

+ *

Maps to InventoryEntry.expectedDelivery

* * * @return null|DateTimeImmutable @@ -195,7 +195,7 @@ public function getExpectedDelivery() } /** - *

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.

* * * @return null|ChannelKeyReference @@ -216,7 +216,7 @@ public function getSupplyChannel() } /** - *

Maps to Inventory.custom.

+ *

Maps to InventoryEntry.custom.

* * * @return null|Custom diff --git a/lib/commercetools-import/src/Models/OrderPatches/DeliveryAddressDraft.php b/lib/commercetools-import/src/Models/OrderPatches/DeliveryAddressDraft.php index 2f325594aa6..e27b297a365 100644 --- a/lib/commercetools-import/src/Models/OrderPatches/DeliveryAddressDraft.php +++ b/lib/commercetools-import/src/Models/OrderPatches/DeliveryAddressDraft.php @@ -18,12 +18,16 @@ interface DeliveryAddressDraft extends JsonObject public const FIELD_ADDRESS = 'address'; /** + *

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.

* * @return null|string @@ -25,7 +25,7 @@ interface OrderPatchImport extends JsonObject public function getOrderNumber(); /** - *

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.

* * @return null|OrderField diff --git a/lib/commercetools-import/src/Models/OrderPatches/OrderPatchImportBuilder.php b/lib/commercetools-import/src/Models/OrderPatches/OrderPatchImportBuilder.php index 21253edaa8f..7cc830459dc 100644 --- a/lib/commercetools-import/src/Models/OrderPatches/OrderPatchImportBuilder.php +++ b/lib/commercetools-import/src/Models/OrderPatches/OrderPatchImportBuilder.php @@ -33,7 +33,7 @@ final class OrderPatchImportBuilder implements Builder private $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.

* * @return null|string @@ -44,7 +44,7 @@ public function getOrderNumber() } /** - *

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.

* * @return null|OrderField diff --git a/lib/commercetools-import/src/Models/OrderPatches/OrderPatchImportModel.php b/lib/commercetools-import/src/Models/OrderPatches/OrderPatchImportModel.php index ec31414f911..0611ea7f6f2 100644 --- a/lib/commercetools-import/src/Models/OrderPatches/OrderPatchImportModel.php +++ b/lib/commercetools-import/src/Models/OrderPatches/OrderPatchImportModel.php @@ -44,7 +44,7 @@ public function __construct( } /** - *

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.

* * * @return null|string @@ -64,7 +64,7 @@ public function getOrderNumber() } /** - *

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.

* * * @return null|OrderField diff --git a/lib/commercetools-import/src/Models/OrderPatches/ParcelItems.php b/lib/commercetools-import/src/Models/OrderPatches/ParcelItems.php index ecc9e5ca153..27c055fc612 100644 --- a/lib/commercetools-import/src/Models/OrderPatches/ParcelItems.php +++ b/lib/commercetools-import/src/Models/OrderPatches/ParcelItems.php @@ -18,12 +18,16 @@ interface ParcelItems extends JsonObject public const FIELD_ITEMS = 'items'; /** + *

id of an existing Parcel.

+ * * @return null|string */ public function getParcelId(); /** + *

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.

+ * * @return null|string */ @@ -43,6 +45,8 @@ public function getParcelId() } /** + *

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.

+ * * * @return null|string */ @@ -63,6 +65,8 @@ public function getParcelId() } /** + *

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.

+ * * @return null|string */ public function getParcelId(); /** + *

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.

+ * * @return null|string */ @@ -44,6 +46,8 @@ public function getParcelId() } /** + *

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.

+ * * * @return null|string */ @@ -64,6 +66,8 @@ public function getParcelId() } /** + *

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.

+ * * @return null|string */ public function getParcelId(); /** + *

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.

+ * * @return null|string */ @@ -44,6 +46,8 @@ public function getParcelId() } /** + *

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.

+ * * * @return null|string */ @@ -64,6 +66,8 @@ public function getParcelId() } /** + *

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.

+ * * @return null|string */ diff --git a/lib/commercetools-import/src/Models/OrderPatches/RemoveParcelFromDeliveryDraftBuilder.php b/lib/commercetools-import/src/Models/OrderPatches/RemoveParcelFromDeliveryDraftBuilder.php index 71826a5adad..36a4f13083b 100644 --- a/lib/commercetools-import/src/Models/OrderPatches/RemoveParcelFromDeliveryDraftBuilder.php +++ b/lib/commercetools-import/src/Models/OrderPatches/RemoveParcelFromDeliveryDraftBuilder.php @@ -27,6 +27,8 @@ final class RemoveParcelFromDeliveryDraftBuilder implements Builder private $parcelId; /** + *

id of the Parcel to be removed from the Delivery.

+ * * @return null|string */ diff --git a/lib/commercetools-import/src/Models/OrderPatches/RemoveParcelFromDeliveryDraftModel.php b/lib/commercetools-import/src/Models/OrderPatches/RemoveParcelFromDeliveryDraftModel.php index 4239fe06614..1b3725a61c2 100644 --- a/lib/commercetools-import/src/Models/OrderPatches/RemoveParcelFromDeliveryDraftModel.php +++ b/lib/commercetools-import/src/Models/OrderPatches/RemoveParcelFromDeliveryDraftModel.php @@ -36,6 +36,8 @@ public function __construct( } /** + *

id of the Parcel to be removed from the Delivery.

+ * * * @return null|string */ diff --git a/lib/commercetools-import/src/Models/OrderPatches/ReturnInfo.php b/lib/commercetools-import/src/Models/OrderPatches/ReturnInfo.php index cee84506b21..29a19d6972a 100644 --- a/lib/commercetools-import/src/Models/OrderPatches/ReturnInfo.php +++ b/lib/commercetools-import/src/Models/OrderPatches/ReturnInfo.php @@ -19,13 +19,15 @@ interface ReturnInfo extends JsonObject public const FIELD_RETURN_DATE = 'returnDate'; /** + *

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.

* * @return null|LocalizedString @@ -44,43 +39,55 @@ interface CustomLineItemDraft extends JsonObject public function getName(); /** + *

Maps to CustomLineItem.money.

+ * * @return null|TypedMoney */ public function getMoney(); /** + *

Maps to CustomLineItem.taxedPrice.

+ * * @return null|CustomLineItemTaxedPrice */ public function getTaxedPrice(); /** + *

Maps to CustomLineItem.totalPrice.

+ * * @return null|TypedMoney */ public function getTotalPrice(); /** + *

Maps to CustomLineItem.slug.

+ * * @return null|string */ public function getSlug(); /** + *

Maps to CustomLineItem.quantity.

+ * * @return null|int */ public function getQuantity(); /** + *

Maps to CustomLineItem.state.

+ * * @return null|ItemStateCollection */ public function getState(); /** - *

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.

* * @return null|TaxCategoryKeyReference @@ -88,24 +95,32 @@ public function getState(); public function getTaxCategory(); /** + *

Maps to CustomLineItem.taxRate.

+ * * @return null|TaxRate */ public function getTaxRate(); /** + *

External Tax Rate for the Custom Line Item if the Cart has the External TaxMode.

+ * * @return null|ExternalTaxRateDraft */ public function getExternalTaxRate(); /** + *

Maps to CustomLineItem.discountedPricePerQuantity.

+ * * @return null|DiscountedLineItemPriceDraftCollection */ public function getDiscountedPricePerQuantity(); /** + *

Maps to CustomLineItem.shippingDetails.

+ * * @return null|ItemShippingDetailsDraft */ diff --git a/lib/commercetools-import/src/Models/Orders/CustomLineItemDraftBuilder.php b/lib/commercetools-import/src/Models/Orders/CustomLineItemDraftBuilder.php index cd1c48560a0..2d2befebe7d 100644 --- a/lib/commercetools-import/src/Models/Orders/CustomLineItemDraftBuilder.php +++ b/lib/commercetools-import/src/Models/Orders/CustomLineItemDraftBuilder.php @@ -101,12 +101,7 @@ final class CustomLineItemDraftBuilder implements Builder private $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.

* * @return null|LocalizedString @@ -117,6 +112,8 @@ public function getName() } /** + *

Maps to CustomLineItem.money.

+ * * @return null|TypedMoney */ @@ -126,6 +123,8 @@ public function getMoney() } /** + *

Maps to CustomLineItem.taxedPrice.

+ * * @return null|CustomLineItemTaxedPrice */ @@ -135,6 +134,8 @@ public function getTaxedPrice() } /** + *

Maps to CustomLineItem.totalPrice.

+ * * @return null|TypedMoney */ @@ -144,6 +145,8 @@ public function getTotalPrice() } /** + *

Maps to CustomLineItem.slug.

+ * * @return null|string */ @@ -153,6 +156,8 @@ public function getSlug() } /** + *

Maps to CustomLineItem.quantity.

+ * * @return null|int */ @@ -162,6 +167,8 @@ public function getQuantity() } /** + *

Maps to CustomLineItem.state.

+ * * @return null|ItemStateCollection */ @@ -171,7 +178,7 @@ public function getState() } /** - *

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.

* * @return null|TaxCategoryKeyReference @@ -182,6 +189,8 @@ public function getTaxCategory() } /** + *

Maps to CustomLineItem.taxRate.

+ * * @return null|TaxRate */ @@ -191,6 +200,8 @@ public function getTaxRate() } /** + *

External Tax Rate for the Custom Line Item if the Cart has the External TaxMode.

+ * * @return null|ExternalTaxRateDraft */ @@ -200,6 +211,8 @@ public function getExternalTaxRate() } /** + *

Maps to CustomLineItem.discountedPricePerQuantity.

+ * * @return null|DiscountedLineItemPriceDraftCollection */ @@ -209,6 +222,8 @@ public function getDiscountedPricePerQuantity() } /** + *

Maps to CustomLineItem.shippingDetails.

+ * * @return null|ItemShippingDetailsDraft */ diff --git a/lib/commercetools-import/src/Models/Orders/CustomLineItemDraftModel.php b/lib/commercetools-import/src/Models/Orders/CustomLineItemDraftModel.php index 28b68c5723e..3cf32976a5e 100644 --- a/lib/commercetools-import/src/Models/Orders/CustomLineItemDraftModel.php +++ b/lib/commercetools-import/src/Models/Orders/CustomLineItemDraftModel.php @@ -132,12 +132,7 @@ public function __construct( } /** - *

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.

* * * @return null|LocalizedString @@ -158,6 +153,8 @@ public function getName() } /** + *

Maps to CustomLineItem.money.

+ * * * @return null|TypedMoney */ @@ -177,6 +174,8 @@ public function getMoney() } /** + *

Maps to CustomLineItem.taxedPrice.

+ * * * @return null|CustomLineItemTaxedPrice */ @@ -196,6 +195,8 @@ public function getTaxedPrice() } /** + *

Maps to CustomLineItem.totalPrice.

+ * * * @return null|TypedMoney */ @@ -215,6 +216,8 @@ public function getTotalPrice() } /** + *

Maps to CustomLineItem.slug.

+ * * * @return null|string */ @@ -233,6 +236,8 @@ public function getSlug() } /** + *

Maps to CustomLineItem.quantity.

+ * * * @return null|int */ @@ -251,6 +256,8 @@ public function getQuantity() } /** + *

Maps to CustomLineItem.state.

+ * * * @return null|ItemStateCollection */ @@ -269,7 +276,7 @@ public function getState() } /** - *

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.

* * * @return null|TaxCategoryKeyReference @@ -290,6 +297,8 @@ public function getTaxCategory() } /** + *

Maps to CustomLineItem.taxRate.

+ * * * @return null|TaxRate */ @@ -309,6 +318,8 @@ public function getTaxRate() } /** + *

External Tax Rate for the Custom Line Item if the Cart has the External TaxMode.

+ * * * @return null|ExternalTaxRateDraft */ @@ -328,6 +339,8 @@ public function getExternalTaxRate() } /** + *

Maps to CustomLineItem.discountedPricePerQuantity.

+ * * * @return null|DiscountedLineItemPriceDraftCollection */ @@ -346,6 +359,8 @@ public function getDiscountedPricePerQuantity() } /** + *

Maps to CustomLineItem.shippingDetails.

+ * * * @return null|ItemShippingDetailsDraft */ diff --git a/lib/commercetools-import/src/Models/Orders/Delivery.php b/lib/commercetools-import/src/Models/Orders/Delivery.php index 9d6340b4bd5..f45c1f2e63a 100644 --- a/lib/commercetools-import/src/Models/Orders/Delivery.php +++ b/lib/commercetools-import/src/Models/Orders/Delivery.php @@ -22,30 +22,40 @@ interface Delivery extends JsonObject public const FIELD_ADDRESS = 'address'; /** + *

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.

+ * * @return null|string */ public function getId(); /** + *

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.

+ * * @return null|string */ @@ -42,6 +44,8 @@ public function getId() } /** + *

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.

+ * * * @return null|string */ @@ -62,6 +64,8 @@ public function getId() } /** + *

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.

* * @return null|DiscountCodeKeyReference diff --git a/lib/commercetools-import/src/Models/Orders/DiscountCodeInfoBuilder.php b/lib/commercetools-import/src/Models/Orders/DiscountCodeInfoBuilder.php index 8e96c83416a..a4314822b6e 100644 --- a/lib/commercetools-import/src/Models/Orders/DiscountCodeInfoBuilder.php +++ b/lib/commercetools-import/src/Models/Orders/DiscountCodeInfoBuilder.php @@ -35,7 +35,7 @@ final class DiscountCodeInfoBuilder implements Builder private $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.

* * @return null|DiscountCodeKeyReference diff --git a/lib/commercetools-import/src/Models/Orders/DiscountCodeInfoModel.php b/lib/commercetools-import/src/Models/Orders/DiscountCodeInfoModel.php index 35de2cc7c94..382f166651c 100644 --- a/lib/commercetools-import/src/Models/Orders/DiscountCodeInfoModel.php +++ b/lib/commercetools-import/src/Models/Orders/DiscountCodeInfoModel.php @@ -46,7 +46,7 @@ public function __construct( } /** - *

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.

* * * @return null|DiscountCodeKeyReference diff --git a/lib/commercetools-import/src/Models/Orders/DiscountedLineItemPortion.php b/lib/commercetools-import/src/Models/Orders/DiscountedLineItemPortion.php index 49a31b739b3..9c29ff8864f 100644 --- a/lib/commercetools-import/src/Models/Orders/DiscountedLineItemPortion.php +++ b/lib/commercetools-import/src/Models/Orders/DiscountedLineItemPortion.php @@ -19,7 +19,7 @@ interface DiscountedLineItemPortion extends JsonObject public const FIELD_DISCOUNTED_AMOUNT = '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.

* * @return null|CartDiscountKeyReference @@ -27,6 +27,8 @@ interface DiscountedLineItemPortion extends JsonObject public function getDiscount(); /** + *

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.

* * @return null|CartDiscountKeyReference @@ -48,6 +48,8 @@ public function getDiscount() } /** + *

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.

* * * @return null|CartDiscountKeyReference @@ -69,6 +69,8 @@ public function getDiscount() } /** + *

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.

+ *
    + *
  • If no subRates are specified, a value must be defined.
  • + *
  • If subRates are specified, this can be omitted or its value must be the sum of all subRates amounts.
  • + *
+ * * @return null|float */ public function getAmount(); /** + *

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.

+ * * @return null|SubRateCollection */ public function getSubRates(); /** + *
    + *
  • If set to false, the related price is considered the net price and the provided amount is applied to calculate the gross price.
  • + *
  • If set to true, the related price is considered the gross price, and the provided amount is applied to calculate the net price.
  • + *
+ * * @return null|bool */ diff --git a/lib/commercetools-import/src/Models/Orders/ExternalTaxRateDraftBuilder.php b/lib/commercetools-import/src/Models/Orders/ExternalTaxRateDraftBuilder.php index 8b10bb6dc1c..f6610484fe0 100644 --- a/lib/commercetools-import/src/Models/Orders/ExternalTaxRateDraftBuilder.php +++ b/lib/commercetools-import/src/Models/Orders/ExternalTaxRateDraftBuilder.php @@ -58,6 +58,8 @@ final class ExternalTaxRateDraftBuilder implements Builder private $includedInPrice; /** + *

Name of the Tax Rate.

+ * * @return null|string */ @@ -67,6 +69,12 @@ public function getName() } /** + *

Percentage in the range of 0-1.

+ *
    + *
  • If no subRates are specified, a value must be defined.
  • + *
  • If subRates are specified, this can be omitted or its value must be the sum of all subRates amounts.
  • + *
+ * * @return null|float */ @@ -76,6 +84,8 @@ public function getAmount() } /** + *

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.

+ * * @return null|SubRateCollection */ @@ -103,6 +118,11 @@ public function getSubRates() } /** + *
    + *
  • If set to false, the related price is considered the net price and the provided amount is applied to calculate the gross price.
  • + *
  • If set to true, the related price is considered the gross price, and the provided amount is applied to calculate the net price.
  • + *
+ * * @return null|bool */ diff --git a/lib/commercetools-import/src/Models/Orders/ExternalTaxRateDraftModel.php b/lib/commercetools-import/src/Models/Orders/ExternalTaxRateDraftModel.php index 8644d97e45f..3ef98b3d4bb 100644 --- a/lib/commercetools-import/src/Models/Orders/ExternalTaxRateDraftModel.php +++ b/lib/commercetools-import/src/Models/Orders/ExternalTaxRateDraftModel.php @@ -77,6 +77,8 @@ public function __construct( } /** + *

Name of the Tax Rate.

+ * * * @return null|string */ @@ -95,6 +97,12 @@ public function getName() } /** + *

Percentage in the range of 0-1.

+ *
    + *
  • If no subRates are specified, a value must be defined.
  • + *
  • If subRates are specified, this can be omitted or its value must be the sum of all subRates amounts.
  • + *
+ * * * @return null|float */ @@ -113,6 +121,8 @@ public function getAmount() } /** + *

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.

+ * * * @return null|SubRateCollection */ @@ -167,6 +182,11 @@ public function getSubRates() } /** + *
    + *
  • If set to false, the related price is considered the net price and the provided amount is applied to calculate the gross price.
  • + *
  • If set to true, the related price is considered the gross price, and the provided amount is applied to calculate the net price.
  • + *
+ * * * @return null|bool */ diff --git a/lib/commercetools-import/src/Models/Orders/ItemShippingDetailsDraft.php b/lib/commercetools-import/src/Models/Orders/ItemShippingDetailsDraft.php index d35a5dff485..21beebaf644 100644 --- a/lib/commercetools-import/src/Models/Orders/ItemShippingDetailsDraft.php +++ b/lib/commercetools-import/src/Models/Orders/ItemShippingDetailsDraft.php @@ -16,7 +16,7 @@ interface ItemShippingDetailsDraft extends JsonObject public const FIELD_TARGETS = '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/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.

* * @return null|string @@ -25,7 +25,7 @@ interface ItemShippingTarget extends JsonObject public function getAddressKey(); /** - *

Maps to ItemShippingTarget.quantity.

+ *

Quantity of Line Items or Custom Line Items shipped to the address with the specified addressKey.

* * @return null|int diff --git a/lib/commercetools-import/src/Models/Orders/ItemShippingTargetBuilder.php b/lib/commercetools-import/src/Models/Orders/ItemShippingTargetBuilder.php index 79b50d793d6..d7f196ee3a8 100644 --- a/lib/commercetools-import/src/Models/Orders/ItemShippingTargetBuilder.php +++ b/lib/commercetools-import/src/Models/Orders/ItemShippingTargetBuilder.php @@ -33,7 +33,7 @@ final class ItemShippingTargetBuilder implements Builder private $quantity; /** - *

Maps to ItemShippingTarget.addressKey.

+ *

Key of the address in the Cart itemShippingAddresses. Duplicate address keys are not allowed.

* * @return null|string @@ -44,7 +44,7 @@ public function getAddressKey() } /** - *

Maps to ItemShippingTarget.quantity.

+ *

Quantity of Line Items or Custom Line Items shipped to the address with the specified addressKey.

* * @return null|int diff --git a/lib/commercetools-import/src/Models/Orders/ItemShippingTargetModel.php b/lib/commercetools-import/src/Models/Orders/ItemShippingTargetModel.php index d52cb1349d0..fe8679fedab 100644 --- a/lib/commercetools-import/src/Models/Orders/ItemShippingTargetModel.php +++ b/lib/commercetools-import/src/Models/Orders/ItemShippingTargetModel.php @@ -44,7 +44,7 @@ public function __construct( } /** - *

Maps to ItemShippingTarget.addressKey.

+ *

Key of the address in the Cart itemShippingAddresses. Duplicate address keys are not allowed.

* * * @return null|string @@ -64,7 +64,7 @@ public function getAddressKey() } /** - *

Maps to ItemShippingTarget.quantity.

+ *

Quantity of Line Items or Custom Line Items shipped to the address with the specified addressKey.

* * * @return null|int diff --git a/lib/commercetools-import/src/Models/Orders/ItemState.php b/lib/commercetools-import/src/Models/Orders/ItemState.php index 7a74fba0445..d690db8a4f4 100644 --- a/lib/commercetools-import/src/Models/Orders/ItemState.php +++ b/lib/commercetools-import/src/Models/Orders/ItemState.php @@ -18,13 +18,15 @@ interface ItemState extends JsonObject public const FIELD_STATE = 'state'; /** + *

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.

* * @return null|StateKeyReference diff --git a/lib/commercetools-import/src/Models/Orders/ItemStateBuilder.php b/lib/commercetools-import/src/Models/Orders/ItemStateBuilder.php index 64cce9efa8f..c29c9fc94c6 100644 --- a/lib/commercetools-import/src/Models/Orders/ItemStateBuilder.php +++ b/lib/commercetools-import/src/Models/Orders/ItemStateBuilder.php @@ -35,6 +35,8 @@ final class ItemStateBuilder implements Builder private $state; /** + *

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.

* * @return null|StateKeyReference diff --git a/lib/commercetools-import/src/Models/Orders/ItemStateModel.php b/lib/commercetools-import/src/Models/Orders/ItemStateModel.php index a41aa021c50..0065e25a888 100644 --- a/lib/commercetools-import/src/Models/Orders/ItemStateModel.php +++ b/lib/commercetools-import/src/Models/Orders/ItemStateModel.php @@ -46,6 +46,8 @@ public function __construct( } /** + *

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.

* * * @return null|StateKeyReference diff --git a/lib/commercetools-import/src/Models/Orders/LineItemImportDraft.php b/lib/commercetools-import/src/Models/Orders/LineItemImportDraft.php index d39f6dc0a6b..65f09f132cc 100644 --- a/lib/commercetools-import/src/Models/Orders/LineItemImportDraft.php +++ b/lib/commercetools-import/src/Models/Orders/LineItemImportDraft.php @@ -31,7 +31,7 @@ interface LineItemImportDraft extends JsonObject public const FIELD_CUSTOM = '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.

* * @return null|ProductKeyReference @@ -71,15 +71,15 @@ public function getPrice(); public function getQuantity(); /** + *

Maps to LineItem.state.

+ * * @return null|ItemStateCollection */ public function getState(); /** - *

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.

* * @return null|ChannelKeyReference @@ -87,9 +87,7 @@ public function getState(); public function getSupplyChannel(); /** - *

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.

* * @return null|ChannelKeyReference @@ -105,7 +103,7 @@ public function getDistributionChannel(); public function getTaxRate(); /** - *

Maps to LineItem.shippingDetails.

+ *

Maps to LineItem.shippingDetails.

* * @return null|ItemShippingDetailsDraft @@ -113,7 +111,7 @@ public function getTaxRate(); public function getShippingDetails(); /** - *

Custom Fields for this Line Item.

+ *

Maps to LineItem.custom.

* * @return null|Custom diff --git a/lib/commercetools-import/src/Models/Orders/LineItemImportDraftBuilder.php b/lib/commercetools-import/src/Models/Orders/LineItemImportDraftBuilder.php index bb6d24ff354..aeb6ddbacff 100644 --- a/lib/commercetools-import/src/Models/Orders/LineItemImportDraftBuilder.php +++ b/lib/commercetools-import/src/Models/Orders/LineItemImportDraftBuilder.php @@ -97,7 +97,7 @@ final class LineItemImportDraftBuilder implements Builder private $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.

* * @return null|ProductKeyReference @@ -152,6 +152,8 @@ public function getQuantity() } /** + *

Maps to LineItem.state.

+ * * @return null|ItemStateCollection */ @@ -161,9 +163,7 @@ public function getState() } /** - *

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.

* * @return null|ChannelKeyReference @@ -174,9 +174,7 @@ public function getSupplyChannel() } /** - *

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.

* * @return null|ChannelKeyReference @@ -198,7 +196,7 @@ public function getTaxRate() } /** - *

Maps to LineItem.shippingDetails.

+ *

Maps to LineItem.shippingDetails.

* * @return null|ItemShippingDetailsDraft @@ -209,7 +207,7 @@ public function getShippingDetails() } /** - *

Custom Fields for this Line Item.

+ *

Maps to LineItem.custom.

* * @return null|Custom diff --git a/lib/commercetools-import/src/Models/Orders/LineItemImportDraftModel.php b/lib/commercetools-import/src/Models/Orders/LineItemImportDraftModel.php index ee73d292641..14caefa1c5f 100644 --- a/lib/commercetools-import/src/Models/Orders/LineItemImportDraftModel.php +++ b/lib/commercetools-import/src/Models/Orders/LineItemImportDraftModel.php @@ -126,7 +126,7 @@ public function __construct( } /** - *

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.

* * * @return null|ProductKeyReference @@ -230,6 +230,8 @@ public function getQuantity() } /** + *

Maps to LineItem.state.

+ * * * @return null|ItemStateCollection */ @@ -248,9 +250,7 @@ public function getState() } /** - *

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.

* * * @return null|ChannelKeyReference @@ -271,9 +271,7 @@ public function getSupplyChannel() } /** - *

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.

* * * @return null|ChannelKeyReference @@ -315,7 +313,7 @@ public function getTaxRate() } /** - *

Maps to LineItem.shippingDetails.

+ *

Maps to LineItem.shippingDetails.

* * * @return null|ItemShippingDetailsDraft @@ -336,7 +334,7 @@ public function getShippingDetails() } /** - *

Custom Fields for this Line Item.

+ *

Maps to LineItem.custom.

* * * @return null|Custom diff --git a/lib/commercetools-import/src/Models/Orders/LineItemPrice.php b/lib/commercetools-import/src/Models/Orders/LineItemPrice.php index 5c2d6fcd5ba..45e24044e0e 100644 --- a/lib/commercetools-import/src/Models/Orders/LineItemPrice.php +++ b/lib/commercetools-import/src/Models/Orders/LineItemPrice.php @@ -63,7 +63,7 @@ public function getValidFrom(); public function getValidUntil(); /** - *

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.

* * @return null|CustomerGroupKeyReference @@ -71,7 +71,7 @@ public function getValidUntil(); public function getCustomerGroup(); /** - *

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.

* * @return null|ChannelKeyReference @@ -87,7 +87,7 @@ public function getChannel(); public function getDiscounted(); /** - *

The tiered prices for this price.

+ *

Maps to Price.tiers.

* * @return null|PriceTierCollection diff --git a/lib/commercetools-import/src/Models/Orders/LineItemPriceBuilder.php b/lib/commercetools-import/src/Models/Orders/LineItemPriceBuilder.php index e9e1167d730..cd2a43bc006 100644 --- a/lib/commercetools-import/src/Models/Orders/LineItemPriceBuilder.php +++ b/lib/commercetools-import/src/Models/Orders/LineItemPriceBuilder.php @@ -131,7 +131,7 @@ public function getValidUntil() } /** - *

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.

* * @return null|CustomerGroupKeyReference @@ -142,7 +142,7 @@ public function getCustomerGroup() } /** - *

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.

* * @return null|ChannelKeyReference @@ -164,7 +164,7 @@ public function getDiscounted() } /** - *

The tiered prices for this price.

+ *

Maps to Price.tiers.

* * @return null|PriceTierCollection diff --git a/lib/commercetools-import/src/Models/Orders/LineItemPriceModel.php b/lib/commercetools-import/src/Models/Orders/LineItemPriceModel.php index a74f0ed171d..ca76b9f26d9 100644 --- a/lib/commercetools-import/src/Models/Orders/LineItemPriceModel.php +++ b/lib/commercetools-import/src/Models/Orders/LineItemPriceModel.php @@ -201,7 +201,7 @@ public function getValidUntil() } /** - *

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.

* * * @return null|CustomerGroupKeyReference @@ -222,7 +222,7 @@ public function getCustomerGroup() } /** - *

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.

* * * @return null|ChannelKeyReference @@ -264,7 +264,7 @@ public function getDiscounted() } /** - *

The tiered prices for this price.

+ *

Maps to Price.tiers.

* * * @return null|PriceTierCollection diff --git a/lib/commercetools-import/src/Models/Orders/LineItemProductVariantImportDraft.php b/lib/commercetools-import/src/Models/Orders/LineItemProductVariantImportDraft.php index 61c54292498..67ba84d956c 100644 --- a/lib/commercetools-import/src/Models/Orders/LineItemProductVariantImportDraft.php +++ b/lib/commercetools-import/src/Models/Orders/LineItemProductVariantImportDraft.php @@ -23,7 +23,7 @@ interface LineItemProductVariantImportDraft extends JsonObject public const FIELD_IMAGES = 'images'; /** - *

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.

* * @return null|ProductVariantKeyReference diff --git a/lib/commercetools-import/src/Models/Orders/LineItemProductVariantImportDraftBuilder.php b/lib/commercetools-import/src/Models/Orders/LineItemProductVariantImportDraftBuilder.php index 53ebd21f75a..e357d6ffb68 100644 --- a/lib/commercetools-import/src/Models/Orders/LineItemProductVariantImportDraftBuilder.php +++ b/lib/commercetools-import/src/Models/Orders/LineItemProductVariantImportDraftBuilder.php @@ -55,7 +55,7 @@ final class LineItemProductVariantImportDraftBuilder implements Builder private $images; /** - *

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.

* * @return null|ProductVariantKeyReference diff --git a/lib/commercetools-import/src/Models/Orders/LineItemProductVariantImportDraftModel.php b/lib/commercetools-import/src/Models/Orders/LineItemProductVariantImportDraftModel.php index f7d9b76faac..1012177b9a2 100644 --- a/lib/commercetools-import/src/Models/Orders/LineItemProductVariantImportDraftModel.php +++ b/lib/commercetools-import/src/Models/Orders/LineItemProductVariantImportDraftModel.php @@ -72,7 +72,7 @@ public function __construct( } /** - *

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.

* * * @return null|ProductVariantKeyReference diff --git a/lib/commercetools-import/src/Models/Orders/OrderImport.php b/lib/commercetools-import/src/Models/Orders/OrderImport.php index 05b74a6c188..273ca4ce335 100644 --- a/lib/commercetools-import/src/Models/Orders/OrderImport.php +++ b/lib/commercetools-import/src/Models/Orders/OrderImport.php @@ -56,6 +56,8 @@ interface OrderImport extends JsonObject public function getOrderNumber(); /** + *

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.

+ * * @return null|CustomerKeyReference */ @@ -118,7 +120,7 @@ public function getShippingAddress(); public function getBillingAddress(); /** - *

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.

* * @return null|CustomerGroupKeyReference @@ -222,7 +224,7 @@ public function getOrigin(); public function getItemShippingAddresses(); /** - *

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.

* * @return null|StoreKeyReference @@ -230,7 +232,7 @@ public function getItemShippingAddresses(); public function getStore(); /** - *

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.

* * @return null|StateKeyReference diff --git a/lib/commercetools-import/src/Models/Orders/OrderImportBuilder.php b/lib/commercetools-import/src/Models/Orders/OrderImportBuilder.php index 5966b9a9084..22f49bd7b00 100644 --- a/lib/commercetools-import/src/Models/Orders/OrderImportBuilder.php +++ b/lib/commercetools-import/src/Models/Orders/OrderImportBuilder.php @@ -192,6 +192,8 @@ public function getOrderNumber() } /** + *

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.

+ * * @return null|CustomerKeyReference */ @@ -278,7 +280,7 @@ public function getBillingAddress() } /** - *

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.

* * @return null|CustomerGroupKeyReference @@ -421,7 +423,7 @@ public function getItemShippingAddresses() } /** - *

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.

* * @return null|StoreKeyReference @@ -432,7 +434,7 @@ public function getStore() } /** - *

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.

* * @return null|StateKeyReference diff --git a/lib/commercetools-import/src/Models/Orders/OrderImportModel.php b/lib/commercetools-import/src/Models/Orders/OrderImportModel.php index 3a87f5d1bc6..47364b423c8 100644 --- a/lib/commercetools-import/src/Models/Orders/OrderImportModel.php +++ b/lib/commercetools-import/src/Models/Orders/OrderImportModel.php @@ -256,6 +256,8 @@ public function getOrderNumber() } /** + *

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.

+ * * * @return null|CustomerKeyReference */ @@ -419,7 +421,7 @@ public function getBillingAddress() } /** - *

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.

* * * @return null|CustomerGroupKeyReference @@ -686,7 +688,7 @@ public function getItemShippingAddresses() } /** - *

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.

* * * @return null|StoreKeyReference @@ -707,7 +709,7 @@ public function getStore() } /** - *

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.

* * * @return null|StateKeyReference diff --git a/lib/commercetools-import/src/Models/Orders/Parcel.php b/lib/commercetools-import/src/Models/Orders/Parcel.php index 0db1945d823..bfec4a3cb13 100644 --- a/lib/commercetools-import/src/Models/Orders/Parcel.php +++ b/lib/commercetools-import/src/Models/Orders/Parcel.php @@ -23,37 +23,47 @@ interface Parcel extends JsonObject public const FIELD_CUSTOM = 'custom'; /** + *

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.

+ * * @return null|string */ public function getShippingMethodName(); /** + *

Maps to shippingInfo.price.

+ * * @return null|TypedMoney */ public function getPrice(); /** + *

Used to determine the price.

+ * * @return null|ShippingRateDraft */ public function getShippingRate(); /** + *

Maps to shippingInfo.taxRate.

+ * * @return null|TaxRate */ public function getTaxRate(); /** - *

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.

* * @return null|TaxCategoryKeyReference @@ -60,7 +68,7 @@ public function getTaxRate(); public function getTaxCategory(); /** - *

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.

* * @return null|ShippingMethodKeyReference @@ -68,7 +76,7 @@ public function getTaxCategory(); public function getShippingMethod(); /** - *

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.

* * @return null|DeliveryCollection @@ -76,12 +84,16 @@ public function getShippingMethod(); public function getDeliveries(); /** + *

Maps to shippingInfo.discountedPrice.

+ * * @return null|DiscountedLineItemPriceDraft */ public function getDiscountedPrice(); /** + *

Maps to shippingInfo.shippingMethodState.

+ * * @return null|string */ diff --git a/lib/commercetools-import/src/Models/Orders/ShippingInfoImportDraftBuilder.php b/lib/commercetools-import/src/Models/Orders/ShippingInfoImportDraftBuilder.php index fb1bfeb4d56..d793cc4bcfc 100644 --- a/lib/commercetools-import/src/Models/Orders/ShippingInfoImportDraftBuilder.php +++ b/lib/commercetools-import/src/Models/Orders/ShippingInfoImportDraftBuilder.php @@ -83,6 +83,8 @@ final class ShippingInfoImportDraftBuilder implements Builder private $shippingMethodState; /** + *

Maps to shippingInfo.shippingMethodName.

+ * * @return null|string */ @@ -92,6 +94,8 @@ public function getShippingMethodName() } /** + *

Maps to shippingInfo.price.

+ * * @return null|TypedMoney */ @@ -101,6 +105,8 @@ public function getPrice() } /** + *

Used to determine the price.

+ * * @return null|ShippingRateDraft */ @@ -110,6 +116,8 @@ public function getShippingRate() } /** + *

Maps to shippingInfo.taxRate.

+ * * @return null|TaxRate */ @@ -119,7 +127,7 @@ public function getTaxRate() } /** - *

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.

* * @return null|TaxCategoryKeyReference @@ -130,7 +138,7 @@ public function getTaxCategory() } /** - *

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.

* * @return null|ShippingMethodKeyReference @@ -141,7 +149,7 @@ public function getShippingMethod() } /** - *

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.

* * @return null|DeliveryCollection @@ -152,6 +160,8 @@ public function getDeliveries() } /** + *

Maps to shippingInfo.discountedPrice.

+ * * @return null|DiscountedLineItemPriceDraft */ @@ -161,6 +171,8 @@ public function getDiscountedPrice() } /** + *

Maps to shippingInfo.shippingMethodState.

+ * * @return null|string */ diff --git a/lib/commercetools-import/src/Models/Orders/ShippingInfoImportDraftModel.php b/lib/commercetools-import/src/Models/Orders/ShippingInfoImportDraftModel.php index 379b55b7463..05939b817c6 100644 --- a/lib/commercetools-import/src/Models/Orders/ShippingInfoImportDraftModel.php +++ b/lib/commercetools-import/src/Models/Orders/ShippingInfoImportDraftModel.php @@ -108,6 +108,8 @@ public function __construct( } /** + *

Maps to shippingInfo.shippingMethodName.

+ * * * @return null|string */ @@ -126,6 +128,8 @@ public function getShippingMethodName() } /** + *

Maps to shippingInfo.price.

+ * * * @return null|TypedMoney */ @@ -145,6 +149,8 @@ public function getPrice() } /** + *

Used to determine the price.

+ * * * @return null|ShippingRateDraft */ @@ -164,6 +170,8 @@ public function getShippingRate() } /** + *

Maps to shippingInfo.taxRate.

+ * * * @return null|TaxRate */ @@ -183,7 +191,7 @@ public function getTaxRate() } /** - *

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.

* * * @return null|TaxCategoryKeyReference @@ -204,7 +212,7 @@ public function getTaxCategory() } /** - *

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.

* * * @return null|ShippingMethodKeyReference @@ -225,7 +233,7 @@ public function getShippingMethod() } /** - *

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.

* * * @return null|DeliveryCollection @@ -245,6 +253,8 @@ public function getDeliveries() } /** + *

Maps to shippingInfo.discountedPrice.

+ * * * @return null|DiscountedLineItemPriceDraft */ @@ -264,6 +274,8 @@ public function getDiscountedPrice() } /** + *

Maps to shippingInfo.shippingMethodState.

+ * * * @return null|string */ diff --git a/lib/commercetools-import/src/Models/Orders/ShippingRateDraft.php b/lib/commercetools-import/src/Models/Orders/ShippingRateDraft.php index 7acf4356d20..6dd54a56c5d 100644 --- a/lib/commercetools-import/src/Models/Orders/ShippingRateDraft.php +++ b/lib/commercetools-import/src/Models/Orders/ShippingRateDraft.php @@ -19,18 +19,24 @@ interface ShippingRateDraft extends JsonObject public const FIELD_TIERS = 'tiers'; /** + *

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.

* * @return null|ChannelKeyReference diff --git a/lib/commercetools-import/src/Models/Orders/SyncInfoBuilder.php b/lib/commercetools-import/src/Models/Orders/SyncInfoBuilder.php index 25c0ff872d6..a0818975b91 100644 --- a/lib/commercetools-import/src/Models/Orders/SyncInfoBuilder.php +++ b/lib/commercetools-import/src/Models/Orders/SyncInfoBuilder.php @@ -42,7 +42,7 @@ final class SyncInfoBuilder implements Builder private $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.

* * @return null|ChannelKeyReference diff --git a/lib/commercetools-import/src/Models/Orders/SyncInfoModel.php b/lib/commercetools-import/src/Models/Orders/SyncInfoModel.php index 18151bf5fc4..06b85fefe5c 100644 --- a/lib/commercetools-import/src/Models/Orders/SyncInfoModel.php +++ b/lib/commercetools-import/src/Models/Orders/SyncInfoModel.php @@ -55,7 +55,7 @@ public function __construct( } /** - *

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.

* * * @return null|ChannelKeyReference diff --git a/lib/commercetools-import/src/Models/Orders/TaxPortion.php b/lib/commercetools-import/src/Models/Orders/TaxPortion.php index 32ae74930d6..aff9cdd60d1 100644 --- a/lib/commercetools-import/src/Models/Orders/TaxPortion.php +++ b/lib/commercetools-import/src/Models/Orders/TaxPortion.php @@ -19,18 +19,24 @@ interface TaxPortion extends JsonObject public const FIELD_AMOUNT = 'amount'; /** + *

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.

+ * * @return null|string */ public function getProviderTransaction(); /** + *
    + *
  • If true, the Parcel is being returned.
  • + *
  • If false, the Parcel is being delivered to the customer.
  • + *
+ * * @return null|bool */ diff --git a/lib/commercetools-import/src/Models/Orders/TrackingDataBuilder.php b/lib/commercetools-import/src/Models/Orders/TrackingDataBuilder.php index 89d5fef218b..83efbb0087a 100644 --- a/lib/commercetools-import/src/Models/Orders/TrackingDataBuilder.php +++ b/lib/commercetools-import/src/Models/Orders/TrackingDataBuilder.php @@ -51,6 +51,8 @@ final class TrackingDataBuilder implements Builder private $isReturn; /** + *

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.

+ * * @return null|string */ @@ -87,6 +95,11 @@ public function getProviderTransaction() } /** + *
    + *
  • If true, the Parcel is being returned.
  • + *
  • If false, the Parcel is being delivered to the customer.
  • + *
+ * * @return null|bool */ diff --git a/lib/commercetools-import/src/Models/Orders/TrackingDataModel.php b/lib/commercetools-import/src/Models/Orders/TrackingDataModel.php index a13dd4a7c90..d0522e9116b 100644 --- a/lib/commercetools-import/src/Models/Orders/TrackingDataModel.php +++ b/lib/commercetools-import/src/Models/Orders/TrackingDataModel.php @@ -68,6 +68,8 @@ public function __construct( } /** + *

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.

+ * * * @return null|string */ @@ -140,6 +148,11 @@ public function getProviderTransaction() } /** + *
    + *
  • If true, the Parcel is being returned.
  • + *
  • If false, the Parcel is being delivered to the customer.
  • + *
+ * * * @return null|bool */ diff --git a/lib/commercetools-import/src/Models/Prices/PriceImport.php b/lib/commercetools-import/src/Models/Prices/PriceImport.php index 291ff1577b5..264f985a5c1 100644 --- a/lib/commercetools-import/src/Models/Prices/PriceImport.php +++ b/lib/commercetools-import/src/Models/Prices/PriceImport.php @@ -37,7 +37,7 @@ interface PriceImport extends ImportResource public const FIELD_PRODUCT = 'product'; /** - *

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.

* * @return null|string @@ -77,8 +77,7 @@ public function getValidFrom(); public function getValidUntil(); /** - *

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.

* * @return null|CustomerGroupKeyReference @@ -86,8 +85,7 @@ public function getValidUntil(); public function getCustomerGroup(); /** - *

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.

* * @return null|ChannelKeyReference @@ -104,7 +102,7 @@ public function getDiscounted(); /** * * @@ -122,7 +120,7 @@ public function getStaged(); public function getTiers(); /** - *

The custom fields for this price.

+ *

Maps to Price.custom.

* * @return null|Custom @@ -130,9 +128,7 @@ public function getTiers(); public function getCustom(); /** - *

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.

* * @return null|ProductVariantKeyReference @@ -140,9 +136,7 @@ public function getCustom(); public function getProductVariant(); /** - *

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.

* * @return null|ProductKeyReference diff --git a/lib/commercetools-import/src/Models/Prices/PriceImportBuilder.php b/lib/commercetools-import/src/Models/Prices/PriceImportBuilder.php index 0d95bfe6306..b04b3e7d062 100644 --- a/lib/commercetools-import/src/Models/Prices/PriceImportBuilder.php +++ b/lib/commercetools-import/src/Models/Prices/PriceImportBuilder.php @@ -117,7 +117,7 @@ final class PriceImportBuilder implements Builder private $product; /** - *

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.

* * @return null|string @@ -172,8 +172,7 @@ public function getValidUntil() } /** - *

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.

* * @return null|CustomerGroupKeyReference @@ -184,8 +183,7 @@ public function getCustomerGroup() } /** - *

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.

* * @return null|ChannelKeyReference @@ -208,7 +206,7 @@ public function getDiscounted() /** * * @@ -232,7 +230,7 @@ public function getTiers() } /** - *

The custom fields for this price.

+ *

Maps to Price.custom.

* * @return null|Custom @@ -243,9 +241,7 @@ public function getCustom() } /** - *

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.

* * @return null|ProductVariantKeyReference @@ -256,9 +252,7 @@ public function getProductVariant() } /** - *

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.

* * @return null|ProductKeyReference diff --git a/lib/commercetools-import/src/Models/Prices/PriceImportModel.php b/lib/commercetools-import/src/Models/Prices/PriceImportModel.php index 3d5ce655eb8..dc544b21cb3 100644 --- a/lib/commercetools-import/src/Models/Prices/PriceImportModel.php +++ b/lib/commercetools-import/src/Models/Prices/PriceImportModel.php @@ -150,7 +150,7 @@ public function __construct( } /** - *

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.

* * * @return null|string @@ -259,8 +259,7 @@ public function getValidUntil() } /** - *

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.

* * * @return null|CustomerGroupKeyReference @@ -281,8 +280,7 @@ public function getCustomerGroup() } /** - *

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.

* * * @return null|ChannelKeyReference @@ -325,7 +323,7 @@ public function getDiscounted() /** * * @@ -367,7 +365,7 @@ public function getTiers() } /** - *

The custom fields for this price.

+ *

Maps to Price.custom.

* * * @return null|Custom @@ -388,9 +386,7 @@ public function getCustom() } /** - *

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.

* * * @return null|ProductVariantKeyReference @@ -411,9 +407,7 @@ public function getProductVariant() } /** - *

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.

* * * @return null|ProductKeyReference diff --git a/lib/commercetools-import/src/Models/Prices/SubRate.php b/lib/commercetools-import/src/Models/Prices/SubRate.php index 101888af556..8c71574fc9b 100644 --- a/lib/commercetools-import/src/Models/Prices/SubRate.php +++ b/lib/commercetools-import/src/Models/Prices/SubRate.php @@ -17,6 +17,8 @@ interface SubRate extends JsonObject public const FIELD_AMOUNT = 'amount'; /** + *

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|array|null $data */ + $data = $this->raw(self::FIELD_PRODUCT); + if (is_null($data)) { + return null; + } + + $this->product = ProductKeyReferenceModel::of($data); + } + + return $this->product; + } + + /** + *

Variant selection specifying included SKUs.

+ * + * + * @return null|VariantSelection + */ + public function getVariantSelection() + { + if (is_null($this->variantSelection)) { + /** @psalm-var stdClass|array|null $data */ + $data = $this->raw(self::FIELD_VARIANT_SELECTION); + if (is_null($data)) { + return null; + } + + $this->variantSelection = VariantSelectionModel::of($data); + } + + return $this->variantSelection; + } + + /** + *

Variant exclusion specifying excluded SKUs.

+ * + * + * @return null|VariantExclusion + */ + public function getVariantExclusion() + { + if (is_null($this->variantExclusion)) { + /** @psalm-var stdClass|array|null $data */ + $data = $this->raw(self::FIELD_VARIANT_EXCLUSION); + if (is_null($data)) { + return null; + } + + $this->variantExclusion = VariantExclusionModel::of($data); + } + + return $this->variantExclusion; + } + + + /** + * @param ?ProductKeyReference $product + */ + public function setProduct(?ProductKeyReference $product): void + { + $this->product = $product; + } + + /** + * @param ?VariantSelection $variantSelection + */ + public function setVariantSelection(?VariantSelection $variantSelection): void + { + $this->variantSelection = $variantSelection; + } + + /** + * @param ?VariantExclusion $variantExclusion + */ + public function setVariantExclusion(?VariantExclusion $variantExclusion): void + { + $this->variantExclusion = $variantExclusion; + } +} diff --git a/lib/commercetools-import/src/Models/ProductSelections/ProductSelectionImport.php b/lib/commercetools-import/src/Models/ProductSelections/ProductSelectionImport.php new file mode 100644 index 00000000000..324c14ad532 --- /dev/null +++ b/lib/commercetools-import/src/Models/ProductSelections/ProductSelectionImport.php @@ -0,0 +1,88 @@ +User-defined unique identifier. If an ProductSelection with this key exists, it is updated with the imported data.

+ * + + * @return null|string + */ + public function getKey(); + + /** + *

Maps to ProductSelection.name.

+ * + + * @return null|LocalizedString + */ + public function getName(); + + /** + *

Maps to ProductSelection.mode.

+ * + + * @return null|string + */ + public function getMode(); + + /** + *

Maps to ProductSelection.custom.

+ * + + * @return null|Custom + */ + public function getCustom(); + + /** + *

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.

+ * + + * @return null|string + */ + public function getKey() + { + return $this->key; + } + + /** + *

Maps to ProductSelection.name.

+ * + + * @return null|LocalizedString + */ + public function getName() + { + return $this->name instanceof LocalizedStringBuilder ? $this->name->build() : $this->name; + } + + /** + *

Maps to ProductSelection.mode.

+ * + + * @return null|string + */ + public function getMode() + { + return $this->mode; + } + + /** + *

Maps to ProductSelection.custom.

+ * + + * @return null|Custom + */ + public function getCustom() + { + return $this->custom instanceof CustomBuilder ? $this->custom->build() : $this->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.

+ * + * + * @return null|string + */ + public function getKey() + { + if (is_null($this->key)) { + /** @psalm-var ?string $data */ + $data = $this->raw(self::FIELD_KEY); + if (is_null($data)) { + return null; + } + $this->key = (string) $data; + } + + return $this->key; + } + + /** + *

Maps to ProductSelection.name.

+ * + * + * @return null|LocalizedString + */ + public function getName() + { + if (is_null($this->name)) { + /** @psalm-var stdClass|array|null $data */ + $data = $this->raw(self::FIELD_NAME); + if (is_null($data)) { + return null; + } + + $this->name = LocalizedStringModel::of($data); + } + + return $this->name; + } + + /** + *

Maps to ProductSelection.mode.

+ * + * + * @return null|string + */ + public function getMode() + { + if (is_null($this->mode)) { + /** @psalm-var ?string $data */ + $data = $this->raw(self::FIELD_MODE); + if (is_null($data)) { + return null; + } + $this->mode = (string) $data; + } + + return $this->mode; + } + + /** + *

Maps to ProductSelection.custom.

+ * + * + * @return null|Custom + */ + public function getCustom() + { + if (is_null($this->custom)) { + /** @psalm-var stdClass|array|null $data */ + $data = $this->raw(self::FIELD_CUSTOM); + if (is_null($data)) { + return null; + } + + $this->custom = CustomModel::of($data); + } + + return $this->custom; + } + + /** + *

List of product assignments.

+ * + * + * @return null|ProductSelectionAssignmentCollection + */ + public function getAssignments() + { + if (is_null($this->assignments)) { + /** @psalm-var ?list $data */ + $data = $this->raw(self::FIELD_ASSIGNMENTS); + if (is_null($data)) { + return null; + } + $this->assignments = ProductSelectionAssignmentCollection::fromArray($data); + } + + return $this->assignments; + } + + + /** + * @param ?string $key + */ + public function setKey(?string $key): void + { + $this->key = $key; + } + + /** + * @param ?LocalizedString $name + */ + public function setName(?LocalizedString $name): void + { + $this->name = $name; + } + + /** + * @param ?string $mode + */ + public function setMode(?string $mode): void + { + $this->mode = $mode; + } + + /** + * @param ?Custom $custom + */ + public function setCustom(?Custom $custom): void + { + $this->custom = $custom; + } + + /** + * @param ?ProductSelectionAssignmentCollection $assignments + */ + public function setAssignments(?ProductSelectionAssignmentCollection $assignments): void + { + $this->assignments = $assignments; + } +} diff --git a/lib/commercetools-import/src/Models/ProductSelections/VariantExclusion.php b/lib/commercetools-import/src/Models/ProductSelections/VariantExclusion.php new file mode 100644 index 00000000000..3b1fd299d1a --- /dev/null +++ b/lib/commercetools-import/src/Models/ProductSelections/VariantExclusion.php @@ -0,0 +1,30 @@ +List of SKUs to be excluded.

+ * + + * @return null|array + */ + public function getSkus(); + + /** + * @param ?array $skus + */ + public function setSkus(?array $skus): void; +} diff --git a/lib/commercetools-import/src/Models/ProductSelections/VariantExclusionBuilder.php b/lib/commercetools-import/src/Models/ProductSelections/VariantExclusionBuilder.php new file mode 100644 index 00000000000..1ea936e5e56 --- /dev/null +++ b/lib/commercetools-import/src/Models/ProductSelections/VariantExclusionBuilder.php @@ -0,0 +1,63 @@ + + */ +final class VariantExclusionBuilder implements Builder +{ + /** + + * @var ?array + */ + private $skus; + + /** + *

List 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 ?list $data */ + $data = $this->raw(self::FIELD_SKUS); + if (is_null($data)) { + return null; + } + $this->skus = $data; + } + + return $this->skus; + } + + + /** + * @param ?array $skus + */ + public function setSkus(?array $skus): void + { + $this->skus = $skus; + } +} diff --git a/lib/commercetools-import/src/Models/ProductSelections/VariantSelection.php b/lib/commercetools-import/src/Models/ProductSelections/VariantSelection.php new file mode 100644 index 00000000000..a8eac8285be --- /dev/null +++ b/lib/commercetools-import/src/Models/ProductSelections/VariantSelection.php @@ -0,0 +1,44 @@ +Type of variant selection.

+ * + + * @return null|string + */ + public function getType(); + + /** + *

List 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 ?list $data */ + $data = $this->raw(self::FIELD_SKUS); + if (is_null($data)) { + return null; + } + $this->skus = $data; + } + + return $this->skus; + } + + + /** + * @param ?string $type + */ + public function setType(?string $type): void + { + $this->type = $type; + } + + /** + * @param ?array $skus + */ + public function setSkus(?array $skus): void + { + $this->skus = $skus; + } +} diff --git a/lib/commercetools-import/src/Models/Productdrafts/PriceDraftImport.php b/lib/commercetools-import/src/Models/Productdrafts/PriceDraftImport.php index 7ddc78e81b6..2234e8fd23b 100644 --- a/lib/commercetools-import/src/Models/Productdrafts/PriceDraftImport.php +++ b/lib/commercetools-import/src/Models/Productdrafts/PriceDraftImport.php @@ -32,13 +32,15 @@ interface PriceDraftImport extends JsonObject public const FIELD_KEY = 'key'; /** + *

Money 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.

* * @return null|CustomerGroupKeyReference @@ -54,7 +56,7 @@ public function getCountry(); public function getCustomerGroup(); /** - *

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.

* * @return null|ChannelKeyReference @@ -62,19 +64,23 @@ public function getCustomerGroup(); public function getChannel(); /** + *

Set this field if this Price is only valid from the specified date and time. Must be at least 1 ms earlier than validUntil.

+ * * @return null|DateTimeImmutable */ public function getValidFrom(); /** + *

Set this field if this Price is only valid until the specified date and time. Must be at least 1 ms later than validFrom.

+ * * @return null|DateTimeImmutable */ public function getValidUntil(); /** - *

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.

* * @return null|CustomerGroupKeyReference @@ -124,7 +126,7 @@ public function getCustomerGroup() } /** - *

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.

* * @return null|ChannelKeyReference @@ -135,6 +137,8 @@ public function getChannel() } /** + *

Set this field if this Price is only valid from the specified date and time. Must be at least 1 ms earlier than validUntil.

+ * * @return null|DateTimeImmutable */ @@ -144,6 +148,8 @@ public function getValidFrom() } /** + *

Set this field if this Price is only valid until the specified date and time. Must be at least 1 ms later than validFrom.

+ * * @return null|DateTimeImmutable */ @@ -153,7 +159,7 @@ public function getValidUntil() } /** - *

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.

* * * @return null|CustomerGroupKeyReference @@ -180,7 +182,7 @@ public function getCustomerGroup() } /** - *

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.

* * * @return null|ChannelKeyReference @@ -201,6 +203,8 @@ public function getChannel() } /** + *

Set this field if this Price is only valid from the specified date and time. Must be at least 1 ms earlier than validUntil.

+ * * * @return null|DateTimeImmutable */ @@ -223,6 +227,8 @@ public function getValidFrom() } /** + *

Set this field if this Price is only valid until the specified date and time. Must be at least 1 ms later than validFrom.

+ * * * @return null|DateTimeImmutable */ @@ -245,7 +251,7 @@ public function getValidUntil() } /** - *

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.

* * @return null|string @@ -47,10 +47,7 @@ interface ProductDraftImport extends ImportResource public function getKey(); /** - *

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.

* * @return null|ProductTypeKeyReference @@ -58,14 +55,15 @@ public function getKey(); public function getProductType(); /** + *

Maps to ProductData.name.

+ * * @return null|LocalizedString */ public function getName(); /** - *

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.

* * @return null|LocalizedString @@ -73,7 +71,7 @@ public function getName(); public function getSlug(); /** - *

Maps to Product.description.

+ *

Maps to ProductData.description.

* * @return null|LocalizedString @@ -81,8 +79,7 @@ public function getSlug(); public function getDescription(); /** - *

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.

* * @return null|CategoryKeyReferenceCollection @@ -96,12 +93,7 @@ public function getCategories(); public function getAttributes(); /** - *

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.

* * @return null|LocalizedString @@ -109,12 +101,7 @@ public function getAttributes(); public function getMetaTitle(); /** - *

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.

* * @return null|LocalizedString @@ -122,12 +109,7 @@ public function getMetaTitle(); public function getMetaDescription(); /** - *

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.

* * @return null|LocalizedString @@ -135,8 +117,8 @@ public function getMetaDescription(); public function getMetaKeywords(); /** - *

The master Product variant. - * Required if the variants array contains a Product Variant.

+ *

The master ProductVariant. + * Required if variants contains at least one ProductVariant.

* * @return null|ProductVariantDraftImport @@ -144,7 +126,7 @@ public function getMetaKeywords(); public function getMasterVariant(); /** - *

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.

* * @return null|TaxCategoryKeyReference @@ -161,23 +142,7 @@ public function getVariants(); public function getTaxCategory(); /** - *

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.

* * @return null|SearchKeywords @@ -185,8 +150,7 @@ public function getTaxCategory(); public function getSearchKeywords(); /** - *

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.

* * @return null|StateKeyReference @@ -202,7 +166,7 @@ public function getState(); public function getPublish(); /** - *

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.

* * @return null|string diff --git a/lib/commercetools-import/src/Models/Productdrafts/ProductDraftImportBuilder.php b/lib/commercetools-import/src/Models/Productdrafts/ProductDraftImportBuilder.php index 5cdf0ccbdb7..6c52ac07299 100644 --- a/lib/commercetools-import/src/Models/Productdrafts/ProductDraftImportBuilder.php +++ b/lib/commercetools-import/src/Models/Productdrafts/ProductDraftImportBuilder.php @@ -137,7 +137,7 @@ final class ProductDraftImportBuilder implements Builder private $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.

* * @return null|string @@ -148,10 +148,7 @@ public function getKey() } /** - *

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.

* * @return null|ProductTypeKeyReference @@ -162,6 +159,8 @@ public function getProductType() } /** + *

Maps to ProductData.name.

+ * * @return null|LocalizedString */ @@ -171,8 +170,7 @@ public function getName() } /** - *

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.

* * @return null|LocalizedString @@ -183,7 +181,7 @@ public function getSlug() } /** - *

Maps to Product.description.

+ *

Maps to ProductData.description.

* * @return null|LocalizedString @@ -194,8 +192,7 @@ public function getDescription() } /** - *

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.

* * @return null|CategoryKeyReferenceCollection @@ -215,12 +212,7 @@ public function getAttributes() } /** - *

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.

* * @return null|LocalizedString @@ -231,12 +223,7 @@ public function getMetaTitle() } /** - *

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.

* * @return null|LocalizedString @@ -247,12 +234,7 @@ public function getMetaDescription() } /** - *

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.

* * @return null|LocalizedString @@ -263,8 +245,8 @@ public function getMetaKeywords() } /** - *

The master Product variant. - * Required if the variants array contains a Product Variant.

+ *

The master ProductVariant. + * Required if variants contains at least one ProductVariant.

* * @return null|ProductVariantDraftImport @@ -275,7 +257,7 @@ public function getMasterVariant() } /** - *

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.

* * @return null|TaxCategoryKeyReference @@ -298,23 +279,7 @@ public function getTaxCategory() } /** - *

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.

* * @return null|SearchKeywords @@ -325,8 +290,7 @@ public function getSearchKeywords() } /** - *

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.

* * @return null|StateKeyReference @@ -348,7 +312,7 @@ public function getPublish() } /** - *

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.

* * @return null|string diff --git a/lib/commercetools-import/src/Models/Productdrafts/ProductDraftImportModel.php b/lib/commercetools-import/src/Models/Productdrafts/ProductDraftImportModel.php index a50e11509f5..de8ae4e67d2 100644 --- a/lib/commercetools-import/src/Models/Productdrafts/ProductDraftImportModel.php +++ b/lib/commercetools-import/src/Models/Productdrafts/ProductDraftImportModel.php @@ -178,7 +178,7 @@ public function __construct( } /** - *

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.

* * * @return null|string @@ -198,10 +198,7 @@ public function getKey() } /** - *

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.

* * * @return null|ProductTypeKeyReference @@ -222,6 +219,8 @@ public function getProductType() } /** + *

Maps to ProductData.name.

+ * * * @return null|LocalizedString */ @@ -241,8 +240,7 @@ public function getName() } /** - *

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.

* * * @return null|LocalizedString @@ -263,7 +261,7 @@ public function getSlug() } /** - *

Maps to Product.description.

+ *

Maps to ProductData.description.

* * * @return null|LocalizedString @@ -284,8 +282,7 @@ public function getDescription() } /** - *

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.

* * * @return null|CategoryKeyReferenceCollection @@ -323,12 +320,7 @@ public function getAttributes() } /** - *

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.

* * * @return null|LocalizedString @@ -349,12 +341,7 @@ public function getMetaTitle() } /** - *

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.

* * * @return null|LocalizedString @@ -375,12 +362,7 @@ public function getMetaDescription() } /** - *

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.

* * * @return null|LocalizedString @@ -401,8 +383,8 @@ public function getMetaKeywords() } /** - *

The master Product variant. - * Required if the variants array contains a Product Variant.

+ *

The master ProductVariant. + * Required if variants contains at least one ProductVariant.

* * * @return null|ProductVariantDraftImport @@ -423,7 +405,7 @@ public function getMasterVariant() } /** - *

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.

* * * @return null|TaxCategoryKeyReference @@ -465,23 +446,7 @@ public function getTaxCategory() } /** - *

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.

* * * @return null|SearchKeywords @@ -502,8 +467,7 @@ public function getSearchKeywords() } /** - *

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.

* * * @return null|StateKeyReference @@ -544,7 +508,7 @@ public function getPublish() } /** - *

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.

* * * @return null|string diff --git a/lib/commercetools-import/src/Models/Productdrafts/ProductVariantDraftImport.php b/lib/commercetools-import/src/Models/Productdrafts/ProductVariantDraftImport.php index 6f473db4518..a4b91baa47b 100644 --- a/lib/commercetools-import/src/Models/Productdrafts/ProductVariantDraftImport.php +++ b/lib/commercetools-import/src/Models/Productdrafts/ProductVariantDraftImport.php @@ -24,36 +24,49 @@ interface ProductVariantDraftImport extends JsonObject public const FIELD_ASSETS = 'assets'; /** + *

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).

+ * * @return null|PriceDraftImportCollection */ public function getPrices(); /** + *

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).

+ * * @return null|PriceDraftImportCollection */ @@ -87,6 +94,8 @@ public function getPrices() } /** + *

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).

+ * * * @return null|PriceDraftImportCollection */ @@ -133,6 +140,8 @@ public function getPrices() } /** + *

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.

* * @return null|string @@ -44,7 +44,7 @@ interface ProductImport extends ImportResource public function getKey(); /** - *

Maps to Product.name.

+ *

Maps to ProductData.name.

* * @return null|LocalizedString @@ -52,10 +52,7 @@ public function getKey(); public function getName(); /** - *

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.

* * @return null|ProductTypeKeyReference @@ -63,8 +60,7 @@ public function getName(); public function getProductType(); /** - *

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.

* * @return null|LocalizedString @@ -72,7 +68,7 @@ public function getProductType(); public function getSlug(); /** - *

Maps to Product.description.

+ *

Maps to ProductData.description.

* * @return null|LocalizedString @@ -80,9 +76,7 @@ public function getSlug(); public function getDescription(); /** - *

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.

* * @return null|CategoryKeyReferenceCollection @@ -96,12 +90,7 @@ public function getCategories(); public function getAttributes(); /** - *

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.

* * @return null|LocalizedString @@ -109,12 +98,7 @@ public function getAttributes(); public function getMetaTitle(); /** - *

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.

* * @return null|LocalizedString @@ -122,12 +106,7 @@ public function getMetaTitle(); public function getMetaDescription(); /** - *

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.

* * @return null|LocalizedString @@ -135,8 +114,7 @@ public function getMetaDescription(); public function getMetaKeywords(); /** - *

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.

* * @return null|TaxCategoryKeyReference @@ -144,23 +122,7 @@ public function getMetaKeywords(); public function getTaxCategory(); /** - *

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.

* * @return null|SearchKeywords @@ -168,8 +130,7 @@ public function getTaxCategory(); public function getSearchKeywords(); /** - *

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.

* * @return null|StateKeyReference @@ -185,7 +146,7 @@ public function getState(); public function getPublish(); /** - *

Determines the type of Prices the API uses. If not provided, the existing Product.priceMode is not changed.

+ *

Maps to Product.priceMode.

* * @return null|string diff --git a/lib/commercetools-import/src/Models/Products/ProductImportBuilder.php b/lib/commercetools-import/src/Models/Products/ProductImportBuilder.php index cda38061248..d119bd041a6 100644 --- a/lib/commercetools-import/src/Models/Products/ProductImportBuilder.php +++ b/lib/commercetools-import/src/Models/Products/ProductImportBuilder.php @@ -123,7 +123,7 @@ final class ProductImportBuilder implements Builder private $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.

* * @return null|string @@ -134,7 +134,7 @@ public function getKey() } /** - *

Maps to Product.name.

+ *

Maps to ProductData.name.

* * @return null|LocalizedString @@ -145,10 +145,7 @@ public function getName() } /** - *

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.

* * @return null|ProductTypeKeyReference @@ -159,8 +156,7 @@ public function getProductType() } /** - *

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.

* * @return null|LocalizedString @@ -171,7 +167,7 @@ public function getSlug() } /** - *

Maps to Product.description.

+ *

Maps to ProductData.description.

* * @return null|LocalizedString @@ -182,9 +178,7 @@ public function getDescription() } /** - *

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.

* * @return null|CategoryKeyReferenceCollection @@ -204,12 +198,7 @@ public function getAttributes() } /** - *

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.

* * @return null|LocalizedString @@ -220,12 +209,7 @@ public function getMetaTitle() } /** - *

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.

* * @return null|LocalizedString @@ -236,12 +220,7 @@ public function getMetaDescription() } /** - *

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.

* * @return null|LocalizedString @@ -252,8 +231,7 @@ public function getMetaKeywords() } /** - *

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.

* * @return null|TaxCategoryKeyReference @@ -264,23 +242,7 @@ public function getTaxCategory() } /** - *

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.

* * @return null|SearchKeywords @@ -291,8 +253,7 @@ public function getSearchKeywords() } /** - *

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.

* * @return null|StateKeyReference @@ -314,7 +275,7 @@ public function getPublish() } /** - *

Determines the type of Prices the API uses. If not provided, the existing Product.priceMode is not changed.

+ *

Maps to Product.priceMode.

* * @return null|string diff --git a/lib/commercetools-import/src/Models/Products/ProductImportModel.php b/lib/commercetools-import/src/Models/Products/ProductImportModel.php index 4326d3e88f8..327ff429b40 100644 --- a/lib/commercetools-import/src/Models/Products/ProductImportModel.php +++ b/lib/commercetools-import/src/Models/Products/ProductImportModel.php @@ -160,7 +160,7 @@ public function __construct( } /** - *

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.

* * * @return null|string @@ -180,7 +180,7 @@ public function getKey() } /** - *

Maps to Product.name.

+ *

Maps to ProductData.name.

* * * @return null|LocalizedString @@ -201,10 +201,7 @@ public function getName() } /** - *

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.

* * * @return null|ProductTypeKeyReference @@ -225,8 +222,7 @@ public function getProductType() } /** - *

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.

* * * @return null|LocalizedString @@ -247,7 +243,7 @@ public function getSlug() } /** - *

Maps to Product.description.

+ *

Maps to ProductData.description.

* * * @return null|LocalizedString @@ -268,9 +264,7 @@ public function getDescription() } /** - *

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.

* * * @return null|CategoryKeyReferenceCollection @@ -308,12 +302,7 @@ public function getAttributes() } /** - *

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.

* * * @return null|LocalizedString @@ -334,12 +323,7 @@ public function getMetaTitle() } /** - *

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.

* * * @return null|LocalizedString @@ -360,12 +344,7 @@ public function getMetaDescription() } /** - *

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.

* * * @return null|LocalizedString @@ -386,8 +365,7 @@ public function getMetaKeywords() } /** - *

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.

* * * @return null|TaxCategoryKeyReference @@ -408,23 +386,7 @@ public function getTaxCategory() } /** - *

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.

* * * @return null|SearchKeywords @@ -445,8 +407,7 @@ public function getSearchKeywords() } /** - *

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.

* * * @return null|StateKeyReference @@ -487,7 +448,7 @@ public function getPublish() } /** - *

Determines the type of Prices the API uses. If not provided, the existing Product.priceMode is not changed.

+ *

Maps to Product.priceMode.

* * * @return null|string diff --git a/lib/commercetools-import/src/Models/Producttypes/AttributeDefinition.php b/lib/commercetools-import/src/Models/Producttypes/AttributeDefinition.php index fa6d2610777..fd4e521e81c 100644 --- a/lib/commercetools-import/src/Models/Producttypes/AttributeDefinition.php +++ b/lib/commercetools-import/src/Models/Producttypes/AttributeDefinition.php @@ -25,24 +25,23 @@ interface AttributeDefinition extends JsonObject public const FIELD_LEVEL = 'level'; /** + *

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.

+ * * @return null|bool */ public function getIsRequired(); /** + *

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.

+ * * @return null|bool */ diff --git a/lib/commercetools-import/src/Models/Producttypes/AttributeDefinitionBuilder.php b/lib/commercetools-import/src/Models/Producttypes/AttributeDefinitionBuilder.php index 45a2fad390d..03470f3ec50 100644 --- a/lib/commercetools-import/src/Models/Producttypes/AttributeDefinitionBuilder.php +++ b/lib/commercetools-import/src/Models/Producttypes/AttributeDefinitionBuilder.php @@ -77,6 +77,8 @@ final class AttributeDefinitionBuilder implements Builder private $level; /** + *

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.

+ * * @return null|bool */ @@ -120,6 +121,8 @@ public function getIsRequired() } /** + *

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.

+ * * @return null|bool */ diff --git a/lib/commercetools-import/src/Models/Producttypes/AttributeDefinitionModel.php b/lib/commercetools-import/src/Models/Producttypes/AttributeDefinitionModel.php index 327028488f6..71c519a6111 100644 --- a/lib/commercetools-import/src/Models/Producttypes/AttributeDefinitionModel.php +++ b/lib/commercetools-import/src/Models/Producttypes/AttributeDefinitionModel.php @@ -102,6 +102,8 @@ public function __construct( } /** + *

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.

+ * * * @return null|bool */ @@ -183,6 +184,8 @@ public function getIsRequired() } /** + *

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.

+ * * * @return null|bool */ diff --git a/lib/commercetools-import/src/Models/Producttypes/AttributeNestedType.php b/lib/commercetools-import/src/Models/Producttypes/AttributeNestedType.php index 4347cb9dcdb..02327741b67 100644 --- a/lib/commercetools-import/src/Models/Producttypes/AttributeNestedType.php +++ b/lib/commercetools-import/src/Models/Producttypes/AttributeNestedType.php @@ -17,7 +17,7 @@ interface AttributeNestedType extends AttributeType public const FIELD_TYPE_REFERENCE = 'typeReference'; /** - *

References a product type by key.

+ *

References a ProductType by key.

* * @return null|ProductTypeKeyReference diff --git a/lib/commercetools-import/src/Models/Producttypes/AttributeNestedTypeBuilder.php b/lib/commercetools-import/src/Models/Producttypes/AttributeNestedTypeBuilder.php index 4751cf3e197..0446692c844 100644 --- a/lib/commercetools-import/src/Models/Producttypes/AttributeNestedTypeBuilder.php +++ b/lib/commercetools-import/src/Models/Producttypes/AttributeNestedTypeBuilder.php @@ -29,7 +29,7 @@ final class AttributeNestedTypeBuilder implements Builder private $typeReference; /** - *

References a product type by key.

+ *

References a ProductType by key.

* * @return null|ProductTypeKeyReference diff --git a/lib/commercetools-import/src/Models/Producttypes/AttributeNestedTypeModel.php b/lib/commercetools-import/src/Models/Producttypes/AttributeNestedTypeModel.php index 65506f91603..643ef100e36 100644 --- a/lib/commercetools-import/src/Models/Producttypes/AttributeNestedTypeModel.php +++ b/lib/commercetools-import/src/Models/Producttypes/AttributeNestedTypeModel.php @@ -65,7 +65,7 @@ public function getName() } /** - *

References a product type by key.

+ *

References a ProductType by key.

* * * @return null|ProductTypeKeyReference diff --git a/lib/commercetools-import/src/Models/Producttypes/AttributeReferenceType.php b/lib/commercetools-import/src/Models/Producttypes/AttributeReferenceType.php index 1cd71623a05..bc912f47a8f 100644 --- a/lib/commercetools-import/src/Models/Producttypes/AttributeReferenceType.php +++ b/lib/commercetools-import/src/Models/Producttypes/AttributeReferenceType.php @@ -16,7 +16,7 @@ interface AttributeReferenceType extends AttributeType public const FIELD_REFERENCE_TYPE_ID = 'referenceTypeId'; /** - *

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.

* * @return null|string diff --git a/lib/commercetools-import/src/Models/Producttypes/ProductTypeImportBuilder.php b/lib/commercetools-import/src/Models/Producttypes/ProductTypeImportBuilder.php index 1cc60f2a46e..59f6c192ddd 100644 --- a/lib/commercetools-import/src/Models/Producttypes/ProductTypeImportBuilder.php +++ b/lib/commercetools-import/src/Models/Producttypes/ProductTypeImportBuilder.php @@ -47,7 +47,7 @@ final class ProductTypeImportBuilder implements Builder private $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.

* * @return null|string diff --git a/lib/commercetools-import/src/Models/Producttypes/ProductTypeImportModel.php b/lib/commercetools-import/src/Models/Producttypes/ProductTypeImportModel.php index dd3e6d9fdd5..5fd07f68a79 100644 --- a/lib/commercetools-import/src/Models/Producttypes/ProductTypeImportModel.php +++ b/lib/commercetools-import/src/Models/Producttypes/ProductTypeImportModel.php @@ -62,7 +62,7 @@ public function __construct( } /** - *

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.

* * * @return null|string diff --git a/lib/commercetools-import/src/Models/Productvariants/Attribute.php b/lib/commercetools-import/src/Models/Productvariants/Attribute.php index 52b86dd6d05..01a0f195cec 100644 --- a/lib/commercetools-import/src/Models/Productvariants/Attribute.php +++ b/lib/commercetools-import/src/Models/Productvariants/Attribute.php @@ -18,9 +18,9 @@ interface Attribute extends JsonObject public const FIELD_TYPE = '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.

* * @return null|string @@ -28,6 +28,10 @@ interface Attribute extends JsonObject public function getName(); /** + *

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.

+ * * @return null|string */ diff --git a/lib/commercetools-import/src/Models/Productvariants/AttributeBuilder.php b/lib/commercetools-import/src/Models/Productvariants/AttributeBuilder.php index 059556d9f07..9bc067f8c23 100644 --- a/lib/commercetools-import/src/Models/Productvariants/AttributeBuilder.php +++ b/lib/commercetools-import/src/Models/Productvariants/AttributeBuilder.php @@ -27,9 +27,9 @@ final class AttributeBuilder implements Builder private $name; /** - *

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.

* * @return null|string diff --git a/lib/commercetools-import/src/Models/Productvariants/AttributeModel.php b/lib/commercetools-import/src/Models/Productvariants/AttributeModel.php index e4e8baa2d2d..33bb88be01b 100644 --- a/lib/commercetools-import/src/Models/Productvariants/AttributeModel.php +++ b/lib/commercetools-import/src/Models/Productvariants/AttributeModel.php @@ -73,9 +73,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.

* * * @return null|string @@ -95,6 +95,10 @@ public function getName() } /** + *

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.

+ * * * @return null|string */ diff --git a/lib/commercetools-import/src/Models/Productvariants/BooleanAttribute.php b/lib/commercetools-import/src/Models/Productvariants/BooleanAttribute.php index 21b76baa23b..2140016127c 100644 --- a/lib/commercetools-import/src/Models/Productvariants/BooleanAttribute.php +++ b/lib/commercetools-import/src/Models/Productvariants/BooleanAttribute.php @@ -16,6 +16,8 @@ interface BooleanAttribute extends Attribute public const FIELD_VALUE = 'value'; /** + *

true or false

+ * * @return null|bool */ diff --git a/lib/commercetools-import/src/Models/Productvariants/BooleanAttributeBuilder.php b/lib/commercetools-import/src/Models/Productvariants/BooleanAttributeBuilder.php index 0c83a77204d..95c2a710915 100644 --- a/lib/commercetools-import/src/Models/Productvariants/BooleanAttributeBuilder.php +++ b/lib/commercetools-import/src/Models/Productvariants/BooleanAttributeBuilder.php @@ -33,9 +33,9 @@ final class BooleanAttributeBuilder 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.

* * @return null|string @@ -46,6 +46,8 @@ public function getName() } /** + *

true or false

+ * * @return null|bool */ diff --git a/lib/commercetools-import/src/Models/Productvariants/BooleanAttributeModel.php b/lib/commercetools-import/src/Models/Productvariants/BooleanAttributeModel.php index be4792dc6fa..59318154f8b 100644 --- a/lib/commercetools-import/src/Models/Productvariants/BooleanAttributeModel.php +++ b/lib/commercetools-import/src/Models/Productvariants/BooleanAttributeModel.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.

* * * @return null|string @@ -75,6 +75,10 @@ public function getName() } /** + *

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.

+ * * * @return null|string */ @@ -93,6 +97,8 @@ public function getType() } /** + *

true or false

+ * * * @return null|bool */ diff --git a/lib/commercetools-import/src/Models/Productvariants/BooleanSetAttribute.php b/lib/commercetools-import/src/Models/Productvariants/BooleanSetAttribute.php index 106ce15ae7b..d1bdb237352 100644 --- a/lib/commercetools-import/src/Models/Productvariants/BooleanSetAttribute.php +++ b/lib/commercetools-import/src/Models/Productvariants/BooleanSetAttribute.php @@ -16,6 +16,8 @@ interface BooleanSetAttribute extends Attribute public const FIELD_VALUE = 'value'; /** + *

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.

* * @return null|string @@ -46,6 +46,8 @@ public function getName() } /** + *

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.

* * * @return null|string @@ -75,6 +75,10 @@ public function getName() } /** + *

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.

+ * * * @return null|string */ @@ -93,6 +97,8 @@ public function getType() } /** + *

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.

+ * * @return null|DateTimeImmutable */ diff --git a/lib/commercetools-import/src/Models/Productvariants/DateAttributeBuilder.php b/lib/commercetools-import/src/Models/Productvariants/DateAttributeBuilder.php index 38d5989b677..ed38f02086c 100644 --- a/lib/commercetools-import/src/Models/Productvariants/DateAttributeBuilder.php +++ b/lib/commercetools-import/src/Models/Productvariants/DateAttributeBuilder.php @@ -34,9 +34,9 @@ final class DateAttributeBuilder 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.

* * @return null|string @@ -47,6 +47,8 @@ public function getName() } /** + *

A date in the format YYYY-MM-DD.

+ * * @return null|DateTimeImmutable */ diff --git a/lib/commercetools-import/src/Models/Productvariants/DateAttributeModel.php b/lib/commercetools-import/src/Models/Productvariants/DateAttributeModel.php index e65ca05a046..c357f4404d9 100644 --- a/lib/commercetools-import/src/Models/Productvariants/DateAttributeModel.php +++ b/lib/commercetools-import/src/Models/Productvariants/DateAttributeModel.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.

* * * @return null|string @@ -76,6 +76,10 @@ public function getName() } /** + *

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.

+ * * * @return null|string */ @@ -94,6 +98,8 @@ public function getType() } /** + *

A date in the format YYYY-MM-DD.

+ * * * @return null|DateTimeImmutable */ diff --git a/lib/commercetools-import/src/Models/Productvariants/DateSetAttribute.php b/lib/commercetools-import/src/Models/Productvariants/DateSetAttribute.php index 763f98520d1..6c3e56c9283 100644 --- a/lib/commercetools-import/src/Models/Productvariants/DateSetAttribute.php +++ b/lib/commercetools-import/src/Models/Productvariants/DateSetAttribute.php @@ -16,6 +16,8 @@ interface DateSetAttribute extends Attribute public const FIELD_VALUE = 'value'; /** + *

A set of dates in the format YYYY-MM-DD.

+ * * @return null|DateTimeImmutableCollection */ diff --git a/lib/commercetools-import/src/Models/Productvariants/DateSetAttributeBuilder.php b/lib/commercetools-import/src/Models/Productvariants/DateSetAttributeBuilder.php index f056d47a3e0..ced66da5ffc 100644 --- a/lib/commercetools-import/src/Models/Productvariants/DateSetAttributeBuilder.php +++ b/lib/commercetools-import/src/Models/Productvariants/DateSetAttributeBuilder.php @@ -33,9 +33,9 @@ final class DateSetAttributeBuilder 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.

* * @return null|string @@ -46,6 +46,8 @@ public function getName() } /** + *

A set of dates in the format YYYY-MM-DD.

+ * * @return null|DateTimeImmutableCollection */ diff --git a/lib/commercetools-import/src/Models/Productvariants/DateSetAttributeModel.php b/lib/commercetools-import/src/Models/Productvariants/DateSetAttributeModel.php index a805803e613..bb105de2443 100644 --- a/lib/commercetools-import/src/Models/Productvariants/DateSetAttributeModel.php +++ b/lib/commercetools-import/src/Models/Productvariants/DateSetAttributeModel.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.

* * * @return null|string @@ -75,6 +75,10 @@ public function getName() } /** + *

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.

+ * * * @return null|string */ @@ -93,6 +97,8 @@ public function getType() } /** + *

A set of dates in the format YYYY-MM-DD.

+ * * * @return null|DateTimeImmutableCollection */ diff --git a/lib/commercetools-import/src/Models/Productvariants/DateTimeAttribute.php b/lib/commercetools-import/src/Models/Productvariants/DateTimeAttribute.php index 91ae04221d6..b0059c78f49 100644 --- a/lib/commercetools-import/src/Models/Productvariants/DateTimeAttribute.php +++ b/lib/commercetools-import/src/Models/Productvariants/DateTimeAttribute.php @@ -17,6 +17,10 @@ interface DateTimeAttribute extends Attribute public const FIELD_VALUE = 'value'; /** + *

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.

+ * * @return null|DateTimeImmutable */ diff --git a/lib/commercetools-import/src/Models/Productvariants/DateTimeAttributeBuilder.php b/lib/commercetools-import/src/Models/Productvariants/DateTimeAttributeBuilder.php index 5785da37052..b4de828c06e 100644 --- a/lib/commercetools-import/src/Models/Productvariants/DateTimeAttributeBuilder.php +++ b/lib/commercetools-import/src/Models/Productvariants/DateTimeAttributeBuilder.php @@ -34,9 +34,9 @@ final class DateTimeAttributeBuilder 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.

* * @return null|string @@ -47,6 +47,10 @@ public function getName() } /** + *

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.

+ * * @return null|DateTimeImmutable */ diff --git a/lib/commercetools-import/src/Models/Productvariants/DateTimeAttributeModel.php b/lib/commercetools-import/src/Models/Productvariants/DateTimeAttributeModel.php index 9c414417b91..f7a8e3c2d27 100644 --- a/lib/commercetools-import/src/Models/Productvariants/DateTimeAttributeModel.php +++ b/lib/commercetools-import/src/Models/Productvariants/DateTimeAttributeModel.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.

* * * @return null|string @@ -76,6 +76,10 @@ public function getName() } /** + *

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.

+ * * * @return null|string */ @@ -94,6 +98,10 @@ public function getType() } /** + *

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.

+ * * * @return null|DateTimeImmutable */ diff --git a/lib/commercetools-import/src/Models/Productvariants/DateTimeSetAttribute.php b/lib/commercetools-import/src/Models/Productvariants/DateTimeSetAttribute.php index ea7bda6845c..8b5a64e333e 100644 --- a/lib/commercetools-import/src/Models/Productvariants/DateTimeSetAttribute.php +++ b/lib/commercetools-import/src/Models/Productvariants/DateTimeSetAttribute.php @@ -16,6 +16,10 @@ interface DateTimeSetAttribute extends Attribute public const FIELD_VALUE = 'value'; /** + *

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.

+ * * @return null|DateTimeImmutableCollection */ diff --git a/lib/commercetools-import/src/Models/Productvariants/DateTimeSetAttributeBuilder.php b/lib/commercetools-import/src/Models/Productvariants/DateTimeSetAttributeBuilder.php index c50a888acf2..f85a0828e26 100644 --- a/lib/commercetools-import/src/Models/Productvariants/DateTimeSetAttributeBuilder.php +++ b/lib/commercetools-import/src/Models/Productvariants/DateTimeSetAttributeBuilder.php @@ -33,9 +33,9 @@ final class DateTimeSetAttributeBuilder 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.

* * @return null|string @@ -46,6 +46,10 @@ public function getName() } /** + *

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.

+ * * @return null|DateTimeImmutableCollection */ diff --git a/lib/commercetools-import/src/Models/Productvariants/DateTimeSetAttributeModel.php b/lib/commercetools-import/src/Models/Productvariants/DateTimeSetAttributeModel.php index 25c16f00787..c0f4b47c12f 100644 --- a/lib/commercetools-import/src/Models/Productvariants/DateTimeSetAttributeModel.php +++ b/lib/commercetools-import/src/Models/Productvariants/DateTimeSetAttributeModel.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.

* * * @return null|string @@ -75,6 +75,10 @@ public function getName() } /** + *

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.

+ * * * @return null|string */ @@ -93,6 +97,10 @@ public function getType() } /** + *

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.

+ * * * @return null|DateTimeImmutableCollection */ diff --git a/lib/commercetools-import/src/Models/Productvariants/EnumAttribute.php b/lib/commercetools-import/src/Models/Productvariants/EnumAttribute.php index 06bbd4a4f56..bd2d239c552 100644 --- a/lib/commercetools-import/src/Models/Productvariants/EnumAttribute.php +++ b/lib/commercetools-import/src/Models/Productvariants/EnumAttribute.php @@ -16,6 +16,9 @@ interface EnumAttribute extends Attribute public const FIELD_VALUE = 'value'; /** + *

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.

* * @return null|string @@ -46,6 +46,9 @@ public function getName() } /** + *

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.

* * * @return null|string @@ -75,6 +75,10 @@ public function getName() } /** + *

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.

+ * * * @return null|string */ @@ -93,6 +97,9 @@ public function getType() } /** + *

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.

* * @return null|string @@ -46,6 +46,9 @@ public function getName() } /** + *

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.

* * * @return null|string @@ -75,6 +75,10 @@ public function getName() } /** + *

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.

+ * * * @return null|string */ @@ -93,6 +97,9 @@ public function getType() } /** + *

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.

* * @return null|string @@ -46,6 +46,9 @@ public function getName() } /** + *

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.

* * * @return null|string @@ -75,6 +75,10 @@ public function getName() } /** + *

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.

+ * * * @return null|string */ @@ -93,6 +97,9 @@ public function getType() } /** + *

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.

* * @return null|string @@ -46,6 +46,9 @@ public function getName() } /** + *

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.

* * * @return null|string @@ -75,6 +75,10 @@ public function getName() } /** + *

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.

+ * * * @return null|string */ @@ -93,6 +97,9 @@ public function getType() } /** + *

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.

* * @return null|string @@ -48,12 +48,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"
-     * }
-     * 
+ *

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.

* * * @return null|string @@ -77,6 +77,10 @@ public function getName() } /** + *

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.

+ * * * @return null|string */ @@ -95,12 +99,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/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.

* * @return null|string @@ -47,6 +47,8 @@ public function getName() } /** + *

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.

* * * @return null|string @@ -76,6 +76,10 @@ public function getName() } /** + *

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.

+ * * * @return null|string */ @@ -94,6 +98,8 @@ public function getType() } /** + *

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.

* * @return null|string @@ -48,6 +48,8 @@ public function getName() } /** + *

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.

* * * @return null|string @@ -77,6 +77,10 @@ public function getName() } /** + *

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.

+ * * * @return null|string */ @@ -95,6 +99,8 @@ public function getType() } /** + *

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.

* * @return null|string @@ -47,6 +47,8 @@ public function getName() } /** + *

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.

* * * @return null|string @@ -76,6 +76,10 @@ public function getName() } /** + *

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.

+ * * * @return null|string */ @@ -94,6 +98,8 @@ public function getType() } /** + *

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.

* * @return null|string @@ -46,6 +46,9 @@ public function getName() } /** + *

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.

* * * @return null|string @@ -75,6 +75,10 @@ public function getName() } /** + *

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.

+ * * * @return null|string */ @@ -93,6 +97,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/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.

* * @return null|string @@ -46,6 +46,9 @@ public function getName() } /** + *

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.

* * * @return null|string @@ -75,6 +75,10 @@ public function getName() } /** + *

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.

+ * * * @return null|string */ @@ -93,6 +97,9 @@ public function getType() } /** + *

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.

* * @return null|string @@ -79,7 +79,7 @@ public function getAssets(); /** * * @@ -89,9 +89,7 @@ public function getAssets(); public function getStaged(); /** - *

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.

* * @return null|ProductKeyReference diff --git a/lib/commercetools-import/src/Models/Productvariants/ProductVariantImportBuilder.php b/lib/commercetools-import/src/Models/Productvariants/ProductVariantImportBuilder.php index f1f33d37b7b..06a1a96ec69 100644 --- a/lib/commercetools-import/src/Models/Productvariants/ProductVariantImportBuilder.php +++ b/lib/commercetools-import/src/Models/Productvariants/ProductVariantImportBuilder.php @@ -75,7 +75,7 @@ final class ProductVariantImportBuilder implements Builder private $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.

* * @return null|string @@ -146,7 +146,7 @@ public function getAssets() /** * * @@ -159,9 +159,7 @@ public function getStaged() } /** - *

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.

* * @return null|ProductKeyReference diff --git a/lib/commercetools-import/src/Models/Productvariants/ProductVariantImportModel.php b/lib/commercetools-import/src/Models/Productvariants/ProductVariantImportModel.php index 6005a853edb..74af62db4da 100644 --- a/lib/commercetools-import/src/Models/Productvariants/ProductVariantImportModel.php +++ b/lib/commercetools-import/src/Models/Productvariants/ProductVariantImportModel.php @@ -98,7 +98,7 @@ public function __construct( } /** - *

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.

* * * @return null|string @@ -223,7 +223,7 @@ public function getAssets() /** * * @@ -245,9 +245,7 @@ public function getStaged() } /** - *

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.

* * * @return null|ProductKeyReference diff --git a/lib/commercetools-import/src/Models/Productvariants/ProductVariantPatch.php b/lib/commercetools-import/src/Models/Productvariants/ProductVariantPatch.php index 9ccf1a269ef..8fb0b349ac9 100644 --- a/lib/commercetools-import/src/Models/Productvariants/ProductVariantPatch.php +++ b/lib/commercetools-import/src/Models/Productvariants/ProductVariantPatch.php @@ -21,8 +21,7 @@ interface ProductVariantPatch extends JsonObject public const FIELD_PRODUCT = 'product'; /** - *

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(); *
  • The referenced Attribute must be defined in an existing ProductType, or the state of the ImportOperation will be validationFailed.
  • *
  • Setting the value of a non-required Attribute to null will remove the Attribute.
  • *
  • Attempting to set a null value to a required Attribute will make the import operation fail with an InvalidOperation error.
  • - *
  • Importing LocalizableTextAttributes or LocalizableTextSetAttributes follows an override pattern, meaning that omitted localized fields will be deleted, new fields will be created, and existing fields will be updated. You can also delete localized fields by setting their value to null.
  • + *
  • Importing LocalizableTextAttributes or LocalizableTextSetAttributes follows an override pattern, meaning that omitted localized fields will be deleted, new fields will be created, and existing fields will be updated. You can delete localized fields by setting their value to null.
  • * * @@ -52,9 +51,10 @@ public function getAttributes(); public function getStaged(); /** - *

    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.

    * * @return null|ProductKeyReference diff --git a/lib/commercetools-import/src/Models/Productvariants/ProductVariantPatchBuilder.php b/lib/commercetools-import/src/Models/Productvariants/ProductVariantPatchBuilder.php index f48aabe4d53..16e229b18b4 100644 --- a/lib/commercetools-import/src/Models/Productvariants/ProductVariantPatchBuilder.php +++ b/lib/commercetools-import/src/Models/Productvariants/ProductVariantPatchBuilder.php @@ -49,8 +49,7 @@ final class ProductVariantPatchBuilder implements Builder private $product; /** - *

    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() *
  • The referenced Attribute must be defined in an existing ProductType, or the state of the ImportOperation will be validationFailed.
  • *
  • Setting the value of a non-required Attribute to null will remove the Attribute.
  • *
  • Attempting to set a null value to a required Attribute will make the import operation fail with an InvalidOperation error.
  • - *
  • Importing LocalizableTextAttributes or LocalizableTextSetAttributes follows an override pattern, meaning that omitted localized fields will be deleted, new fields will be created, and existing fields will be updated. You can also delete localized fields by setting their value to null.
  • + *
  • Importing LocalizableTextAttributes or LocalizableTextSetAttributes follows an override pattern, meaning that omitted localized fields will be deleted, new fields will be created, and existing fields will be updated. You can delete localized fields by setting their value to null.
  • * * @@ -89,9 +88,10 @@ public function getStaged() } /** - *

    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.

    * * @return null|ProductKeyReference diff --git a/lib/commercetools-import/src/Models/Productvariants/ProductVariantPatchModel.php b/lib/commercetools-import/src/Models/Productvariants/ProductVariantPatchModel.php index be5d03cb6c2..16dbfb9f587 100644 --- a/lib/commercetools-import/src/Models/Productvariants/ProductVariantPatchModel.php +++ b/lib/commercetools-import/src/Models/Productvariants/ProductVariantPatchModel.php @@ -64,8 +64,7 @@ public function __construct( } /** - *

    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() *
  • The referenced Attribute must be defined in an existing ProductType, or the state of the ImportOperation will be validationFailed.
  • *
  • Setting the value of a non-required Attribute to null will remove the Attribute.
  • *
  • Attempting to set a null value to a required Attribute will make the import operation fail with an InvalidOperation error.
  • - *
  • Importing LocalizableTextAttributes or LocalizableTextSetAttributes follows an override pattern, meaning that omitted localized fields will be deleted, new fields will be created, and existing fields will be updated. You can also delete localized fields by setting their value to null.
  • + *
  • Importing LocalizableTextAttributes or LocalizableTextSetAttributes follows an override pattern, meaning that omitted localized fields will be deleted, new fields will be created, and existing fields will be updated. You can delete localized fields by setting their value to null.
  • * * * @@ -133,9 +132,10 @@ public function getStaged() } /** - *

    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.

    * * * @return null|ProductKeyReference diff --git a/lib/commercetools-import/src/Models/Productvariants/ReferenceAttributeBuilder.php b/lib/commercetools-import/src/Models/Productvariants/ReferenceAttributeBuilder.php index ef4ed98c731..5608bd0ddc6 100644 --- a/lib/commercetools-import/src/Models/Productvariants/ReferenceAttributeBuilder.php +++ b/lib/commercetools-import/src/Models/Productvariants/ReferenceAttributeBuilder.php @@ -35,9 +35,9 @@ final class ReferenceAttributeBuilder 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.

    * * @return null|string diff --git a/lib/commercetools-import/src/Models/Productvariants/ReferenceAttributeModel.php b/lib/commercetools-import/src/Models/Productvariants/ReferenceAttributeModel.php index 4a62fd81f8d..beea4ab9e00 100644 --- a/lib/commercetools-import/src/Models/Productvariants/ReferenceAttributeModel.php +++ b/lib/commercetools-import/src/Models/Productvariants/ReferenceAttributeModel.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.

    * * * @return null|string @@ -77,6 +77,10 @@ public function getName() } /** + *

    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.

    + * * * @return null|string */ diff --git a/lib/commercetools-import/src/Models/Productvariants/ReferenceSetAttribute.php b/lib/commercetools-import/src/Models/Productvariants/ReferenceSetAttribute.php index bb54b59f0fb..e1ab9d0dadb 100644 --- a/lib/commercetools-import/src/Models/Productvariants/ReferenceSetAttribute.php +++ b/lib/commercetools-import/src/Models/Productvariants/ReferenceSetAttribute.php @@ -17,6 +17,9 @@ interface ReferenceSetAttribute extends Attribute public const FIELD_VALUE = 'value'; /** + *

    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.

    * * @return null|string @@ -47,6 +47,9 @@ public function getName() } /** + *

    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.

    * * * @return null|string @@ -76,6 +76,10 @@ public function getName() } /** + *

    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.

    + * * * @return null|string */ @@ -94,6 +98,9 @@ public function getType() } /** + *

    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.

    * * @return null|string @@ -46,6 +46,8 @@ public function getName() } /** + *

    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.

    * * * @return null|string @@ -75,6 +75,10 @@ public function getName() } /** + *

    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.

    + * * * @return null|string */ @@ -93,6 +97,8 @@ public function getType() } /** + *

    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.

    * * @return null|string @@ -46,6 +46,8 @@ public function getName() } /** + *

    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.

    * * * @return null|string @@ -75,6 +75,10 @@ public function getName() } /** + *

    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.

    + * * * @return null|string */ @@ -93,6 +97,8 @@ public function getType() } /** + *

    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.

    + * * @return null|DateTimeImmutable */ diff --git a/lib/commercetools-import/src/Models/Productvariants/TimeAttributeBuilder.php b/lib/commercetools-import/src/Models/Productvariants/TimeAttributeBuilder.php index 1c399271e74..1c725ae5a6a 100644 --- a/lib/commercetools-import/src/Models/Productvariants/TimeAttributeBuilder.php +++ b/lib/commercetools-import/src/Models/Productvariants/TimeAttributeBuilder.php @@ -34,9 +34,9 @@ final class TimeAttributeBuilder 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.

    * * @return null|string @@ -47,6 +47,10 @@ public function getName() } /** + *

    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.

    + * * @return null|DateTimeImmutable */ diff --git a/lib/commercetools-import/src/Models/Productvariants/TimeAttributeModel.php b/lib/commercetools-import/src/Models/Productvariants/TimeAttributeModel.php index 633bfd2bfe6..cd74a36e042 100644 --- a/lib/commercetools-import/src/Models/Productvariants/TimeAttributeModel.php +++ b/lib/commercetools-import/src/Models/Productvariants/TimeAttributeModel.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.

    * * * @return null|string @@ -76,6 +76,10 @@ public function getName() } /** + *

    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.

    + * * * @return null|string */ @@ -94,6 +98,10 @@ public function getType() } /** + *

    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.

    + * * * @return null|DateTimeImmutable */ diff --git a/lib/commercetools-import/src/Models/Productvariants/TimeSetAttribute.php b/lib/commercetools-import/src/Models/Productvariants/TimeSetAttribute.php index 9284615d955..cc35a6583b4 100644 --- a/lib/commercetools-import/src/Models/Productvariants/TimeSetAttribute.php +++ b/lib/commercetools-import/src/Models/Productvariants/TimeSetAttribute.php @@ -16,6 +16,10 @@ interface TimeSetAttribute extends Attribute public const FIELD_VALUE = 'value'; /** + *

    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.

    + * * @return null|DateTimeImmutableCollection */ diff --git a/lib/commercetools-import/src/Models/Productvariants/TimeSetAttributeBuilder.php b/lib/commercetools-import/src/Models/Productvariants/TimeSetAttributeBuilder.php index ce23331a1e9..3a2d06b4caf 100644 --- a/lib/commercetools-import/src/Models/Productvariants/TimeSetAttributeBuilder.php +++ b/lib/commercetools-import/src/Models/Productvariants/TimeSetAttributeBuilder.php @@ -33,9 +33,9 @@ final class TimeSetAttributeBuilder 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.

    * * @return null|string @@ -46,6 +46,10 @@ public function getName() } /** + *

    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.

    + * * @return null|DateTimeImmutableCollection */ diff --git a/lib/commercetools-import/src/Models/Productvariants/TimeSetAttributeModel.php b/lib/commercetools-import/src/Models/Productvariants/TimeSetAttributeModel.php index 4e3e63e2034..d14e57831a2 100644 --- a/lib/commercetools-import/src/Models/Productvariants/TimeSetAttributeModel.php +++ b/lib/commercetools-import/src/Models/Productvariants/TimeSetAttributeModel.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.

    * * * @return null|string @@ -75,6 +75,10 @@ public function getName() } /** + *

    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.

    + * * * @return null|string */ @@ -93,6 +97,10 @@ public function getType() } /** + *

    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.

    + * * * @return null|DateTimeImmutableCollection */ diff --git a/lib/commercetools-import/src/Models/StandalonePrices/StandalonePriceImport.php b/lib/commercetools-import/src/Models/StandalonePrices/StandalonePriceImport.php index f5af88929e2..1c4cd623458 100644 --- a/lib/commercetools-import/src/Models/StandalonePrices/StandalonePriceImport.php +++ b/lib/commercetools-import/src/Models/StandalonePrices/StandalonePriceImport.php @@ -33,7 +33,7 @@ interface StandalonePriceImport extends ImportResource public const FIELD_CUSTOM = '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.

    * * @return null|string @@ -41,7 +41,7 @@ interface StandalonePriceImport extends ImportResource public function getKey(); /** - *

    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.

    * * @return null|string @@ -49,7 +49,7 @@ public function getKey(); public function getSku(); /** - *

    Sets the money value of this Price.

    + *

    Maps to StandalonePrice.value.

    * * @return null|TypedMoney @@ -57,8 +57,7 @@ public function getSku(); public function getValue(); /** - *

    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.

    * * @return null|string @@ -66,8 +65,8 @@ public function getValue(); public function getCountry(); /** - *

    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.

    * * @return null|DateTimeImmutable @@ -92,7 +91,7 @@ public function getChannel(); public function getValidFrom(); /** - *

    Sets the date until the Price is valid.

    + *

    Maps to StandalonePrice.validUntil.

    * * @return null|DateTimeImmutable @@ -100,7 +99,7 @@ public function getValidFrom(); public function getValidUntil(); /** - *

    Sets price tiers.

    + *

    Maps to StandalonePrice.tiers.

    * * @return null|PriceTierCollection @@ -116,7 +115,7 @@ public function getTiers(); public function getDiscounted(); /** - *

    Custom Fields for the StandalonePrice.

    + *

    Maps to StandalonePrice.custom.

    * * @return null|Custom diff --git a/lib/commercetools-import/src/Models/StandalonePrices/StandalonePriceImportBuilder.php b/lib/commercetools-import/src/Models/StandalonePrices/StandalonePriceImportBuilder.php index 4923ac2e6f0..e5efb4e836e 100644 --- a/lib/commercetools-import/src/Models/StandalonePrices/StandalonePriceImportBuilder.php +++ b/lib/commercetools-import/src/Models/StandalonePrices/StandalonePriceImportBuilder.php @@ -101,7 +101,7 @@ final class StandalonePriceImportBuilder implements Builder private $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.

    * * @return null|string @@ -112,7 +112,7 @@ public function getKey() } /** - *

    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.

    * * @return null|string @@ -123,7 +123,7 @@ public function getSku() } /** - *

    Sets the money value of this Price.

    + *

    Maps to StandalonePrice.value.

    * * @return null|TypedMoney @@ -134,8 +134,7 @@ public function getValue() } /** - *

    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.

    * * @return null|string @@ -146,8 +145,8 @@ public function getCountry() } /** - *

    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.

    * * @return null|DateTimeImmutable @@ -181,7 +180,7 @@ public function getValidFrom() } /** - *

    Sets the date until the Price is valid.

    + *

    Maps to StandalonePrice.validUntil.

    * * @return null|DateTimeImmutable @@ -192,7 +191,7 @@ public function getValidUntil() } /** - *

    Sets price tiers.

    + *

    Maps to StandalonePrice.tiers.

    * * @return null|PriceTierCollection @@ -214,7 +213,7 @@ public function getDiscounted() } /** - *

    Custom Fields for the StandalonePrice.

    + *

    Maps to StandalonePrice.custom.

    * * @return null|Custom diff --git a/lib/commercetools-import/src/Models/StandalonePrices/StandalonePriceImportModel.php b/lib/commercetools-import/src/Models/StandalonePrices/StandalonePriceImportModel.php index aafe36c35b4..da1766cbd49 100644 --- a/lib/commercetools-import/src/Models/StandalonePrices/StandalonePriceImportModel.php +++ b/lib/commercetools-import/src/Models/StandalonePrices/StandalonePriceImportModel.php @@ -130,7 +130,7 @@ public function __construct( } /** - *

    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.

    * * * @return null|string @@ -150,7 +150,7 @@ public function getKey() } /** - *

    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.

    * * * @return null|string @@ -170,7 +170,7 @@ public function getSku() } /** - *

    Sets the money value of this Price.

    + *

    Maps to StandalonePrice.value.

    * * * @return null|TypedMoney @@ -191,8 +191,7 @@ public function getValue() } /** - *

    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.

    * * * @return null|string @@ -212,8 +211,8 @@ public function getCountry() } /** - *

    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.

    * * * @return null|DateTimeImmutable @@ -280,7 +279,7 @@ public function getValidFrom() } /** - *

    Sets the date until the Price is valid.

    + *

    Maps to StandalonePrice.validUntil.

    * * * @return null|DateTimeImmutable @@ -304,7 +303,7 @@ public function getValidUntil() } /** - *

    Sets price tiers.

    + *

    Maps to StandalonePrice.tiers.

    * * * @return null|PriceTierCollection @@ -345,7 +344,7 @@ public function getDiscounted() } /** - *

    Custom Fields for the StandalonePrice.

    + *

    Maps to StandalonePrice.custom.

    * * * @return null|Custom diff --git a/lib/commercetools-import/src/Models/Types/CustomFieldBooleanTypeModel.php b/lib/commercetools-import/src/Models/Types/CustomFieldBooleanTypeModel.php index 3cf33d5fd0a..ed059cf3c8e 100644 --- a/lib/commercetools-import/src/Models/Types/CustomFieldBooleanTypeModel.php +++ b/lib/commercetools-import/src/Models/Types/CustomFieldBooleanTypeModel.php @@ -37,6 +37,8 @@ public function __construct( } /** + *

    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.

    + * * * @return null|string */ diff --git a/lib/commercetools-import/src/Models/Types/CustomFieldDateTimeTypeModel.php b/lib/commercetools-import/src/Models/Types/CustomFieldDateTimeTypeModel.php index b0ae4e69217..45d69c73ac6 100644 --- a/lib/commercetools-import/src/Models/Types/CustomFieldDateTimeTypeModel.php +++ b/lib/commercetools-import/src/Models/Types/CustomFieldDateTimeTypeModel.php @@ -37,6 +37,8 @@ public function __construct( } /** + *

    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.

    + * * * @return null|string */ diff --git a/lib/commercetools-import/src/Models/Types/CustomFieldDateTypeModel.php b/lib/commercetools-import/src/Models/Types/CustomFieldDateTypeModel.php index d1f2b9288df..efa38e6133f 100644 --- a/lib/commercetools-import/src/Models/Types/CustomFieldDateTypeModel.php +++ b/lib/commercetools-import/src/Models/Types/CustomFieldDateTypeModel.php @@ -37,6 +37,8 @@ public function __construct( } /** + *

    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.

    + * * * @return null|string */ diff --git a/lib/commercetools-import/src/Models/Types/CustomFieldEnumTypeModel.php b/lib/commercetools-import/src/Models/Types/CustomFieldEnumTypeModel.php index 177ce87827a..00dc1de98e3 100644 --- a/lib/commercetools-import/src/Models/Types/CustomFieldEnumTypeModel.php +++ b/lib/commercetools-import/src/Models/Types/CustomFieldEnumTypeModel.php @@ -45,6 +45,8 @@ public function __construct( } /** + *

    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.

    + * * * @return null|string */ diff --git a/lib/commercetools-import/src/Models/Types/CustomFieldLocalizedEnumTypeModel.php b/lib/commercetools-import/src/Models/Types/CustomFieldLocalizedEnumTypeModel.php index a2ee34e04b2..1285275f29b 100644 --- a/lib/commercetools-import/src/Models/Types/CustomFieldLocalizedEnumTypeModel.php +++ b/lib/commercetools-import/src/Models/Types/CustomFieldLocalizedEnumTypeModel.php @@ -45,6 +45,8 @@ public function __construct( } /** + *

    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.

    + * * * @return null|string */ diff --git a/lib/commercetools-import/src/Models/Types/CustomFieldLocalizedStringTypeModel.php b/lib/commercetools-import/src/Models/Types/CustomFieldLocalizedStringTypeModel.php index 60f9a2ff514..1393afc641a 100644 --- a/lib/commercetools-import/src/Models/Types/CustomFieldLocalizedStringTypeModel.php +++ b/lib/commercetools-import/src/Models/Types/CustomFieldLocalizedStringTypeModel.php @@ -37,6 +37,8 @@ public function __construct( } /** + *

    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.

    + * * * @return null|string */ diff --git a/lib/commercetools-import/src/Models/Types/CustomFieldMoneyTypeModel.php b/lib/commercetools-import/src/Models/Types/CustomFieldMoneyTypeModel.php index 6fde737e3ab..34ee892324a 100644 --- a/lib/commercetools-import/src/Models/Types/CustomFieldMoneyTypeModel.php +++ b/lib/commercetools-import/src/Models/Types/CustomFieldMoneyTypeModel.php @@ -37,6 +37,8 @@ public function __construct( } /** + *

    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.

    + * * * @return null|string */ diff --git a/lib/commercetools-import/src/Models/Types/CustomFieldNumberTypeModel.php b/lib/commercetools-import/src/Models/Types/CustomFieldNumberTypeModel.php index a34f4f9034a..89f181d0053 100644 --- a/lib/commercetools-import/src/Models/Types/CustomFieldNumberTypeModel.php +++ b/lib/commercetools-import/src/Models/Types/CustomFieldNumberTypeModel.php @@ -37,6 +37,8 @@ public function __construct( } /** + *

    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.

    + * * * @return null|string */ diff --git a/lib/commercetools-import/src/Models/Types/CustomFieldReferenceTypeModel.php b/lib/commercetools-import/src/Models/Types/CustomFieldReferenceTypeModel.php index 559354bb4ae..a8c543052c3 100644 --- a/lib/commercetools-import/src/Models/Types/CustomFieldReferenceTypeModel.php +++ b/lib/commercetools-import/src/Models/Types/CustomFieldReferenceTypeModel.php @@ -45,6 +45,8 @@ public function __construct( } /** + *

    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.

    + * * * @return null|string */ diff --git a/lib/commercetools-import/src/Models/Types/CustomFieldSetTypeModel.php b/lib/commercetools-import/src/Models/Types/CustomFieldSetTypeModel.php index 3b75e20b2c8..444588e95f9 100644 --- a/lib/commercetools-import/src/Models/Types/CustomFieldSetTypeModel.php +++ b/lib/commercetools-import/src/Models/Types/CustomFieldSetTypeModel.php @@ -45,6 +45,8 @@ public function __construct( } /** + *

    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.

    + * * * @return null|string */ diff --git a/lib/commercetools-import/src/Models/Types/CustomFieldStringTypeModel.php b/lib/commercetools-import/src/Models/Types/CustomFieldStringTypeModel.php index 7302315151a..aa3fcae944c 100644 --- a/lib/commercetools-import/src/Models/Types/CustomFieldStringTypeModel.php +++ b/lib/commercetools-import/src/Models/Types/CustomFieldStringTypeModel.php @@ -37,6 +37,8 @@ public function __construct( } /** + *

    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.

    + * * * @return null|string */ diff --git a/lib/commercetools-import/src/Models/Types/CustomFieldTimeTypeModel.php b/lib/commercetools-import/src/Models/Types/CustomFieldTimeTypeModel.php index bd6e323013a..bd480f35e97 100644 --- a/lib/commercetools-import/src/Models/Types/CustomFieldTimeTypeModel.php +++ b/lib/commercetools-import/src/Models/Types/CustomFieldTimeTypeModel.php @@ -37,6 +37,8 @@ public function __construct( } /** + *

    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.

    + * * * @return null|string */ diff --git a/lib/commercetools-import/src/Models/Types/FieldDefinition.php b/lib/commercetools-import/src/Models/Types/FieldDefinition.php index 207b920b765..03870f74dd4 100644 --- a/lib/commercetools-import/src/Models/Types/FieldDefinition.php +++ b/lib/commercetools-import/src/Models/Types/FieldDefinition.php @@ -53,7 +53,7 @@ public function getLabel(); 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/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.

    + * * @return null|string */ diff --git a/lib/commercetools-import/src/Models/Types/FieldTypeModel.php b/lib/commercetools-import/src/Models/Types/FieldTypeModel.php index f7e1fde49d4..e935592209a 100644 --- a/lib/commercetools-import/src/Models/Types/FieldTypeModel.php +++ b/lib/commercetools-import/src/Models/Types/FieldTypeModel.php @@ -55,6 +55,8 @@ public function __construct( } /** + *

    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.

    + * * * @return null|string */ diff --git a/lib/commercetools-import/src/Models/Types/TypeImport.php b/lib/commercetools-import/src/Models/Types/TypeImport.php index 5587fe69bd8..a6d2f9adbf6 100644 --- a/lib/commercetools-import/src/Models/Types/TypeImport.php +++ b/lib/commercetools-import/src/Models/Types/TypeImport.php @@ -21,7 +21,7 @@ interface TypeImport extends ImportResource public const FIELD_FIELD_DEFINITIONS = 'fieldDefinitions'; /** - *

    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.

    * * @return null|string diff --git a/lib/commercetools-import/src/Models/Types/TypeImportBuilder.php b/lib/commercetools-import/src/Models/Types/TypeImportBuilder.php index 0598dbdf11f..1c0f01eff9c 100644 --- a/lib/commercetools-import/src/Models/Types/TypeImportBuilder.php +++ b/lib/commercetools-import/src/Models/Types/TypeImportBuilder.php @@ -55,7 +55,7 @@ final class TypeImportBuilder implements Builder private $fieldDefinitions; /** - *

    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.

    * * @return null|string diff --git a/lib/commercetools-import/src/Models/Types/TypeImportModel.php b/lib/commercetools-import/src/Models/Types/TypeImportModel.php index db78747ebcf..ad5c3e146de 100644 --- a/lib/commercetools-import/src/Models/Types/TypeImportModel.php +++ b/lib/commercetools-import/src/Models/Types/TypeImportModel.php @@ -72,7 +72,7 @@ public function __construct( } /** - *

    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.

    * * * @return null|string diff --git a/references.txt b/references.txt index c18bd170289..729762a6a90 100644 --- a/references.txt +++ b/references.txt @@ -451,3 +451,4 @@ bb49fa04d50e4e0267846c7d805ae8ebc254bdea 6d4cd1e87a3eacff648e213aa9aff88292e9b75d 5d1789f6ec176cc91feb28ec808cb7513fe1d5a8 abbf4db007d9786e969fde88cf80cfc117f80c42 +84839875c7243dce1c079f4b0a2b782c24c5810f