From edc2d97a205064ad161c365838f9708718200bdd Mon Sep 17 00:00:00 2001 From: Auto Mation Date: Fri, 2 Jul 2021 13:36:10 +0000 Subject: [PATCH] TASK: Updating SDK --- lib/commercetools-api-tests/gen.properties | 2 +- lib/commercetools-api/gen.properties | 2 +- lib/commercetools-base/gen.properties | 2 +- .../gen.properties | 2 +- lib/commercetools-history/gen.properties | 2 +- lib/commercetools-import-tests/gen.properties | 2 +- .../docs/RequestBuilder.md | 67 +++++++++++-------- lib/commercetools-import/gen.properties | 2 +- .../src/Models/Categories/CategoryImport.php | 7 +- .../Categories/CategoryImportBuilder.php | 7 +- .../Models/Categories/CategoryImportModel.php | 7 +- .../src/Models/Customers/CustomerAddress.php | 2 +- .../Customers/CustomerAddressBuilder.php | 2 +- .../Models/Customers/CustomerAddressModel.php | 2 +- .../src/Models/Customers/CustomerImport.php | 11 +-- .../Customers/CustomerImportBuilder.php | 11 +-- .../Models/Customers/CustomerImportModel.php | 11 +-- .../Errors/InvalidStateTransitionError.php | 4 +- .../InvalidStateTransitionErrorBuilder.php | 4 +- .../InvalidStateTransitionErrorModel.php | 4 +- .../Importoperations/ImportOperation.php | 21 +++--- .../ImportOperationBuilder.php | 21 +++--- .../Importoperations/ImportOperationModel.php | 21 +++--- .../ImportOperationPagedResponse.php | 9 +-- .../ImportOperationPagedResponseBuilder.php | 9 +-- .../ImportOperationPagedResponseModel.php | 9 +-- .../ImportOperationStatus.php | 7 +- .../ImportOperationStatusBuilder.php | 7 +- .../ImportOperationStatusModel.php | 7 +- .../src/Models/Importsinks/ImportSink.php | 15 +++-- .../Models/Importsinks/ImportSinkBuilder.php | 15 +++-- .../Models/Importsinks/ImportSinkDraft.php | 9 ++- .../Importsinks/ImportSinkDraftBuilder.php | 9 ++- .../Importsinks/ImportSinkDraftModel.php | 9 ++- .../Models/Importsinks/ImportSinkModel.php | 15 +++-- .../Importsinks/ImportSinkPagedResponse.php | 9 +-- .../ImportSinkPagedResponseBuilder.php | 9 +-- .../ImportSinkPagedResponseModel.php | 9 +-- .../Models/Importsummaries/ImportSummary.php | 4 +- .../Importsummaries/ImportSummaryBuilder.php | 4 +- .../Importsummaries/ImportSummaryModel.php | 4 +- .../Importsummaries/OperationStates.php | 10 +-- .../OperationStatesBuilder.php | 10 +-- .../Importsummaries/OperationStatesModel.php | 10 +-- .../src/Models/Orders/CustomLineItemDraft.php | 4 ++ .../Orders/CustomLineItemDraftBuilder.php | 4 ++ .../Orders/CustomLineItemDraftModel.php | 4 ++ .../Orders/CustomLineItemTaxedPrice.php | 4 ++ .../CustomLineItemTaxedPriceBuilder.php | 4 ++ .../Orders/CustomLineItemTaxedPriceModel.php | 4 ++ .../src/Models/Orders/LineItemImportDraft.php | 14 ++-- .../Orders/LineItemImportDraftBuilder.php | 14 ++-- .../Orders/LineItemImportDraftModel.php | 14 ++-- .../src/Models/Orders/LineItemPrice.php | 2 +- .../Models/Orders/LineItemPriceBuilder.php | 2 +- .../src/Models/Orders/LineItemPriceModel.php | 2 +- .../src/Models/Orders/OrderImport.php | 4 +- .../src/Models/Orders/OrderImportBuilder.php | 4 +- .../src/Models/Orders/OrderImportModel.php | 4 +- .../Models/Orders/ShippingInfoImportDraft.php | 2 + .../Orders/ShippingInfoImportDraftBuilder.php | 2 + .../Orders/ShippingInfoImportDraftModel.php | 2 + .../src/Models/Orders/TaxPortion.php | 2 + .../src/Models/Orders/TaxPortionBuilder.php | 2 + .../src/Models/Orders/TaxPortionModel.php | 2 + .../src/Models/Prices/PriceImport.php | 28 +++----- .../src/Models/Prices/PriceImportBuilder.php | 28 +++----- .../src/Models/Prices/PriceImportModel.php | 28 +++----- .../Models/Productdrafts/PriceDraftImport.php | 2 + .../Productdrafts/PriceDraftImportBuilder.php | 2 + .../Productdrafts/PriceDraftImportModel.php | 2 + .../Productdrafts/ProductDraftImport.php | 32 ++++----- .../ProductDraftImportBuilder.php | 32 ++++----- .../Productdrafts/ProductDraftImportModel.php | 32 ++++----- .../src/Models/Products/ProductImport.php | 29 ++++---- .../Models/Products/ProductImportBuilder.php | 29 ++++---- .../Models/Products/ProductImportModel.php | 29 ++++---- .../Models/Producttypes/ProductTypeImport.php | 2 +- .../Producttypes/ProductTypeImportBuilder.php | 2 +- .../Producttypes/ProductTypeImportModel.php | 2 +- .../Productvariants/MoneySetAttribute.php | 2 + .../MoneySetAttributeBuilder.php | 2 + .../MoneySetAttributeModel.php | 2 + .../Productvariants/ProductVariantImport.php | 13 ++-- .../ProductVariantImportBuilder.php | 13 ++-- .../ProductVariantImportModel.php | 13 ++-- .../Productvariants/ProductVariantPatch.php | 13 ++-- .../ProductVariantPatchBuilder.php | 13 ++-- .../ProductVariantPatchModel.php | 13 ++-- lib/commercetools-ml-tests/gen.properties | 2 +- lib/commercetools-ml/gen.properties | 2 +- 91 files changed, 422 insertions(+), 446 deletions(-) diff --git a/lib/commercetools-api-tests/gen.properties b/lib/commercetools-api-tests/gen.properties index ec3aae949cf..c99be4b063f 100644 --- a/lib/commercetools-api-tests/gen.properties +++ b/lib/commercetools-api-tests/gen.properties @@ -1 +1 @@ -hash=521347af873c8879ba5c9605af6a28958010c4e3 +hash=865999c5abbf6bec6c3de7c517305ed01ffda944 diff --git a/lib/commercetools-api/gen.properties b/lib/commercetools-api/gen.properties index ec3aae949cf..c99be4b063f 100644 --- a/lib/commercetools-api/gen.properties +++ b/lib/commercetools-api/gen.properties @@ -1 +1 @@ -hash=521347af873c8879ba5c9605af6a28958010c4e3 +hash=865999c5abbf6bec6c3de7c517305ed01ffda944 diff --git a/lib/commercetools-base/gen.properties b/lib/commercetools-base/gen.properties index ec3aae949cf..c99be4b063f 100644 --- a/lib/commercetools-base/gen.properties +++ b/lib/commercetools-base/gen.properties @@ -1 +1 @@ -hash=521347af873c8879ba5c9605af6a28958010c4e3 +hash=865999c5abbf6bec6c3de7c517305ed01ffda944 diff --git a/lib/commercetools-history-tests/gen.properties b/lib/commercetools-history-tests/gen.properties index ec3aae949cf..c99be4b063f 100644 --- a/lib/commercetools-history-tests/gen.properties +++ b/lib/commercetools-history-tests/gen.properties @@ -1 +1 @@ -hash=521347af873c8879ba5c9605af6a28958010c4e3 +hash=865999c5abbf6bec6c3de7c517305ed01ffda944 diff --git a/lib/commercetools-history/gen.properties b/lib/commercetools-history/gen.properties index ec3aae949cf..c99be4b063f 100644 --- a/lib/commercetools-history/gen.properties +++ b/lib/commercetools-history/gen.properties @@ -1 +1 @@ -hash=521347af873c8879ba5c9605af6a28958010c4e3 +hash=865999c5abbf6bec6c3de7c517305ed01ffda944 diff --git a/lib/commercetools-import-tests/gen.properties b/lib/commercetools-import-tests/gen.properties index ec3aae949cf..c99be4b063f 100644 --- a/lib/commercetools-import-tests/gen.properties +++ b/lib/commercetools-import-tests/gen.properties @@ -1 +1 @@ -hash=521347af873c8879ba5c9605af6a28958010c4e3 +hash=865999c5abbf6bec6c3de7c517305ed01ffda944 diff --git a/lib/commercetools-import/docs/RequestBuilder.md b/lib/commercetools-import/docs/RequestBuilder.md index 536d5cbf1dc..06758151f46 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()->importSinkKeyWithImportSinkKeyValue("importSinkKey")->post(null)` -Creates import request for creating new categories or updating existing ones. +Creates a request for creating new Categories or updating existing ones. ### Example ```php @@ -25,7 +25,8 @@ $request = $builder ``` ## `withProjectKeyValue("projectKey")->categories()->importSinkKeyWithImportSinkKeyValue("importSinkKey")->importOperations()->get()` -Retrieves all category import operations of an import sink key. +Retrieves all Category ImportOperations of a given ImportSink key. + ### Example ```php @@ -41,7 +42,7 @@ $request = $builder ``` ## `withProjectKeyValue("projectKey")->categories()->importSinkKeyWithImportSinkKeyValue("importSinkKey")->importOperations()->withIdValue("id")->get()` -Retrieves the import operation with the given id. +Retrieves the ImportOperation of a given ID. ### Example @@ -59,7 +60,7 @@ $request = $builder ``` ## `withProjectKeyValue("projectKey")->customers()->importSinkKeyWithImportSinkKeyValue("importSinkKey")->post(null)` -Creates import request for creating new customers or updating existing ones. +Creates a request for creating new Customers or updating existing ones. ### Example ```php @@ -74,7 +75,8 @@ $request = $builder ``` ## `withProjectKeyValue("projectKey")->customers()->importSinkKeyWithImportSinkKeyValue("importSinkKey")->importOperations()->get()` -Retrieves all customer import operations of an import sink key. +Retrieves all Customer ImportOperations of a given ImportSink key. + ### Example ```php @@ -90,7 +92,7 @@ $request = $builder ``` ## `withProjectKeyValue("projectKey")->customers()->importSinkKeyWithImportSinkKeyValue("importSinkKey")->importOperations()->withIdValue("id")->get()` -Retrieves the import operation with the given id. +Retrieves the ImportOperation of a given ID. ### Example @@ -199,7 +201,7 @@ $request = $builder ``` ## `withProjectKeyValue("projectKey")->inventories()->importSinkKeyWithImportSinkKeyValue("importSinkKey")->post(null)` -Creates import request for creating new inventories or updating existing ones. +Creates a request for creating new Inventories or updating existing ones. ### Example ```php @@ -214,7 +216,8 @@ $request = $builder ``` ## `withProjectKeyValue("projectKey")->inventories()->importSinkKeyWithImportSinkKeyValue("importSinkKey")->importOperations()->get()` -Retrieves all inventory import operations of an import sink key. +Retrieves all Inventory ImportOperations of a given ImportSink key. + ### Example ```php @@ -230,7 +233,7 @@ $request = $builder ``` ## `withProjectKeyValue("projectKey")->inventories()->importSinkKeyWithImportSinkKeyValue("importSinkKey")->importOperations()->withIdValue("id")->get()` -Retrieves the import operation with the given id. +Retrieves the ImportOperation of a given ID. ### Example @@ -263,7 +266,8 @@ $request = $builder ``` ## `withProjectKeyValue("projectKey")->orderPatches()->importSinkKeyWithImportSinkKeyValue("importSinkKey")->importOperations()->get()` -Retrieves all order-patches import operations of an import sink key. +Retrieves all OrderPatch ImportOperations of a given ImportSink key. + ### Example ```php @@ -279,7 +283,7 @@ $request = $builder ``` ## `withProjectKeyValue("projectKey")->orderPatches()->importSinkKeyWithImportSinkKeyValue("importSinkKey")->importOperations()->withIdValue("id")->get()` -Retrieves the import operation with the given id. +Retrieves the ImportOperation of a given ID. ### Example @@ -297,7 +301,7 @@ $request = $builder ``` ## `withProjectKeyValue("projectKey")->orders()->importSinkKeyWithImportSinkKeyValue("importSinkKey")->post(null)` -Creates import request for creating new orders or updating existing ones. +Creates a request for creating new Orders or updating existing ones. ### Example ```php @@ -312,7 +316,8 @@ $request = $builder ``` ## `withProjectKeyValue("projectKey")->orders()->importSinkKeyWithImportSinkKeyValue("importSinkKey")->importOperations()->get()` -Retrieves all order import operations of an import sink key. +Retrieves all Order ImportOperations of a given ImportSink key. + ### Example ```php @@ -328,7 +333,7 @@ $request = $builder ``` ## `withProjectKeyValue("projectKey")->orders()->importSinkKeyWithImportSinkKeyValue("importSinkKey")->importOperations()->withIdValue("id")->get()` -Retrieves the import operation with the given id. +Retrieves the ImportOperation of a given ID. ### Example @@ -346,7 +351,7 @@ $request = $builder ``` ## `withProjectKeyValue("projectKey")->prices()->importSinkKeyWithImportSinkKeyValue("importSinkKey")->post(null)` -Creates import request for creating new prices or updating existing ones. +Creates a request for creating new Prices or updating existing ones. ### Example ```php @@ -361,7 +366,8 @@ $request = $builder ``` ## `withProjectKeyValue("projectKey")->prices()->importSinkKeyWithImportSinkKeyValue("importSinkKey")->importOperations()->get()` -Retrieves all price import operations of an import sink key. +Retrieves all Price ImportOperations of a given ImportSink key. + ### Example ```php @@ -377,7 +383,7 @@ $request = $builder ``` ## `withProjectKeyValue("projectKey")->prices()->importSinkKeyWithImportSinkKeyValue("importSinkKey")->importOperations()->withIdValue("id")->get()` -Retrieves the import operation with the given id. +Retrieves the ImportOperation of a given ID. ### Example @@ -395,7 +401,7 @@ $request = $builder ``` ## `withProjectKeyValue("projectKey")->productDrafts()->importSinkKeyWithImportSinkKeyValue("importSinkKey")->post(null)` -Creates import request for creating new product drafts or updating existing ones. +Creates a request for creating new ProductDrafts or updating existing ones. ### Example @@ -411,7 +417,8 @@ $request = $builder ``` ## `withProjectKeyValue("projectKey")->productDrafts()->importSinkKeyWithImportSinkKeyValue("importSinkKey")->importOperations()->get()` -Retrieves all import operations of an import sink key. +Retrieves all ProductDraft ImportOperations of a given ImportSink key. + ### Example ```php @@ -427,7 +434,7 @@ $request = $builder ``` ## `withProjectKeyValue("projectKey")->productDrafts()->importSinkKeyWithImportSinkKeyValue("importSinkKey")->importOperations()->withIdValue("id")->get()` -Retrieves the import operation with the given id. +Retrieves the ImportOperation of a given ID. ### Example @@ -445,7 +452,7 @@ $request = $builder ``` ## `withProjectKeyValue("projectKey")->productTypes()->importSinkKeyWithImportSinkKeyValue("importSinkKey")->post(null)` -Creates import request for creating new product types or updating existing ones. +Creates a request for creating new ProductTypes or updating existing ones. ### Example ```php @@ -460,7 +467,8 @@ $request = $builder ``` ## `withProjectKeyValue("projectKey")->productTypes()->importSinkKeyWithImportSinkKeyValue("importSinkKey")->importOperations()->get()` -Retrieves all import operations of an import sink key. +Retrieves all ProductType ImportOperations of a given ImportSink key. + ### Example ```php @@ -476,7 +484,7 @@ $request = $builder ``` ## `withProjectKeyValue("projectKey")->productTypes()->importSinkKeyWithImportSinkKeyValue("importSinkKey")->importOperations()->withIdValue("id")->get()` -Retrieves the import operation with the given id. +Retrieves the ImportOperation of a given ID. ### Example @@ -525,7 +533,7 @@ $request = $builder ``` ## `withProjectKeyValue("projectKey")->productVariantPatches()->importSinkKeyWithImportSinkKeyValue("importSinkKey")->importOperations()->withIdValue("id")->get()` -Retrieves the import operation with the given id. +Retrieves the ImportOperation of a given ID. ### Example @@ -543,7 +551,7 @@ $request = $builder ``` ## `withProjectKeyValue("projectKey")->productVariants()->importSinkKeyWithImportSinkKeyValue("importSinkKey")->post(null)` -Creates import request for creating new product variants or updating existing ones. +Creates a request for creating new ProductVariants or updating existing ones. ### Example ```php @@ -574,7 +582,7 @@ $request = $builder ``` ## `withProjectKeyValue("projectKey")->productVariants()->importSinkKeyWithImportSinkKeyValue("importSinkKey")->importOperations()->withIdValue("id")->get()` -Retrieves the import operation with the given id. +Retrieves the ImportOperation of a given ID. ### Example @@ -592,7 +600,7 @@ $request = $builder ``` ## `withProjectKeyValue("projectKey")->products()->importSinkKeyWithImportSinkKeyValue("importSinkKey")->post(null)` -Creates import request for creating new products or updating existing ones. +Creates a request for creating new Products or updating existing ones. ### Example ```php @@ -607,7 +615,8 @@ $request = $builder ``` ## `withProjectKeyValue("projectKey")->products()->importSinkKeyWithImportSinkKeyValue("importSinkKey")->importOperations()->get()` -Retrieves all product import operations of an import sink key. +Retrieves all Product ImportOperations of a given ImportSink key. + ### Example ```php @@ -623,7 +632,7 @@ $request = $builder ``` ## `withProjectKeyValue("projectKey")->products()->importSinkKeyWithImportSinkKeyValue("importSinkKey")->importOperations()->withIdValue("id")->get()` -Retrieves the import operation with the given id. +Retrieves the ImportOperation of a given ID. ### Example diff --git a/lib/commercetools-import/gen.properties b/lib/commercetools-import/gen.properties index ec3aae949cf..c99be4b063f 100644 --- a/lib/commercetools-import/gen.properties +++ b/lib/commercetools-import/gen.properties @@ -1 +1 @@ -hash=521347af873c8879ba5c9605af6a28958010c4e3 +hash=865999c5abbf6bec6c3de7c517305ed01ffda944 diff --git a/lib/commercetools-import/src/Models/Categories/CategoryImport.php b/lib/commercetools-import/src/Models/Categories/CategoryImport.php index 094e59613e0..6f92491565b 100644 --- a/lib/commercetools-import/src/Models/Categories/CategoryImport.php +++ b/lib/commercetools-import/src/Models/Categories/CategoryImport.php @@ -54,9 +54,8 @@ public function getDescription(); /** *

Maps to Category.parent. - * The parent category referenced must already exist - * in the commercetools project, or the import operation - * will have an Unresolved state.

+ * 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.

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

The custom fields for this category.

+ *

The custom fields for this Category.

* * @return null|Custom */ diff --git a/lib/commercetools-import/src/Models/Categories/CategoryImportBuilder.php b/lib/commercetools-import/src/Models/Categories/CategoryImportBuilder.php index 850daa8d797..47aff2c0010 100644 --- a/lib/commercetools-import/src/Models/Categories/CategoryImportBuilder.php +++ b/lib/commercetools-import/src/Models/Categories/CategoryImportBuilder.php @@ -130,9 +130,8 @@ public function getDescription() /** *

Maps to Category.parent. - * The parent category referenced must already exist - * in the commercetools project, or the import operation - * will have an Unresolved state.

+ * 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.

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

The custom fields for this category.

+ *

The custom fields for this Category.

* * @return null|Custom */ diff --git a/lib/commercetools-import/src/Models/Categories/CategoryImportModel.php b/lib/commercetools-import/src/Models/Categories/CategoryImportModel.php index 366fa9128cf..3c8df76ff88 100644 --- a/lib/commercetools-import/src/Models/Categories/CategoryImportModel.php +++ b/lib/commercetools-import/src/Models/Categories/CategoryImportModel.php @@ -200,9 +200,8 @@ public function getDescription() /** *

Maps to Category.parent. - * The parent category referenced must already exist - * in the commercetools project, or the import operation - * will have an Unresolved state.

+ * 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.

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

The custom fields for this category.

+ *

The custom fields for this Category.

* * @return null|Custom */ diff --git a/lib/commercetools-import/src/Models/Customers/CustomerAddress.php b/lib/commercetools-import/src/Models/Customers/CustomerAddress.php index 9397c3a174c..4cde9db8250 100644 --- a/lib/commercetools-import/src/Models/Customers/CustomerAddress.php +++ b/lib/commercetools-import/src/Models/Customers/CustomerAddress.php @@ -40,7 +40,7 @@ interface CustomerAddress extends JsonObject /** *

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

+ * Must follow the pattern [a-zA-Z0-9_-]{2,256} and 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 431d283c7d9..cf5cec28e0b 100644 --- a/lib/commercetools-import/src/Models/Customers/CustomerAddressBuilder.php +++ b/lib/commercetools-import/src/Models/Customers/CustomerAddressBuilder.php @@ -142,7 +142,7 @@ final class CustomerAddressBuilder implements Builder /** *

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

+ * Must follow the pattern [a-zA-Z0-9_-]{2,256} and 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 ffc19fac114..6a369edbe02 100644 --- a/lib/commercetools-import/src/Models/Customers/CustomerAddressModel.php +++ b/lib/commercetools-import/src/Models/Customers/CustomerAddressModel.php @@ -197,7 +197,7 @@ public function __construct( /** *

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

+ * Must follow the pattern [a-zA-Z0-9_-]{2,256} and 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 47ce63fa8a6..b9e80924841 100644 --- a/lib/commercetools-import/src/Models/Customers/CustomerImport.php +++ b/lib/commercetools-import/src/Models/Customers/CustomerImport.php @@ -63,10 +63,7 @@ public function getEmail(); public function getPassword(); /** - *

References stores by its keys.

- *

The stores referenced - * must already exist in the commercetools project, or the - * import operation state is set to Unresolved.

+ *

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.

* * @return null|StoreKeyReferenceCollection */ @@ -143,10 +140,8 @@ public function getVatId(); public function getIsEmailVerified(); /** - *

References a customer group by its key.

- *

The customer group referenced - * must already exist in the commercetools project, or the - * import operation state is set to Unresolved.

+ *

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.

* * @return null|CustomerGroupKeyReference */ diff --git a/lib/commercetools-import/src/Models/Customers/CustomerImportBuilder.php b/lib/commercetools-import/src/Models/Customers/CustomerImportBuilder.php index cce07dbbdf9..278bd140dea 100644 --- a/lib/commercetools-import/src/Models/Customers/CustomerImportBuilder.php +++ b/lib/commercetools-import/src/Models/Customers/CustomerImportBuilder.php @@ -182,10 +182,7 @@ public function getPassword() } /** - *

References stores by its keys.

- *

The stores referenced - * must already exist in the commercetools project, or the - * import operation state is set to Unresolved.

+ *

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.

* * @return null|StoreKeyReferenceCollection */ @@ -295,10 +292,8 @@ public function getIsEmailVerified() } /** - *

References a customer group by its key.

- *

The customer group referenced - * must already exist in the commercetools project, or the - * import operation state is set to Unresolved.

+ *

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.

* * @return null|CustomerGroupKeyReference */ diff --git a/lib/commercetools-import/src/Models/Customers/CustomerImportModel.php b/lib/commercetools-import/src/Models/Customers/CustomerImportModel.php index 186ff4100ad..3666e6d39a1 100644 --- a/lib/commercetools-import/src/Models/Customers/CustomerImportModel.php +++ b/lib/commercetools-import/src/Models/Customers/CustomerImportModel.php @@ -271,10 +271,7 @@ public function getPassword() } /** - *

References stores by its keys.

- *

The stores referenced - * must already exist in the commercetools project, or the - * import operation state is set to Unresolved.

+ *

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.

* * @return null|StoreKeyReferenceCollection */ @@ -487,10 +484,8 @@ public function getIsEmailVerified() } /** - *

References a customer group by its key.

- *

The customer group referenced - * must already exist in the commercetools project, or the - * import operation state is set to Unresolved.

+ *

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.

* * @return null|CustomerGroupKeyReference */ diff --git a/lib/commercetools-import/src/Models/Errors/InvalidStateTransitionError.php b/lib/commercetools-import/src/Models/Errors/InvalidStateTransitionError.php index 00e893f56ef..23a74065ca1 100644 --- a/lib/commercetools-import/src/Models/Errors/InvalidStateTransitionError.php +++ b/lib/commercetools-import/src/Models/Errors/InvalidStateTransitionError.php @@ -17,14 +17,14 @@ interface InvalidStateTransitionError extends ErrorObject public const FIELD_NEW_STATE = 'newState'; /** - *

This enumeration describes the processing state of an import operation.

+ *

Represents the status of a resource under an import process. Every resource has the initial state Unresolved.

* * @return null|string */ public function getCurrentState(); /** - *

This enumeration describes the processing state of an import operation.

+ *

Represents the status of a resource under an import process. Every resource has the initial state Unresolved.

* * @return null|string */ diff --git a/lib/commercetools-import/src/Models/Errors/InvalidStateTransitionErrorBuilder.php b/lib/commercetools-import/src/Models/Errors/InvalidStateTransitionErrorBuilder.php index 228a66e9e02..dcf8010ba54 100644 --- a/lib/commercetools-import/src/Models/Errors/InvalidStateTransitionErrorBuilder.php +++ b/lib/commercetools-import/src/Models/Errors/InvalidStateTransitionErrorBuilder.php @@ -44,7 +44,7 @@ public function getMessage() } /** - *

This enumeration describes the processing state of an import operation.

+ *

Represents the status of a resource under an import process. Every resource has the initial state Unresolved.

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

This enumeration describes the processing state of an import operation.

+ *

Represents the status of a resource under an import process. Every resource has the initial state Unresolved.

* * @return null|string */ diff --git a/lib/commercetools-import/src/Models/Errors/InvalidStateTransitionErrorModel.php b/lib/commercetools-import/src/Models/Errors/InvalidStateTransitionErrorModel.php index 118654174c4..c4df541be43 100644 --- a/lib/commercetools-import/src/Models/Errors/InvalidStateTransitionErrorModel.php +++ b/lib/commercetools-import/src/Models/Errors/InvalidStateTransitionErrorModel.php @@ -90,7 +90,7 @@ public function getMessage() } /** - *

This enumeration describes the processing state of an import operation.

+ *

Represents the status of a resource under an import process. Every resource has the initial state Unresolved.

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

This enumeration describes the processing state of an import operation.

+ *

Represents the status of a resource under an import process. Every resource has the initial state Unresolved.

* * @return null|string */ diff --git a/lib/commercetools-import/src/Models/Importoperations/ImportOperation.php b/lib/commercetools-import/src/Models/Importoperations/ImportOperation.php index 7e81c76e15b..ba5f76f2aad 100644 --- a/lib/commercetools-import/src/Models/Importoperations/ImportOperation.php +++ b/lib/commercetools-import/src/Models/Importoperations/ImportOperation.php @@ -27,71 +27,70 @@ interface ImportOperation extends JsonObject public const FIELD_EXPIRES_AT = 'expiresAt'; /** - *

The import operation version.

+ *

The version of the ImportOperation.

* * @return null|int */ public function getVersion(); /** - *

The key of the import sink.

+ *

The key of the ImportSink.

* * @return null|string */ public function getImportSinkKey(); /** - *

The key of the import resource.

+ *

The key of the resource.

* * @return null|string */ public function getResourceKey(); /** - *

The identifier of the operaton that is to be commited

+ *

The ID of the ImportOperation.

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

The status of the import resource.

+ *

The import status of the resource. Set to Rejected or ValidationFailed if the import of the resource was not successful.

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

When the resource is successfully imported, this represents the imported resource version

+ *

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

* * @return null|int */ public function getResourceVersion(); /** - *

If an import resource does not import correctly, the state is set to Rejected or ValidationFailed - * and this property contains the errors.

+ *

Contains an error if the import of the resource was not successful. See Errors.

* * @return null|ErrorObjectCollection */ public function getErrors(); /** - *

When the import operation was created.

+ *

The time when the ImportOperation was created.

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

When the import operation was modified.

+ *

The last time When the ImportOperation was modified.

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

When the import operation expires.

+ *

The expiration time of the ImportOperation.

* * @return null|DateTimeImmutable */ diff --git a/lib/commercetools-import/src/Models/Importoperations/ImportOperationBuilder.php b/lib/commercetools-import/src/Models/Importoperations/ImportOperationBuilder.php index 3982e2ecb46..22230fd052b 100644 --- a/lib/commercetools-import/src/Models/Importoperations/ImportOperationBuilder.php +++ b/lib/commercetools-import/src/Models/Importoperations/ImportOperationBuilder.php @@ -73,7 +73,7 @@ final class ImportOperationBuilder implements Builder private $expiresAt; /** - *

The import operation version.

+ *

The version of the ImportOperation.

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

The key of the import sink.

+ *

The key of the ImportSink.

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

The key of the import resource.

+ *

The key of the resource.

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

The identifier of the operaton that is to be commited

+ *

The ID of the ImportOperation.

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

The status of the import resource.

+ *

The import status of the resource. Set to Rejected or ValidationFailed if the import of the resource was not successful.

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

When the resource is successfully imported, this represents the imported resource version

+ *

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

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

If an import resource does not import correctly, the state is set to Rejected or ValidationFailed - * and this property contains the errors.

+ *

Contains an error if the import of the resource was not successful. See Errors.

* * @return null|ErrorObjectCollection */ @@ -144,7 +143,7 @@ public function getErrors() } /** - *

When the import operation was created.

+ *

The time when the ImportOperation was created.

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

When the import operation was modified.

+ *

The last time When the ImportOperation was modified.

* * @return null|DateTimeImmutable */ @@ -164,7 +163,7 @@ public function getLastModifiedAt() } /** - *

When the import operation expires.

+ *

The expiration time of the ImportOperation.

* * @return null|DateTimeImmutable */ diff --git a/lib/commercetools-import/src/Models/Importoperations/ImportOperationModel.php b/lib/commercetools-import/src/Models/Importoperations/ImportOperationModel.php index a24e567ec53..eca88dfc890 100644 --- a/lib/commercetools-import/src/Models/Importoperations/ImportOperationModel.php +++ b/lib/commercetools-import/src/Models/Importoperations/ImportOperationModel.php @@ -100,7 +100,7 @@ public function __construct( } /** - *

The import operation version.

+ *

The version of the ImportOperation.

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

The key of the import sink.

+ *

The key of the ImportSink.

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

The key of the import resource.

+ *

The key of the resource.

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

The identifier of the operaton that is to be commited

+ *

The ID of the ImportOperation.

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

The status of the import resource.

+ *

The import status of the resource. Set to Rejected or ValidationFailed if the import of the resource was not successful.

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

When the resource is successfully imported, this represents the imported resource version

+ *

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

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

If an import resource does not import correctly, the state is set to Rejected or ValidationFailed - * and this property contains the errors.

+ *

Contains an error if the import of the resource was not successful. See Errors.

* * @return null|ErrorObjectCollection */ @@ -234,7 +233,7 @@ public function getErrors() } /** - *

When the import operation was created.

+ *

The time when the ImportOperation was created.

* * @return null|DateTimeImmutable */ @@ -257,7 +256,7 @@ public function getCreatedAt() } /** - *

When the import operation was modified.

+ *

The last time When the ImportOperation was modified.

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

When the import operation expires.

+ *

The expiration time of the ImportOperation.

* * @return null|DateTimeImmutable */ diff --git a/lib/commercetools-import/src/Models/Importoperations/ImportOperationPagedResponse.php b/lib/commercetools-import/src/Models/Importoperations/ImportOperationPagedResponse.php index 5299cc33718..caa6f7496b6 100644 --- a/lib/commercetools-import/src/Models/Importoperations/ImportOperationPagedResponse.php +++ b/lib/commercetools-import/src/Models/Importoperations/ImportOperationPagedResponse.php @@ -19,28 +19,29 @@ interface ImportOperationPagedResponse extends JsonObject public const FIELD_RESULTS = 'results'; /** - *

The maximum number of import operations returned for a page.

+ *

The number of results requested in the query request.

* * @return null|int */ public function getLimit(); /** - *

The offset supplied by the client or the server default. It is the number of elements skipped.

+ *

The number of elements skipped, not a page number. + * Supplied by the client or the server default.

* * @return null|int */ public function getOffset(); /** - *

The actual number of results returned by this response.

+ *

The actual number of results returned.

* * @return null|int */ public function getCount(); /** - *

The results for this paged response.

+ *

The array of Import Operations matching the query.

* * @return null|ImportOperationCollection */ diff --git a/lib/commercetools-import/src/Models/Importoperations/ImportOperationPagedResponseBuilder.php b/lib/commercetools-import/src/Models/Importoperations/ImportOperationPagedResponseBuilder.php index 2f67edc3810..04f7ed8124d 100644 --- a/lib/commercetools-import/src/Models/Importoperations/ImportOperationPagedResponseBuilder.php +++ b/lib/commercetools-import/src/Models/Importoperations/ImportOperationPagedResponseBuilder.php @@ -41,7 +41,7 @@ final class ImportOperationPagedResponseBuilder implements Builder private $results; /** - *

The maximum number of import operations returned for a page.

+ *

The number of results requested in the query request.

* * @return null|int */ @@ -51,7 +51,8 @@ public function getLimit() } /** - *

The offset supplied by the client or the server default. It is the number of elements skipped.

+ *

The number of elements skipped, not a page number. + * Supplied by the client or the server default.

* * @return null|int */ @@ -61,7 +62,7 @@ public function getOffset() } /** - *

The actual number of results returned by this response.

+ *

The actual number of results returned.

* * @return null|int */ @@ -71,7 +72,7 @@ public function getCount() } /** - *

The results for this paged response.

+ *

The array of Import Operations matching the query.

* * @return null|ImportOperationCollection */ diff --git a/lib/commercetools-import/src/Models/Importoperations/ImportOperationPagedResponseModel.php b/lib/commercetools-import/src/Models/Importoperations/ImportOperationPagedResponseModel.php index 3b4949c9bf4..1663dfbbd23 100644 --- a/lib/commercetools-import/src/Models/Importoperations/ImportOperationPagedResponseModel.php +++ b/lib/commercetools-import/src/Models/Importoperations/ImportOperationPagedResponseModel.php @@ -56,7 +56,7 @@ public function __construct( } /** - *

The maximum number of import operations returned for a page.

+ *

The number of results requested in the query request.

* * @return null|int */ @@ -75,7 +75,8 @@ public function getLimit() } /** - *

The offset supplied by the client or the server default. It is the number of elements skipped.

+ *

The number of elements skipped, not a page number. + * Supplied by the client or the server default.

* * @return null|int */ @@ -94,7 +95,7 @@ public function getOffset() } /** - *

The actual number of results returned by this response.

+ *

The actual number of results returned.

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

The results for this paged response.

+ *

The array of Import Operations matching the query.

* * @return null|ImportOperationCollection */ diff --git a/lib/commercetools-import/src/Models/Importoperations/ImportOperationStatus.php b/lib/commercetools-import/src/Models/Importoperations/ImportOperationStatus.php index a6e2468f808..45aad1511c2 100644 --- a/lib/commercetools-import/src/Models/Importoperations/ImportOperationStatus.php +++ b/lib/commercetools-import/src/Models/Importoperations/ImportOperationStatus.php @@ -19,21 +19,22 @@ interface ImportOperationStatus extends JsonObject public const FIELD_ERRORS = 'errors'; /** - *

Id of the import operation.

+ *

The ID of the ImportOperation.

* * @return null|string */ public function getOperationId(); /** - *

Validation state of the import operation.

+ *

The validation state of the ImportOperation.

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

Validation errors for the import operation.

+ *

The validation errors for the ImportOperation. + * See Errors.

* * @return null|ErrorObjectCollection */ diff --git a/lib/commercetools-import/src/Models/Importoperations/ImportOperationStatusBuilder.php b/lib/commercetools-import/src/Models/Importoperations/ImportOperationStatusBuilder.php index 1e83cf33c8a..17b90bbc7fc 100644 --- a/lib/commercetools-import/src/Models/Importoperations/ImportOperationStatusBuilder.php +++ b/lib/commercetools-import/src/Models/Importoperations/ImportOperationStatusBuilder.php @@ -37,7 +37,7 @@ final class ImportOperationStatusBuilder implements Builder private $errors; /** - *

Id of the import operation.

+ *

The ID of the ImportOperation.

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

Validation state of the import operation.

+ *

The validation state of the ImportOperation.

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

Validation errors for the import operation.

+ *

The validation errors for the ImportOperation. + * See Errors.

* * @return null|ErrorObjectCollection */ diff --git a/lib/commercetools-import/src/Models/Importoperations/ImportOperationStatusModel.php b/lib/commercetools-import/src/Models/Importoperations/ImportOperationStatusModel.php index f3576afc906..e93f0d6c269 100644 --- a/lib/commercetools-import/src/Models/Importoperations/ImportOperationStatusModel.php +++ b/lib/commercetools-import/src/Models/Importoperations/ImportOperationStatusModel.php @@ -50,7 +50,7 @@ public function __construct( } /** - *

Id of the import operation.

+ *

The ID of the ImportOperation.

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

Validation state of the import operation.

+ *

The validation state of the ImportOperation.

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

Validation errors for the import operation.

+ *

The validation errors for the ImportOperation. + * See Errors.

* * @return null|ErrorObjectCollection */ diff --git a/lib/commercetools-import/src/Models/Importsinks/ImportSink.php b/lib/commercetools-import/src/Models/Importsinks/ImportSink.php index 1e50b1631f9..75ea1e60c88 100644 --- a/lib/commercetools-import/src/Models/Importsinks/ImportSink.php +++ b/lib/commercetools-import/src/Models/Importsinks/ImportSink.php @@ -21,37 +21,38 @@ interface ImportSink extends JsonObject public const FIELD_LAST_MODIFIED_AT = 'lastModifiedAt'; /** - *

The unique key of the import sink.

- *

Valid characters are: alphabetic characters (A-Z, a-z), numeric characters (0-9), underscores (_) and hyphens (-).

+ *

User-defined unique identifier for the ImportSink. + * Keys can only contain alphanumeric characters (a-Z, 0-9), underscores and hyphens (_, -).

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

The type of import resource sent to this import sink. - * You can only send one resource type per import sink.

+ *

The resource type to be imported. + * Only the resources of this type can be imported through this ImportSink. + * See ImportResourceType.

* * @return null|string */ public function getResourceType(); /** - *

The version of this resource.

+ *

The version of the ImportSink.

* * @return null|int */ public function getVersion(); /** - *

When the import sink was created.

+ *

The time when the ImportSink was created.

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

When the import sink was modified.

+ *

The last time when the ImportSink was modified.

* * @return null|DateTimeImmutable */ diff --git a/lib/commercetools-import/src/Models/Importsinks/ImportSinkBuilder.php b/lib/commercetools-import/src/Models/Importsinks/ImportSinkBuilder.php index caa4a25bd84..02b964d773c 100644 --- a/lib/commercetools-import/src/Models/Importsinks/ImportSinkBuilder.php +++ b/lib/commercetools-import/src/Models/Importsinks/ImportSinkBuilder.php @@ -47,8 +47,8 @@ final class ImportSinkBuilder implements Builder private $lastModifiedAt; /** - *

The unique key of the import sink.

- *

Valid characters are: alphabetic characters (A-Z, a-z), numeric characters (0-9), underscores (_) and hyphens (-).

+ *

User-defined unique identifier for the ImportSink. + * Keys can only contain alphanumeric characters (a-Z, 0-9), underscores and hyphens (_, -).

* * @return null|string */ @@ -58,8 +58,9 @@ public function getKey() } /** - *

The type of import resource sent to this import sink. - * You can only send one resource type per import sink.

+ *

The resource type to be imported. + * Only the resources of this type can be imported through this ImportSink. + * See ImportResourceType.

* * @return null|string */ @@ -69,7 +70,7 @@ public function getResourceType() } /** - *

The version of this resource.

+ *

The version of the ImportSink.

* * @return null|int */ @@ -79,7 +80,7 @@ public function getVersion() } /** - *

When the import sink was created.

+ *

The time when the ImportSink was created.

* * @return null|DateTimeImmutable */ @@ -89,7 +90,7 @@ public function getCreatedAt() } /** - *

When the import sink was modified.

+ *

The last time when the ImportSink was modified.

* * @return null|DateTimeImmutable */ diff --git a/lib/commercetools-import/src/Models/Importsinks/ImportSinkDraft.php b/lib/commercetools-import/src/Models/Importsinks/ImportSinkDraft.php index 4a19414a362..edea25411e0 100644 --- a/lib/commercetools-import/src/Models/Importsinks/ImportSinkDraft.php +++ b/lib/commercetools-import/src/Models/Importsinks/ImportSinkDraft.php @@ -18,21 +18,24 @@ interface ImportSinkDraft extends JsonObject public const FIELD_RESOURCE_TYPE = 'resourceType'; /** - *

The version of this resource.

+ *

The version of the ImportSinkDraft.

* * @return null|int */ public function getVersion(); /** - *

The unique key of the import sink.

+ *

User-defined unique identifier of the ImportSink. + * Keys can only contain alphanumeric characters (a-Z, 0-9), underscores and hyphens (_, -).

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

The type of import resource sent to this import sink.

+ *

The resource type to be imported. + * Only the resources of this type can be imported through this ImportSink. + * See ImportResourceType.

* * @return null|string */ diff --git a/lib/commercetools-import/src/Models/Importsinks/ImportSinkDraftBuilder.php b/lib/commercetools-import/src/Models/Importsinks/ImportSinkDraftBuilder.php index b533787d70e..ee4bd8a09a1 100644 --- a/lib/commercetools-import/src/Models/Importsinks/ImportSinkDraftBuilder.php +++ b/lib/commercetools-import/src/Models/Importsinks/ImportSinkDraftBuilder.php @@ -36,7 +36,7 @@ final class ImportSinkDraftBuilder implements Builder private $resourceType; /** - *

The version of this resource.

+ *

The version of the ImportSinkDraft.

* * @return null|int */ @@ -46,7 +46,8 @@ public function getVersion() } /** - *

The unique key of the import sink.

+ *

User-defined unique identifier of the ImportSink. + * Keys can only contain alphanumeric characters (a-Z, 0-9), underscores and hyphens (_, -).

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

The type of import resource sent to this import sink.

+ *

The resource type to be imported. + * Only the resources of this type can be imported through this ImportSink. + * See ImportResourceType.

* * @return null|string */ diff --git a/lib/commercetools-import/src/Models/Importsinks/ImportSinkDraftModel.php b/lib/commercetools-import/src/Models/Importsinks/ImportSinkDraftModel.php index f373ce26fad..5826efa2653 100644 --- a/lib/commercetools-import/src/Models/Importsinks/ImportSinkDraftModel.php +++ b/lib/commercetools-import/src/Models/Importsinks/ImportSinkDraftModel.php @@ -49,7 +49,7 @@ public function __construct( } /** - *

The version of this resource.

+ *

The version of the ImportSinkDraft.

* * @return null|int */ @@ -68,7 +68,8 @@ public function getVersion() } /** - *

The unique key of the import sink.

+ *

User-defined unique identifier of the ImportSink. + * Keys can only contain alphanumeric characters (a-Z, 0-9), underscores and hyphens (_, -).

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

The type of import resource sent to this import sink.

+ *

The resource type to be imported. + * Only the resources of this type can be imported through this ImportSink. + * See ImportResourceType.

* * @return null|string */ diff --git a/lib/commercetools-import/src/Models/Importsinks/ImportSinkModel.php b/lib/commercetools-import/src/Models/Importsinks/ImportSinkModel.php index 41f8e0aa721..6692bcc8e10 100644 --- a/lib/commercetools-import/src/Models/Importsinks/ImportSinkModel.php +++ b/lib/commercetools-import/src/Models/Importsinks/ImportSinkModel.php @@ -64,8 +64,8 @@ public function __construct( } /** - *

The unique key of the import sink.

- *

Valid characters are: alphabetic characters (A-Z, a-z), numeric characters (0-9), underscores (_) and hyphens (-).

+ *

User-defined unique identifier for the ImportSink. + * Keys can only contain alphanumeric characters (a-Z, 0-9), underscores and hyphens (_, -).

* * @return null|string */ @@ -84,8 +84,9 @@ public function getKey() } /** - *

The type of import resource sent to this import sink. - * You can only send one resource type per import sink.

+ *

The resource type to be imported. + * Only the resources of this type can be imported through this ImportSink. + * See ImportResourceType.

* * @return null|string */ @@ -104,7 +105,7 @@ public function getResourceType() } /** - *

The version of this resource.

+ *

The version of the ImportSink.

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

When the import sink was created.

+ *

The time when the ImportSink was created.

* * @return null|DateTimeImmutable */ @@ -146,7 +147,7 @@ public function getCreatedAt() } /** - *

When the import sink was modified.

+ *

The last time when the ImportSink was modified.

* * @return null|DateTimeImmutable */ diff --git a/lib/commercetools-import/src/Models/Importsinks/ImportSinkPagedResponse.php b/lib/commercetools-import/src/Models/Importsinks/ImportSinkPagedResponse.php index 769fc4098f1..27bb9d6862b 100644 --- a/lib/commercetools-import/src/Models/Importsinks/ImportSinkPagedResponse.php +++ b/lib/commercetools-import/src/Models/Importsinks/ImportSinkPagedResponse.php @@ -20,21 +20,22 @@ interface ImportSinkPagedResponse extends JsonObject public const FIELD_RESULTS = 'results'; /** - *

The maximum number of import operations returned for a page.

+ *

The number of results requested in the query request.

* * @return null|int */ public function getLimit(); /** - *

The offset supplied by the client or the server default. It is the number of elements skipped.

+ *

The number of elements skipped, not a page number. + * Supplied by the client or the server default.

* * @return null|int */ public function getOffset(); /** - *

The actual number of results returned by this response.

+ *

The actual number of results returned.

* * @return null|int */ @@ -48,7 +49,7 @@ public function getCount(); public function getTotal(); /** - *

The results for this paged response.

+ *

The array of Import Sinks matching the query.

* * @return null|ImportSinkCollection */ diff --git a/lib/commercetools-import/src/Models/Importsinks/ImportSinkPagedResponseBuilder.php b/lib/commercetools-import/src/Models/Importsinks/ImportSinkPagedResponseBuilder.php index 46d61cc6d2b..0bbf93cdddd 100644 --- a/lib/commercetools-import/src/Models/Importsinks/ImportSinkPagedResponseBuilder.php +++ b/lib/commercetools-import/src/Models/Importsinks/ImportSinkPagedResponseBuilder.php @@ -46,7 +46,7 @@ final class ImportSinkPagedResponseBuilder implements Builder private $results; /** - *

The maximum number of import operations returned for a page.

+ *

The number of results requested in the query request.

* * @return null|int */ @@ -56,7 +56,8 @@ public function getLimit() } /** - *

The offset supplied by the client or the server default. It is the number of elements skipped.

+ *

The number of elements skipped, not a page number. + * Supplied by the client or the server default.

* * @return null|int */ @@ -66,7 +67,7 @@ public function getOffset() } /** - *

The actual number of results returned by this response.

+ *

The actual number of results returned.

* * @return null|int */ @@ -86,7 +87,7 @@ public function getTotal() } /** - *

The results for this paged response.

+ *

The array of Import Sinks matching the query.

* * @return null|ImportSinkCollection */ diff --git a/lib/commercetools-import/src/Models/Importsinks/ImportSinkPagedResponseModel.php b/lib/commercetools-import/src/Models/Importsinks/ImportSinkPagedResponseModel.php index 852db79c748..d8218aa58b0 100644 --- a/lib/commercetools-import/src/Models/Importsinks/ImportSinkPagedResponseModel.php +++ b/lib/commercetools-import/src/Models/Importsinks/ImportSinkPagedResponseModel.php @@ -63,7 +63,7 @@ public function __construct( } /** - *

The maximum number of import operations returned for a page.

+ *

The number of results requested in the query request.

* * @return null|int */ @@ -82,7 +82,8 @@ public function getLimit() } /** - *

The offset supplied by the client or the server default. It is the number of elements skipped.

+ *

The number of elements skipped, not a page number. + * Supplied by the client or the server default.

* * @return null|int */ @@ -101,7 +102,7 @@ public function getOffset() } /** - *

The actual number of results returned by this response.

+ *

The actual number of results returned.

* * @return null|int */ @@ -139,7 +140,7 @@ public function getTotal() } /** - *

The results for this paged response.

+ *

The array of Import Sinks matching the query.

* * @return null|ImportSinkCollection */ diff --git a/lib/commercetools-import/src/Models/Importsummaries/ImportSummary.php b/lib/commercetools-import/src/Models/Importsummaries/ImportSummary.php index b50c7be9a44..2e62fe386d5 100644 --- a/lib/commercetools-import/src/Models/Importsummaries/ImportSummary.php +++ b/lib/commercetools-import/src/Models/Importsummaries/ImportSummary.php @@ -17,14 +17,14 @@ interface ImportSummary extends JsonObject public const FIELD_TOTAL = 'total'; /** - *

The states summary for this import summary.

+ *

The import status of an ImportSink given by the number of resources in each Processing State.

* * @return null|OperationStates */ public function getStates(); /** - *

The total number of import operations received for this import group.

+ *

The total number of ImportOperations received for this Import Summary.

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

The states summary for this import summary.

+ *

The import status of an ImportSink given by the number of resources in each Processing State.

* * @return null|OperationStates */ @@ -41,7 +41,7 @@ public function getStates() } /** - *

The total number of import operations received for this import group.

+ *

The total number of ImportOperations received for this Import Summary.

* * @return null|int */ diff --git a/lib/commercetools-import/src/Models/Importsummaries/ImportSummaryModel.php b/lib/commercetools-import/src/Models/Importsummaries/ImportSummaryModel.php index 2e5add9cb1c..29fd57a34b1 100644 --- a/lib/commercetools-import/src/Models/Importsummaries/ImportSummaryModel.php +++ b/lib/commercetools-import/src/Models/Importsummaries/ImportSummaryModel.php @@ -42,7 +42,7 @@ public function __construct( } /** - *

The states summary for this import summary.

+ *

The import status of an ImportSink given by the number of resources in each Processing State.

* * @return null|OperationStates */ @@ -62,7 +62,7 @@ public function getStates() } /** - *

The total number of import operations received for this import group.

+ *

The total number of ImportOperations received for this Import Summary.

* * @return null|int */ diff --git a/lib/commercetools-import/src/Models/Importsummaries/OperationStates.php b/lib/commercetools-import/src/Models/Importsummaries/OperationStates.php index 0f66983292b..679a9210d66 100644 --- a/lib/commercetools-import/src/Models/Importsummaries/OperationStates.php +++ b/lib/commercetools-import/src/Models/Importsummaries/OperationStates.php @@ -20,35 +20,35 @@ interface OperationStates extends JsonObject public const FIELD_REJECTED = 'Rejected'; /** - *

The number of import operations that are in the state ValidationFailed.

+ *

The number of resources in the ValidationFailed state.

* * @return null|int */ public function getValidationFailed(); /** - *

The number of import operations that are in the state Unresolved.

+ *

The number of resources in the Unresolved state.

* * @return null|int */ public function getUnresolved(); /** - *

The number of import operations that are in the state WaitForMasterVariant.

+ *

The number of resources in the WaitForMasterVariant state.

* * @return null|int */ public function getWaitForMasterVariant(); /** - *

The number of import operations that are in the state Imported.

+ *

The number of resources in the Imported state.

* * @return null|int */ public function getImported(); /** - *

The number of import operations that are in the state Rejected.

+ *

The number of resources in the Rejected 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 7800f8d39e3..47b282d5fa8 100644 --- a/lib/commercetools-import/src/Models/Importsummaries/OperationStatesBuilder.php +++ b/lib/commercetools-import/src/Models/Importsummaries/OperationStatesBuilder.php @@ -46,7 +46,7 @@ final class OperationStatesBuilder implements Builder private $Rejected; /** - *

The number of import operations that are in the state ValidationFailed.

+ *

The number of resources in the ValidationFailed state.

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

The number of import operations that are in the state Unresolved.

+ *

The number of resources in the Unresolved state.

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

The number of import operations that are in the state WaitForMasterVariant.

+ *

The number of resources in the WaitForMasterVariant state.

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

The number of import operations that are in the state Imported.

+ *

The number of resources in the Imported state.

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

The number of import operations that are in the state Rejected.

+ *

The number of resources in the Rejected 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 316ce36b820..35aa64d342a 100644 --- a/lib/commercetools-import/src/Models/Importsummaries/OperationStatesModel.php +++ b/lib/commercetools-import/src/Models/Importsummaries/OperationStatesModel.php @@ -63,7 +63,7 @@ public function __construct( } /** - *

The number of import operations that are in the state ValidationFailed.

+ *

The number of resources in the ValidationFailed state.

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

The number of import operations that are in the state Unresolved.

+ *

The number of resources in the Unresolved state.

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

The number of import operations that are in the state WaitForMasterVariant.

+ *

The number of resources in the WaitForMasterVariant state.

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

The number of import operations that are in the state Imported.

+ *

The number of resources in the Imported state.

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

The number of import operations that are in the state Rejected.

+ *

The number of resources in the Rejected state.

* * @return null|int */ diff --git a/lib/commercetools-import/src/Models/Orders/CustomLineItemDraft.php b/lib/commercetools-import/src/Models/Orders/CustomLineItemDraft.php index 593eb481912..93c311a9249 100644 --- a/lib/commercetools-import/src/Models/Orders/CustomLineItemDraft.php +++ b/lib/commercetools-import/src/Models/Orders/CustomLineItemDraft.php @@ -43,6 +43,8 @@ interface CustomLineItemDraft extends JsonObject public function getName(); /** + *

TypedMoney is what is called BaseMoney in the HTTP API.

+ * * @return null|TypedMoney */ public function getMoney(); @@ -53,6 +55,8 @@ public function getMoney(); public function getTaxedPrice(); /** + *

TypedMoney is what is called BaseMoney in the HTTP API.

+ * * @return null|TypedMoney */ public function getTotalPrice(); diff --git a/lib/commercetools-import/src/Models/Orders/CustomLineItemDraftBuilder.php b/lib/commercetools-import/src/Models/Orders/CustomLineItemDraftBuilder.php index fba55165db8..a85f3d4ef59 100644 --- a/lib/commercetools-import/src/Models/Orders/CustomLineItemDraftBuilder.php +++ b/lib/commercetools-import/src/Models/Orders/CustomLineItemDraftBuilder.php @@ -104,6 +104,8 @@ public function getName() } /** + *

TypedMoney is what is called BaseMoney in the HTTP API.

+ * * @return null|TypedMoney */ public function getMoney() @@ -120,6 +122,8 @@ public function getTaxedPrice() } /** + *

TypedMoney is what is called BaseMoney in the HTTP API.

+ * * @return null|TypedMoney */ public function getTotalPrice() diff --git a/lib/commercetools-import/src/Models/Orders/CustomLineItemDraftModel.php b/lib/commercetools-import/src/Models/Orders/CustomLineItemDraftModel.php index c0bd42789c1..7e86f9f9771 100644 --- a/lib/commercetools-import/src/Models/Orders/CustomLineItemDraftModel.php +++ b/lib/commercetools-import/src/Models/Orders/CustomLineItemDraftModel.php @@ -145,6 +145,8 @@ public function getName() } /** + *

TypedMoney is what is called BaseMoney in the HTTP API.

+ * * @return null|TypedMoney */ public function getMoney() @@ -181,6 +183,8 @@ public function getTaxedPrice() } /** + *

TypedMoney is what is called BaseMoney in the HTTP API.

+ * * @return null|TypedMoney */ public function getTotalPrice() diff --git a/lib/commercetools-import/src/Models/Orders/CustomLineItemTaxedPrice.php b/lib/commercetools-import/src/Models/Orders/CustomLineItemTaxedPrice.php index 1360b9a3849..d6353cfcb90 100644 --- a/lib/commercetools-import/src/Models/Orders/CustomLineItemTaxedPrice.php +++ b/lib/commercetools-import/src/Models/Orders/CustomLineItemTaxedPrice.php @@ -18,11 +18,15 @@ interface CustomLineItemTaxedPrice extends JsonObject public const FIELD_TOTAL_GROSS = 'totalGross'; /** + *

TypedMoney is what is called BaseMoney in the HTTP API.

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

TypedMoney is what is called BaseMoney in the HTTP API.

+ * * @return null|TypedMoney */ public function getTotalGross(); diff --git a/lib/commercetools-import/src/Models/Orders/CustomLineItemTaxedPriceBuilder.php b/lib/commercetools-import/src/Models/Orders/CustomLineItemTaxedPriceBuilder.php index 1ac0287eb90..89c7a73f7b2 100644 --- a/lib/commercetools-import/src/Models/Orders/CustomLineItemTaxedPriceBuilder.php +++ b/lib/commercetools-import/src/Models/Orders/CustomLineItemTaxedPriceBuilder.php @@ -33,6 +33,8 @@ final class CustomLineItemTaxedPriceBuilder implements Builder private $totalGross; /** + *

TypedMoney is what is called BaseMoney in the HTTP API.

+ * * @return null|TypedMoney */ public function getTotalNet() @@ -41,6 +43,8 @@ public function getTotalNet() } /** + *

TypedMoney is what is called BaseMoney in the HTTP API.

+ * * @return null|TypedMoney */ public function getTotalGross() diff --git a/lib/commercetools-import/src/Models/Orders/CustomLineItemTaxedPriceModel.php b/lib/commercetools-import/src/Models/Orders/CustomLineItemTaxedPriceModel.php index 39335ca0640..eb671e78bc6 100644 --- a/lib/commercetools-import/src/Models/Orders/CustomLineItemTaxedPriceModel.php +++ b/lib/commercetools-import/src/Models/Orders/CustomLineItemTaxedPriceModel.php @@ -44,6 +44,8 @@ public function __construct( } /** + *

TypedMoney is what is called BaseMoney in the HTTP API.

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

TypedMoney is what is called BaseMoney in the HTTP API.

+ * * @return null|TypedMoney */ public function getTotalGross() diff --git a/lib/commercetools-import/src/Models/Orders/LineItemImportDraft.php b/lib/commercetools-import/src/Models/Orders/LineItemImportDraft.php index 8037674b8b8..9d3db063878 100644 --- a/lib/commercetools-import/src/Models/Orders/LineItemImportDraft.php +++ b/lib/commercetools-import/src/Models/Orders/LineItemImportDraft.php @@ -69,20 +69,18 @@ public function getQuantity(); public function getState(); /** - *

References a supply channel. Maps to LineItem.supplyChannel.

- *

The supply channel referenced must already exist - * in the commercetools project, or the - * import operation state is set to Unresolved.

+ *

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.

* * @return null|ChannelKeyReference */ public function getSupplyChannel(); /** - *

References a distribution channel. Maps to LineItem.distributionChannel.

- *

The distribution channel referenced must already exist - * in the commercetools project, or the - * import operation state is set to Unresolved.

+ *

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.

* * @return null|ChannelKeyReference */ diff --git a/lib/commercetools-import/src/Models/Orders/LineItemImportDraftBuilder.php b/lib/commercetools-import/src/Models/Orders/LineItemImportDraftBuilder.php index d6fb86339f0..d81997362c5 100644 --- a/lib/commercetools-import/src/Models/Orders/LineItemImportDraftBuilder.php +++ b/lib/commercetools-import/src/Models/Orders/LineItemImportDraftBuilder.php @@ -137,10 +137,9 @@ public function getState() } /** - *

References a supply channel. Maps to LineItem.supplyChannel.

- *

The supply channel referenced must already exist - * in the commercetools project, or the - * import operation state is set to Unresolved.

+ *

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.

* * @return null|ChannelKeyReference */ @@ -150,10 +149,9 @@ public function getSupplyChannel() } /** - *

References a distribution channel. Maps to LineItem.distributionChannel.

- *

The distribution channel referenced must already exist - * in the commercetools project, or the - * import operation state is set to Unresolved.

+ *

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.

* * @return null|ChannelKeyReference */ diff --git a/lib/commercetools-import/src/Models/Orders/LineItemImportDraftModel.php b/lib/commercetools-import/src/Models/Orders/LineItemImportDraftModel.php index c233845af26..c622dfc87aa 100644 --- a/lib/commercetools-import/src/Models/Orders/LineItemImportDraftModel.php +++ b/lib/commercetools-import/src/Models/Orders/LineItemImportDraftModel.php @@ -222,10 +222,9 @@ public function getState() } /** - *

References a supply channel. Maps to LineItem.supplyChannel.

- *

The supply channel referenced must already exist - * in the commercetools project, or the - * import operation state is set to Unresolved.

+ *

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.

* * @return null|ChannelKeyReference */ @@ -245,10 +244,9 @@ public function getSupplyChannel() } /** - *

References a distribution channel. Maps to LineItem.distributionChannel.

- *

The distribution channel referenced must already exist - * in the commercetools project, or the - * import operation state is set to Unresolved.

+ *

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.

* * @return null|ChannelKeyReference */ diff --git a/lib/commercetools-import/src/Models/Orders/LineItemPrice.php b/lib/commercetools-import/src/Models/Orders/LineItemPrice.php index ee61c9ddc7d..c43f2f5e05d 100644 --- a/lib/commercetools-import/src/Models/Orders/LineItemPrice.php +++ b/lib/commercetools-import/src/Models/Orders/LineItemPrice.php @@ -31,7 +31,7 @@ interface LineItemPrice extends JsonObject public const FIELD_CUSTOM = 'custom'; /** - *

Maps to Price.value.

+ *

Maps to Price.value. TypedMoney is what is called BaseMoney in the HTTP API.

* * @return null|TypedMoney */ diff --git a/lib/commercetools-import/src/Models/Orders/LineItemPriceBuilder.php b/lib/commercetools-import/src/Models/Orders/LineItemPriceBuilder.php index 6be1f381b00..03ef48d0536 100644 --- a/lib/commercetools-import/src/Models/Orders/LineItemPriceBuilder.php +++ b/lib/commercetools-import/src/Models/Orders/LineItemPriceBuilder.php @@ -78,7 +78,7 @@ final class LineItemPriceBuilder implements Builder private $custom; /** - *

Maps to Price.value.

+ *

Maps to Price.value. TypedMoney is what is called BaseMoney in the HTTP API.

* * @return null|TypedMoney */ diff --git a/lib/commercetools-import/src/Models/Orders/LineItemPriceModel.php b/lib/commercetools-import/src/Models/Orders/LineItemPriceModel.php index 1984f0d584d..b3732e0c7b4 100644 --- a/lib/commercetools-import/src/Models/Orders/LineItemPriceModel.php +++ b/lib/commercetools-import/src/Models/Orders/LineItemPriceModel.php @@ -103,7 +103,7 @@ public function __construct( } /** - *

Maps to Price.value.

+ *

Maps to Price.value. TypedMoney is what is called BaseMoney in the HTTP API.

* * @return null|TypedMoney */ diff --git a/lib/commercetools-import/src/Models/Orders/OrderImport.php b/lib/commercetools-import/src/Models/Orders/OrderImport.php index ff1e2e174f8..d90781ee919 100644 --- a/lib/commercetools-import/src/Models/Orders/OrderImport.php +++ b/lib/commercetools-import/src/Models/Orders/OrderImport.php @@ -51,8 +51,6 @@ interface OrderImport extends JsonObject public function getOrderNumber(); /** - *

References a customer by its key.

- * * @return null|CustomerKeyReference */ public function getCustomer(); @@ -79,7 +77,7 @@ public function getLineItems(); public function getCustomLineItems(); /** - *

Maps to Order.totalPrice.

+ *

Maps to Order.totalPrice. TypedMoney is what is called BaseMoney in the HTTP API.

* * @return null|TypedMoney */ diff --git a/lib/commercetools-import/src/Models/Orders/OrderImportBuilder.php b/lib/commercetools-import/src/Models/Orders/OrderImportBuilder.php index da821cadef7..77cba43071e 100644 --- a/lib/commercetools-import/src/Models/Orders/OrderImportBuilder.php +++ b/lib/commercetools-import/src/Models/Orders/OrderImportBuilder.php @@ -153,8 +153,6 @@ public function getOrderNumber() } /** - *

References a customer by its key.

- * * @return null|CustomerKeyReference */ public function getCustomer() @@ -193,7 +191,7 @@ public function getCustomLineItems() } /** - *

Maps to Order.totalPrice.

+ *

Maps to Order.totalPrice. TypedMoney is what is called BaseMoney in the HTTP API.

* * @return null|TypedMoney */ diff --git a/lib/commercetools-import/src/Models/Orders/OrderImportModel.php b/lib/commercetools-import/src/Models/Orders/OrderImportModel.php index 967bee875f7..bae90d66d77 100644 --- a/lib/commercetools-import/src/Models/Orders/OrderImportModel.php +++ b/lib/commercetools-import/src/Models/Orders/OrderImportModel.php @@ -213,8 +213,6 @@ public function getOrderNumber() } /** - *

References a customer by its key.

- * * @return null|CustomerKeyReference */ public function getCustomer() @@ -290,7 +288,7 @@ public function getCustomLineItems() } /** - *

Maps to Order.totalPrice.

+ *

Maps to Order.totalPrice. TypedMoney is what is called BaseMoney in the HTTP API.

* * @return null|TypedMoney */ diff --git a/lib/commercetools-import/src/Models/Orders/ShippingInfoImportDraft.php b/lib/commercetools-import/src/Models/Orders/ShippingInfoImportDraft.php index c97cf57d746..d8799dba8bd 100644 --- a/lib/commercetools-import/src/Models/Orders/ShippingInfoImportDraft.php +++ b/lib/commercetools-import/src/Models/Orders/ShippingInfoImportDraft.php @@ -33,6 +33,8 @@ interface ShippingInfoImportDraft extends JsonObject public function getShippingMethodName(); /** + *

TypedMoney is what is called BaseMoney in the HTTP API.

+ * * @return null|TypedMoney */ public function getPrice(); diff --git a/lib/commercetools-import/src/Models/Orders/ShippingInfoImportDraftBuilder.php b/lib/commercetools-import/src/Models/Orders/ShippingInfoImportDraftBuilder.php index e5510d30409..a0274ff9d14 100644 --- a/lib/commercetools-import/src/Models/Orders/ShippingInfoImportDraftBuilder.php +++ b/lib/commercetools-import/src/Models/Orders/ShippingInfoImportDraftBuilder.php @@ -82,6 +82,8 @@ public function getShippingMethodName() } /** + *

TypedMoney is what is called BaseMoney in the HTTP API.

+ * * @return null|TypedMoney */ public function getPrice() diff --git a/lib/commercetools-import/src/Models/Orders/ShippingInfoImportDraftModel.php b/lib/commercetools-import/src/Models/Orders/ShippingInfoImportDraftModel.php index 94c66b5c01b..1b3fce27be8 100644 --- a/lib/commercetools-import/src/Models/Orders/ShippingInfoImportDraftModel.php +++ b/lib/commercetools-import/src/Models/Orders/ShippingInfoImportDraftModel.php @@ -116,6 +116,8 @@ public function getShippingMethodName() } /** + *

TypedMoney is what is called BaseMoney in the HTTP API.

+ * * @return null|TypedMoney */ public function getPrice() diff --git a/lib/commercetools-import/src/Models/Orders/TaxPortion.php b/lib/commercetools-import/src/Models/Orders/TaxPortion.php index 654670511e6..9b2fa200dd3 100644 --- a/lib/commercetools-import/src/Models/Orders/TaxPortion.php +++ b/lib/commercetools-import/src/Models/Orders/TaxPortion.php @@ -29,6 +29,8 @@ public function getName(); public function getRate(); /** + *

TypedMoney is what is called BaseMoney in the HTTP API.

+ * * @return null|TypedMoney */ public function getAmount(); diff --git a/lib/commercetools-import/src/Models/Orders/TaxPortionBuilder.php b/lib/commercetools-import/src/Models/Orders/TaxPortionBuilder.php index 43716093052..0424e889abf 100644 --- a/lib/commercetools-import/src/Models/Orders/TaxPortionBuilder.php +++ b/lib/commercetools-import/src/Models/Orders/TaxPortionBuilder.php @@ -54,6 +54,8 @@ public function getRate() } /** + *

TypedMoney is what is called BaseMoney in the HTTP API.

+ * * @return null|TypedMoney */ public function getAmount() diff --git a/lib/commercetools-import/src/Models/Orders/TaxPortionModel.php b/lib/commercetools-import/src/Models/Orders/TaxPortionModel.php index 338e25c681a..5f3e3ef2681 100644 --- a/lib/commercetools-import/src/Models/Orders/TaxPortionModel.php +++ b/lib/commercetools-import/src/Models/Orders/TaxPortionModel.php @@ -85,6 +85,8 @@ public function getRate() } /** + *

TypedMoney is what is called BaseMoney in the HTTP API.

+ * * @return null|TypedMoney */ public function getAmount() diff --git a/lib/commercetools-import/src/Models/Prices/PriceImport.php b/lib/commercetools-import/src/Models/Prices/PriceImport.php index e36c1ed1600..0f20f9a6393 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'; /** - *

Maps to Price.value.

+ *

Maps to Price.value. TypedMoney is what is called BaseMoney in the HTTP API.

* * @return null|TypedMoney */ @@ -65,20 +65,16 @@ public function getValidFrom(); public function getValidUntil(); /** - *

References a customer group by its key.

- *

The customer group referenced - * must already exist in the commercetools project, or the - * import operation state is set to Unresolved.

+ *

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.

* * @return null|CustomerGroupKeyReference */ public function getCustomerGroup(); /** - *

References a channel by its key.

- *

The channel referenced - * must already exist in the commercetools project, or the - * import operation state is set to Unresolved.

+ *

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.

* * @return null|ChannelKeyReference */ @@ -113,20 +109,18 @@ public function getTiers(); public function getCustom(); /** - *

The product variant in which this price is contained.

- *

The product variant referenced - * must already exist in the commercetools project, or the - * import operation state is set to Unresolved.

+ *

The ProductVariant in which this Price is contained. + * The Reference to the ProductVariant with which the Price is associated. + * If referenced ProductVariant does not exist, the state of the ImportOperation will be set to Unresolved until the necessary ProductVariant is created.

* * @return null|ProductVariantKeyReference */ public function getProductVariant(); /** - *

The product in which this product variant containong the price is contained. Maps to ProductVariant.product.

- *

The product referenced - * must already exist in the commercetools project, or the - * import operation state is set to Unresolved.

+ *

The Product in which the Product Variant containing this 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.

* * @return null|ProductKeyReference */ diff --git a/lib/commercetools-import/src/Models/Prices/PriceImportBuilder.php b/lib/commercetools-import/src/Models/Prices/PriceImportBuilder.php index 3b6aa8162a7..10af742c984 100644 --- a/lib/commercetools-import/src/Models/Prices/PriceImportBuilder.php +++ b/lib/commercetools-import/src/Models/Prices/PriceImportBuilder.php @@ -112,7 +112,7 @@ public function getKey() } /** - *

Maps to Price.value.

+ *

Maps to Price.value. TypedMoney is what is called BaseMoney in the HTTP API.

* * @return null|TypedMoney */ @@ -152,10 +152,8 @@ public function getValidUntil() } /** - *

References a customer group by its key.

- *

The customer group referenced - * must already exist in the commercetools project, or the - * import operation state is set to Unresolved.

+ *

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.

* * @return null|CustomerGroupKeyReference */ @@ -165,10 +163,8 @@ public function getCustomerGroup() } /** - *

References a channel by its key.

- *

The channel referenced - * must already exist in the commercetools project, or the - * import operation state is set to Unresolved.

+ *

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.

* * @return null|ChannelKeyReference */ @@ -218,10 +214,9 @@ public function getCustom() } /** - *

The product variant in which this price is contained.

- *

The product variant referenced - * must already exist in the commercetools project, or the - * import operation state is set to Unresolved.

+ *

The ProductVariant in which this Price is contained. + * The Reference to the ProductVariant with which the Price is associated. + * If referenced ProductVariant does not exist, the state of the ImportOperation will be set to Unresolved until the necessary ProductVariant is created.

* * @return null|ProductVariantKeyReference */ @@ -231,10 +226,9 @@ public function getProductVariant() } /** - *

The product in which this product variant containong the price is contained. Maps to ProductVariant.product.

- *

The product referenced - * must already exist in the commercetools project, or the - * import operation state is set to Unresolved.

+ *

The Product in which the Product Variant containing this 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.

* * @return null|ProductKeyReference */ diff --git a/lib/commercetools-import/src/Models/Prices/PriceImportModel.php b/lib/commercetools-import/src/Models/Prices/PriceImportModel.php index e87c1fe41f2..2f7e4896ba2 100644 --- a/lib/commercetools-import/src/Models/Prices/PriceImportModel.php +++ b/lib/commercetools-import/src/Models/Prices/PriceImportModel.php @@ -154,7 +154,7 @@ public function getKey() } /** - *

Maps to Price.value.

+ *

Maps to Price.value. TypedMoney is what is called BaseMoney in the HTTP API.

* * @return null|TypedMoney */ @@ -239,10 +239,8 @@ public function getValidUntil() } /** - *

References a customer group by its key.

- *

The customer group referenced - * must already exist in the commercetools project, or the - * import operation state is set to Unresolved.

+ *

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.

* * @return null|CustomerGroupKeyReference */ @@ -262,10 +260,8 @@ public function getCustomerGroup() } /** - *

References a channel by its key.

- *

The channel referenced - * must already exist in the commercetools project, or the - * import operation state is set to Unresolved.

+ *

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.

* * @return null|ChannelKeyReference */ @@ -363,10 +359,9 @@ public function getCustom() } /** - *

The product variant in which this price is contained.

- *

The product variant referenced - * must already exist in the commercetools project, or the - * import operation state is set to Unresolved.

+ *

The ProductVariant in which this Price is contained. + * The Reference to the ProductVariant with which the Price is associated. + * If referenced ProductVariant does not exist, the state of the ImportOperation will be set to Unresolved until the necessary ProductVariant is created.

* * @return null|ProductVariantKeyReference */ @@ -386,10 +381,9 @@ public function getProductVariant() } /** - *

The product in which this product variant containong the price is contained. Maps to ProductVariant.product.

- *

The product referenced - * must already exist in the commercetools project, or the - * import operation state is set to Unresolved.

+ *

The Product in which the Product Variant containing this 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.

* * @return null|ProductKeyReference */ diff --git a/lib/commercetools-import/src/Models/Productdrafts/PriceDraftImport.php b/lib/commercetools-import/src/Models/Productdrafts/PriceDraftImport.php index 8f372fc7597..a1f78241ae7 100644 --- a/lib/commercetools-import/src/Models/Productdrafts/PriceDraftImport.php +++ b/lib/commercetools-import/src/Models/Productdrafts/PriceDraftImport.php @@ -32,6 +32,8 @@ interface PriceDraftImport extends JsonObject public const FIELD_KEY = 'key'; /** + *

TypedMoney is what is called BaseMoney in the HTTP API.

+ * * @return null|TypedMoney */ public function getValue(); diff --git a/lib/commercetools-import/src/Models/Productdrafts/PriceDraftImportBuilder.php b/lib/commercetools-import/src/Models/Productdrafts/PriceDraftImportBuilder.php index e8efebc930b..7768a5936fb 100644 --- a/lib/commercetools-import/src/Models/Productdrafts/PriceDraftImportBuilder.php +++ b/lib/commercetools-import/src/Models/Productdrafts/PriceDraftImportBuilder.php @@ -83,6 +83,8 @@ final class PriceDraftImportBuilder implements Builder private $key; /** + *

TypedMoney is what is called BaseMoney in the HTTP API.

+ * * @return null|TypedMoney */ public function getValue() diff --git a/lib/commercetools-import/src/Models/Productdrafts/PriceDraftImportModel.php b/lib/commercetools-import/src/Models/Productdrafts/PriceDraftImportModel.php index 66ee9322908..f17e13c86d2 100644 --- a/lib/commercetools-import/src/Models/Productdrafts/PriceDraftImportModel.php +++ b/lib/commercetools-import/src/Models/Productdrafts/PriceDraftImportModel.php @@ -110,6 +110,8 @@ public function __construct( } /** + *

TypedMoney is what is called BaseMoney in the HTTP API.

+ * * @return null|TypedMoney */ public function getValue() diff --git a/lib/commercetools-import/src/Models/Productdrafts/ProductDraftImport.php b/lib/commercetools-import/src/Models/Productdrafts/ProductDraftImport.php index 614d963f909..34732160e08 100644 --- a/lib/commercetools-import/src/Models/Productdrafts/ProductDraftImport.php +++ b/lib/commercetools-import/src/Models/Productdrafts/ProductDraftImport.php @@ -36,10 +36,10 @@ interface ProductDraftImport extends ImportResource public const FIELD_PUBLISH = 'publish'; /** - *

The product's product type. Maps to Product.productType.

- *

The product type referenced - * must already exist in the commercetools project, or the - * import operation state is set to Unresolved.

+ *

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.

* * @return null|ProductTypeKeyReference */ @@ -66,10 +66,8 @@ public function getSlug(); public function getDescription(); /** - *

An array of references to categories by their keys. Maps to Product.categories.

- *

The categories referenced - * must already exist in the commercetools project, or the - * import operation state is set to Unresolved.

+ *

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.

* * @return null|CategoryKeyReferenceCollection */ @@ -112,25 +110,23 @@ public function getMetaDescription(); public function getMetaKeywords(); /** - *

The master product variant. - * Required if the variants array has product variants.

+ *

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

* * @return null|ProductVariantDraftImport */ public function getMasterVariant(); /** - *

An array of related product variants.

+ *

An array of related Product Variants.

* * @return null|ProductVariantDraftImportCollection */ public function getVariants(); /** - *

References a tax category by its key.

- *

The tax category referenced must already exist - * in the commercetools project, or the - * import operation state is set to Unresolved.

+ *

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.

* * @return null|TaxCategoryKeyReference */ @@ -160,10 +156,8 @@ public function getTaxCategory(); public function getSearchKeywords(); /** - *

References a state by its key.

- *

The tax category referenced must already exist - * in the commercetools project, or the - * import operation state is set to Unresolved.

+ *

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.

* * @return null|StateKeyReference */ diff --git a/lib/commercetools-import/src/Models/Productdrafts/ProductDraftImportBuilder.php b/lib/commercetools-import/src/Models/Productdrafts/ProductDraftImportBuilder.php index 1e799a925fc..0bee490ecdc 100644 --- a/lib/commercetools-import/src/Models/Productdrafts/ProductDraftImportBuilder.php +++ b/lib/commercetools-import/src/Models/Productdrafts/ProductDraftImportBuilder.php @@ -117,10 +117,10 @@ public function getKey() } /** - *

The product's product type. Maps to Product.productType.

- *

The product type referenced - * must already exist in the commercetools project, or the - * import operation state is set to Unresolved.

+ *

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.

* * @return null|ProductTypeKeyReference */ @@ -159,10 +159,8 @@ public function getDescription() } /** - *

An array of references to categories by their keys. Maps to Product.categories.

- *

The categories referenced - * must already exist in the commercetools project, or the - * import operation state is set to Unresolved.

+ *

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.

* * @return null|CategoryKeyReferenceCollection */ @@ -217,8 +215,8 @@ public function getMetaKeywords() } /** - *

The master product variant. - * Required if the variants array has product variants.

+ *

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

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

An array of related product variants.

+ *

An array of related Product Variants.

* * @return null|ProductVariantDraftImportCollection */ @@ -238,10 +236,8 @@ public function getVariants() } /** - *

References a tax category by its key.

- *

The tax category referenced must already exist - * in the commercetools project, or the - * import operation state is set to Unresolved.

+ *

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.

* * @return null|TaxCategoryKeyReference */ @@ -277,10 +273,8 @@ public function getSearchKeywords() } /** - *

References a state by its key.

- *

The tax category referenced must already exist - * in the commercetools project, or the - * import operation state is set to Unresolved.

+ *

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.

* * @return null|StateKeyReference */ diff --git a/lib/commercetools-import/src/Models/Productdrafts/ProductDraftImportModel.php b/lib/commercetools-import/src/Models/Productdrafts/ProductDraftImportModel.php index 92460ff2a94..c10b98f6351 100644 --- a/lib/commercetools-import/src/Models/Productdrafts/ProductDraftImportModel.php +++ b/lib/commercetools-import/src/Models/Productdrafts/ProductDraftImportModel.php @@ -163,10 +163,10 @@ public function getKey() } /** - *

The product's product type. Maps to Product.productType.

- *

The product type referenced - * must already exist in the commercetools project, or the - * import operation state is set to Unresolved.

+ *

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.

* * @return null|ProductTypeKeyReference */ @@ -245,10 +245,8 @@ public function getDescription() } /** - *

An array of references to categories by their keys. Maps to Product.categories.

- *

The categories referenced - * must already exist in the commercetools project, or the - * import operation state is set to Unresolved.

+ *

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.

* * @return null|CategoryKeyReferenceCollection */ @@ -342,8 +340,8 @@ public function getMetaKeywords() } /** - *

The master product variant. - * Required if the variants array has product variants.

+ *

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

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

An array of related product variants.

+ *

An array of related Product Variants.

* * @return null|ProductVariantDraftImportCollection */ @@ -382,10 +380,8 @@ public function getVariants() } /** - *

References a tax category by its key.

- *

The tax category referenced must already exist - * in the commercetools project, or the - * import operation state is set to Unresolved.

+ *

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.

* * @return null|TaxCategoryKeyReference */ @@ -441,10 +437,8 @@ public function getSearchKeywords() } /** - *

References a state by its key.

- *

The tax category referenced must already exist - * in the commercetools project, or the - * import operation state is set to Unresolved.

+ *

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.

* * @return null|StateKeyReference */ diff --git a/lib/commercetools-import/src/Models/Products/ProductImport.php b/lib/commercetools-import/src/Models/Products/ProductImport.php index 1bccb9722d0..db451546afc 100644 --- a/lib/commercetools-import/src/Models/Products/ProductImport.php +++ b/lib/commercetools-import/src/Models/Products/ProductImport.php @@ -40,17 +40,17 @@ interface ProductImport extends ImportResource public function getName(); /** - *

The product's product type. Maps to Product.productType.

- *

The product type referenced - * must already exist in the commercetools project, or the - * import operation state is set to Unresolved.

+ *

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.

* * @return null|ProductTypeKeyReference */ public function getProductType(); /** - *

Human-readable identifiers usually used as deep-link URL to the related product. Each slug must be unique across a project, + *

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.

* * @return null|LocalizedString @@ -65,10 +65,9 @@ public function getSlug(); public function getDescription(); /** - *

An array of references to a categories by their keys. Maps to Product.categories.

- *

The categories referenced - * must already exist in the commercetools project, or the - * import operation state is set to Unresolved.

+ *

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.

* * @return null|CategoryKeyReferenceCollection */ @@ -111,10 +110,8 @@ public function getMetaDescription(); public function getMetaKeywords(); /** - *

References a tax category by its key.

- *

The tax category referenced must already exist - * in the commercetools project, or the - * import operation state is set to Unresolved.

+ *

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.

* * @return null|TaxCategoryKeyReference */ @@ -144,10 +141,8 @@ public function getTaxCategory(); public function getSearchKeywords(); /** - *

References a state by its key.

- *

The tax category referenced must already exist - * in the commercetools project, or the - * import operation state is set to Unresolved.

+ *

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.

* * @return null|StateKeyReference */ diff --git a/lib/commercetools-import/src/Models/Products/ProductImportBuilder.php b/lib/commercetools-import/src/Models/Products/ProductImportBuilder.php index 6a6030915f3..b31e245a112 100644 --- a/lib/commercetools-import/src/Models/Products/ProductImportBuilder.php +++ b/lib/commercetools-import/src/Models/Products/ProductImportBuilder.php @@ -115,10 +115,10 @@ public function getName() } /** - *

The product's product type. Maps to Product.productType.

- *

The product type referenced - * must already exist in the commercetools project, or the - * import operation state is set to Unresolved.

+ *

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.

* * @return null|ProductTypeKeyReference */ @@ -128,7 +128,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, + *

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.

* * @return null|LocalizedString @@ -149,10 +149,9 @@ public function getDescription() } /** - *

An array of references to a categories by their keys. Maps to Product.categories.

- *

The categories referenced - * must already exist in the commercetools project, or the - * import operation state is set to Unresolved.

+ *

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.

* * @return null|CategoryKeyReferenceCollection */ @@ -207,10 +206,8 @@ public function getMetaKeywords() } /** - *

References a tax category by its key.

- *

The tax category referenced must already exist - * in the commercetools project, or the - * import operation state is set to Unresolved.

+ *

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.

* * @return null|TaxCategoryKeyReference */ @@ -246,10 +243,8 @@ public function getSearchKeywords() } /** - *

References a state by its key.

- *

The tax category referenced must already exist - * in the commercetools project, or the - * import operation state is set to Unresolved.

+ *

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.

* * @return null|StateKeyReference */ diff --git a/lib/commercetools-import/src/Models/Products/ProductImportModel.php b/lib/commercetools-import/src/Models/Products/ProductImportModel.php index a1e8738b79e..73857a2e264 100644 --- a/lib/commercetools-import/src/Models/Products/ProductImportModel.php +++ b/lib/commercetools-import/src/Models/Products/ProductImportModel.php @@ -167,10 +167,10 @@ public function getName() } /** - *

The product's product type. Maps to Product.productType.

- *

The product type referenced - * must already exist in the commercetools project, or the - * import operation state is set to Unresolved.

+ *

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.

* * @return null|ProductTypeKeyReference */ @@ -190,7 +190,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, + *

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.

* * @return null|LocalizedString @@ -231,10 +231,9 @@ public function getDescription() } /** - *

An array of references to a categories by their keys. Maps to Product.categories.

- *

The categories referenced - * must already exist in the commercetools project, or the - * import operation state is set to Unresolved.

+ *

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.

* * @return null|CategoryKeyReferenceCollection */ @@ -328,10 +327,8 @@ public function getMetaKeywords() } /** - *

References a tax category by its key.

- *

The tax category referenced must already exist - * in the commercetools project, or the - * import operation state is set to Unresolved.

+ *

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.

* * @return null|TaxCategoryKeyReference */ @@ -387,10 +384,8 @@ public function getSearchKeywords() } /** - *

References a state by its key.

- *

The tax category referenced must already exist - * in the commercetools project, or the - * import operation state is set to Unresolved.

+ *

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.

* * @return null|StateKeyReference */ diff --git a/lib/commercetools-import/src/Models/Producttypes/ProductTypeImport.php b/lib/commercetools-import/src/Models/Producttypes/ProductTypeImport.php index 63957b24161..19051351ab8 100644 --- a/lib/commercetools-import/src/Models/Producttypes/ProductTypeImport.php +++ b/lib/commercetools-import/src/Models/Producttypes/ProductTypeImport.php @@ -33,7 +33,7 @@ public function getName(); public function getDescription(); /** - *

The product type's attributes.

+ *

The attributes of ProductType.

* * @return null|AttributeDefinitionCollection */ diff --git a/lib/commercetools-import/src/Models/Producttypes/ProductTypeImportBuilder.php b/lib/commercetools-import/src/Models/Producttypes/ProductTypeImportBuilder.php index 2e4fd0f827b..867413a4007 100644 --- a/lib/commercetools-import/src/Models/Producttypes/ProductTypeImportBuilder.php +++ b/lib/commercetools-import/src/Models/Producttypes/ProductTypeImportBuilder.php @@ -71,7 +71,7 @@ public function getDescription() } /** - *

The product type's attributes.

+ *

The attributes of ProductType.

* * @return null|AttributeDefinitionCollection */ diff --git a/lib/commercetools-import/src/Models/Producttypes/ProductTypeImportModel.php b/lib/commercetools-import/src/Models/Producttypes/ProductTypeImportModel.php index 485acf507a4..c5a1ddf7533 100644 --- a/lib/commercetools-import/src/Models/Producttypes/ProductTypeImportModel.php +++ b/lib/commercetools-import/src/Models/Producttypes/ProductTypeImportModel.php @@ -113,7 +113,7 @@ public function getDescription() } /** - *

The product type's attributes.

+ *

The attributes of ProductType.

* * @return null|AttributeDefinitionCollection */ diff --git a/lib/commercetools-import/src/Models/Productvariants/MoneySetAttribute.php b/lib/commercetools-import/src/Models/Productvariants/MoneySetAttribute.php index 3526bf466e5..8049cd2f592 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'; /** + *

TypedMoney is what is called BaseMoney in the HTTP API.

+ * * @return null|TypedMoneyCollection */ public function getValue(); diff --git a/lib/commercetools-import/src/Models/Productvariants/MoneySetAttributeBuilder.php b/lib/commercetools-import/src/Models/Productvariants/MoneySetAttributeBuilder.php index 0f64e4b2a79..808a0d59b2f 100644 --- a/lib/commercetools-import/src/Models/Productvariants/MoneySetAttributeBuilder.php +++ b/lib/commercetools-import/src/Models/Productvariants/MoneySetAttributeBuilder.php @@ -44,6 +44,8 @@ public function getName() } /** + *

TypedMoney is what is called BaseMoney in the HTTP API.

+ * * @return null|TypedMoneyCollection */ public function getValue() diff --git a/lib/commercetools-import/src/Models/Productvariants/MoneySetAttributeModel.php b/lib/commercetools-import/src/Models/Productvariants/MoneySetAttributeModel.php index 14ce11603d1..34705cab9ed 100644 --- a/lib/commercetools-import/src/Models/Productvariants/MoneySetAttributeModel.php +++ b/lib/commercetools-import/src/Models/Productvariants/MoneySetAttributeModel.php @@ -88,6 +88,8 @@ public function getType() } /** + *

TypedMoney is what is called BaseMoney in the HTTP API.

+ * * @return null|TypedMoneyCollection */ public function getValue() diff --git a/lib/commercetools-import/src/Models/Productvariants/ProductVariantImport.php b/lib/commercetools-import/src/Models/Productvariants/ProductVariantImport.php index c9b5a300e97..e2ced80e58f 100644 --- a/lib/commercetools-import/src/Models/Productvariants/ProductVariantImport.php +++ b/lib/commercetools-import/src/Models/Productvariants/ProductVariantImport.php @@ -40,10 +40,8 @@ public function getSku(); public function getIsMasterVariant(); /** - *

Maps to ProductVariant.attributes.

- *

Each attribute referenced must be defined - * in an already existing product type in the commercetools project, or the import - * operation state is set to Unresolved.

+ *

Maps to ProductVariant.attributes. + * The referenced attribute must be defined in an already existing ProductType in the commercetools project, or the state of the ImportOperation will be Unresolved.

* * @return null|AttributeCollection */ @@ -71,10 +69,9 @@ public function getAssets(); public function getPublish(); /** - *

The product in which this product variant is contained. Maps to ProductVariant.product.

- *

The product referenced - * must already exist in the commercetools project, or the - * import operation state is set to Unresolved.

+ *

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.

* * @return null|ProductKeyReference */ diff --git a/lib/commercetools-import/src/Models/Productvariants/ProductVariantImportBuilder.php b/lib/commercetools-import/src/Models/Productvariants/ProductVariantImportBuilder.php index 21147665cef..728d32b4d12 100644 --- a/lib/commercetools-import/src/Models/Productvariants/ProductVariantImportBuilder.php +++ b/lib/commercetools-import/src/Models/Productvariants/ProductVariantImportBuilder.php @@ -95,10 +95,8 @@ public function getIsMasterVariant() } /** - *

Maps to ProductVariant.attributes.

- *

Each attribute referenced must be defined - * in an already existing product type in the commercetools project, or the import - * operation state is set to Unresolved.

+ *

Maps to ProductVariant.attributes. + * The referenced attribute must be defined in an already existing ProductType in the commercetools project, or the state of the ImportOperation will be Unresolved.

* * @return null|AttributeCollection */ @@ -138,10 +136,9 @@ public function getPublish() } /** - *

The product in which this product variant is contained. Maps to ProductVariant.product.

- *

The product referenced - * must already exist in the commercetools project, or the - * import operation state is set to Unresolved.

+ *

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.

* * @return null|ProductKeyReference */ diff --git a/lib/commercetools-import/src/Models/Productvariants/ProductVariantImportModel.php b/lib/commercetools-import/src/Models/Productvariants/ProductVariantImportModel.php index c321edb7852..393b3f283c5 100644 --- a/lib/commercetools-import/src/Models/Productvariants/ProductVariantImportModel.php +++ b/lib/commercetools-import/src/Models/Productvariants/ProductVariantImportModel.php @@ -145,10 +145,8 @@ public function getIsMasterVariant() } /** - *

Maps to ProductVariant.attributes.

- *

Each attribute referenced must be defined - * in an already existing product type in the commercetools project, or the import - * operation state is set to Unresolved.

+ *

Maps to ProductVariant.attributes. + * The referenced attribute must be defined in an already existing ProductType in the commercetools project, or the state of the ImportOperation will be Unresolved.

* * @return null|AttributeCollection */ @@ -224,10 +222,9 @@ public function getPublish() } /** - *

The product in which this product variant is contained. Maps to ProductVariant.product.

- *

The product referenced - * must already exist in the commercetools project, or the - * import operation state is set to Unresolved.

+ *

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.

* * @return null|ProductKeyReference */ diff --git a/lib/commercetools-import/src/Models/Productvariants/ProductVariantPatch.php b/lib/commercetools-import/src/Models/Productvariants/ProductVariantPatch.php index 49fb64df32a..26fb136cf97 100644 --- a/lib/commercetools-import/src/Models/Productvariants/ProductVariantPatch.php +++ b/lib/commercetools-import/src/Models/Productvariants/ProductVariantPatch.php @@ -19,20 +19,17 @@ interface ProductVariantPatch extends JsonObject public const FIELD_STAGED = 'staged'; /** - *

The product variant to which this patch is applied.

- *

The product variant referenced - * must already exist in the commercetools project, or the - * import operation state is set to Unresolved.

+ *

The ProductVariant to which this patch is applied. + * The Reference to the ProductVariant with which the ProductVariantPatch is associated. + * If referenced ProductVariant does not exist, the state of the ImportOperation will be set to Unresolved until the necessary ProductVariant is created.

* * @return null|ProductVariantKeyReference */ public function getProductVariant(); /** - *

Maps to ProductVariant.attributes.

- *

Each attribute referenced must be defined - * in an already existing product type in the commercetools project, or the import - * operation state is set to ValidationFailed.

+ *

Maps to ProductVariant.attributes. + * The referenced attribute must be defined in an already existing ProductType in the commercetools Project, or the state of the ImportOperation will be Unresolved.

* * @return null|Attributes */ diff --git a/lib/commercetools-import/src/Models/Productvariants/ProductVariantPatchBuilder.php b/lib/commercetools-import/src/Models/Productvariants/ProductVariantPatchBuilder.php index b45e00ceabc..eacea029183 100644 --- a/lib/commercetools-import/src/Models/Productvariants/ProductVariantPatchBuilder.php +++ b/lib/commercetools-import/src/Models/Productvariants/ProductVariantPatchBuilder.php @@ -38,10 +38,9 @@ final class ProductVariantPatchBuilder implements Builder private $staged; /** - *

The product variant to which this patch is applied.

- *

The product variant referenced - * must already exist in the commercetools project, or the - * import operation state is set to Unresolved.

+ *

The ProductVariant to which this patch is applied. + * The Reference to the ProductVariant with which the ProductVariantPatch is associated. + * If referenced ProductVariant does not exist, the state of the ImportOperation will be set to Unresolved until the necessary ProductVariant is created.

* * @return null|ProductVariantKeyReference */ @@ -51,10 +50,8 @@ public function getProductVariant() } /** - *

Maps to ProductVariant.attributes.

- *

Each attribute referenced must be defined - * in an already existing product type in the commercetools project, or the import - * operation state is set to ValidationFailed.

+ *

Maps to ProductVariant.attributes. + * The referenced attribute must be defined in an already existing ProductType in the commercetools Project, or the state of the ImportOperation will be Unresolved.

* * @return null|Attributes */ diff --git a/lib/commercetools-import/src/Models/Productvariants/ProductVariantPatchModel.php b/lib/commercetools-import/src/Models/Productvariants/ProductVariantPatchModel.php index 123f62f3017..bf2aafd4f99 100644 --- a/lib/commercetools-import/src/Models/Productvariants/ProductVariantPatchModel.php +++ b/lib/commercetools-import/src/Models/Productvariants/ProductVariantPatchModel.php @@ -51,10 +51,9 @@ public function __construct( } /** - *

The product variant to which this patch is applied.

- *

The product variant referenced - * must already exist in the commercetools project, or the - * import operation state is set to Unresolved.

+ *

The ProductVariant to which this patch is applied. + * The Reference to the ProductVariant with which the ProductVariantPatch is associated. + * If referenced ProductVariant does not exist, the state of the ImportOperation will be set to Unresolved until the necessary ProductVariant is created.

* * @return null|ProductVariantKeyReference */ @@ -74,10 +73,8 @@ public function getProductVariant() } /** - *

Maps to ProductVariant.attributes.

- *

Each attribute referenced must be defined - * in an already existing product type in the commercetools project, or the import - * operation state is set to ValidationFailed.

+ *

Maps to ProductVariant.attributes. + * The referenced attribute must be defined in an already existing ProductType in the commercetools Project, or the state of the ImportOperation will be Unresolved.

* * @return null|Attributes */ diff --git a/lib/commercetools-ml-tests/gen.properties b/lib/commercetools-ml-tests/gen.properties index ec3aae949cf..c99be4b063f 100644 --- a/lib/commercetools-ml-tests/gen.properties +++ b/lib/commercetools-ml-tests/gen.properties @@ -1 +1 @@ -hash=521347af873c8879ba5c9605af6a28958010c4e3 +hash=865999c5abbf6bec6c3de7c517305ed01ffda944 diff --git a/lib/commercetools-ml/gen.properties b/lib/commercetools-ml/gen.properties index ec3aae949cf..c99be4b063f 100644 --- a/lib/commercetools-ml/gen.properties +++ b/lib/commercetools-ml/gen.properties @@ -1 +1 @@ -hash=521347af873c8879ba5c9605af6a28958010c4e3 +hash=865999c5abbf6bec6c3de7c517305ed01ffda944