From 920e88d0a9083248ffd6a1a65f430ee067e6326d Mon Sep 17 00:00:00 2001 From: Auto Mation Date: Mon, 20 Jun 2022 05:57:54 +0000 Subject: [PATCH 1/2] TASK: Updating SDK --- lib/commercetools-api/docs/RequestBuilder.md | 20 ++++-- .../Error/MaxResourceLimitExceededError.php | 2 +- .../MaxResourceLimitExceededErrorBuilder.php | 2 +- .../MaxResourceLimitExceededErrorModel.php | 2 +- .../src/Models/Error/ReferenceExistsError.php | 2 +- .../Error/ReferenceExistsErrorBuilder.php | 2 +- .../Error/ReferenceExistsErrorModel.php | 2 +- .../Error/ReferencedResourceNotFoundError.php | 2 +- ...ReferencedResourceNotFoundErrorBuilder.php | 2 +- .../ReferencedResourceNotFoundErrorModel.php | 2 +- .../ProductType/AttributeDefinition.php | 30 ++++---- .../AttributeDefinitionBuilder.php | 30 ++++---- .../ProductType/AttributeDefinitionDraft.php | 27 ++++---- .../AttributeDefinitionDraftBuilder.php | 27 ++++---- .../AttributeDefinitionDraftModel.php | 27 ++++---- .../ProductType/AttributeDefinitionModel.php | 30 ++++---- .../Models/ProductType/AttributeEnumType.php | 2 + .../ProductType/AttributeEnumTypeBuilder.php | 2 + .../ProductType/AttributeEnumTypeModel.php | 2 + .../AttributeLocalizedEnumType.php | 2 + .../AttributeLocalizedEnumTypeBuilder.php | 2 + .../AttributeLocalizedEnumTypeModel.php | 2 + .../AttributeLocalizedEnumValue.php | 4 +- .../AttributeLocalizedEnumValueBuilder.php | 4 +- .../AttributeLocalizedEnumValueModel.php | 4 +- .../ProductType/AttributeNestedType.php | 2 +- .../AttributeNestedTypeBuilder.php | 2 +- .../ProductType/AttributeNestedTypeModel.php | 2 +- .../ProductType/AttributePlainEnumValue.php | 4 ++ .../AttributePlainEnumValueBuilder.php | 4 ++ .../AttributePlainEnumValueModel.php | 4 ++ .../ProductType/AttributeReferenceType.php | 2 +- .../AttributeReferenceTypeBuilder.php | 2 +- .../AttributeReferenceTypeModel.php | 2 +- .../Models/ProductType/AttributeSetType.php | 2 + .../ProductType/AttributeSetTypeBuilder.php | 2 + .../ProductType/AttributeSetTypeModel.php | 6 +- .../src/Models/ProductType/ProductType.php | 14 +++- ...roductTypeAddAttributeDefinitionAction.php | 2 + ...ypeAddAttributeDefinitionActionBuilder.php | 2 + ...tTypeAddAttributeDefinitionActionModel.php | 2 + ...ProductTypeAddLocalizedEnumValueAction.php | 4 ++ ...TypeAddLocalizedEnumValueActionBuilder.php | 4 ++ ...ctTypeAddLocalizedEnumValueActionModel.php | 4 ++ .../ProductTypeAddPlainEnumValueAction.php | 4 ++ ...ductTypeAddPlainEnumValueActionBuilder.php | 4 ++ ...roductTypeAddPlainEnumValueActionModel.php | 4 ++ .../Models/ProductType/ProductTypeBuilder.php | 14 +++- ...uctTypeChangeAttributeConstraintAction.php | 4 ++ ...ChangeAttributeConstraintActionBuilder.php | 4 ++ ...peChangeAttributeConstraintActionModel.php | 4 ++ .../ProductTypeChangeAttributeNameAction.php | 6 ++ ...ctTypeChangeAttributeNameActionBuilder.php | 6 ++ ...ductTypeChangeAttributeNameActionModel.php | 6 ++ ...ctTypeChangeAttributeOrderByNameAction.php | 2 + ...hangeAttributeOrderByNameActionBuilder.php | 2 + ...eChangeAttributeOrderByNameActionModel.php | 2 + .../ProductTypeChangeDescriptionAction.php | 2 + ...ductTypeChangeDescriptionActionBuilder.php | 2 + ...roductTypeChangeDescriptionActionModel.php | 2 + .../ProductTypeChangeEnumKeyAction.php | 6 ++ .../ProductTypeChangeEnumKeyActionBuilder.php | 6 ++ .../ProductTypeChangeEnumKeyActionModel.php | 6 ++ .../ProductTypeChangeInputHintAction.php | 4 ++ ...roductTypeChangeInputHintActionBuilder.php | 4 ++ .../ProductTypeChangeInputHintActionModel.php | 4 ++ .../ProductTypeChangeIsSearchableAction.php | 4 ++ ...uctTypeChangeIsSearchableActionBuilder.php | 4 ++ ...oductTypeChangeIsSearchableActionModel.php | 4 ++ .../ProductTypeChangeLabelAction.php | 4 +- .../ProductTypeChangeLabelActionBuilder.php | 4 +- .../ProductTypeChangeLabelActionModel.php | 4 +- ...ypeChangeLocalizedEnumValueLabelAction.php | 4 ++ ...geLocalizedEnumValueLabelActionBuilder.php | 4 ++ ...angeLocalizedEnumValueLabelActionModel.php | 4 ++ ...ypeChangeLocalizedEnumValueOrderAction.php | 4 ++ ...geLocalizedEnumValueOrderActionBuilder.php | 4 ++ ...angeLocalizedEnumValueOrderActionModel.php | 4 ++ .../ProductTypeChangeNameAction.php | 2 + .../ProductTypeChangeNameActionBuilder.php | 2 + .../ProductTypeChangeNameActionModel.php | 2 + ...uctTypeChangePlainEnumValueLabelAction.php | 4 ++ ...ChangePlainEnumValueLabelActionBuilder.php | 4 ++ ...peChangePlainEnumValueLabelActionModel.php | 4 ++ ...uctTypeChangePlainEnumValueOrderAction.php | 4 ++ ...ChangePlainEnumValueOrderActionBuilder.php | 4 ++ ...peChangePlainEnumValueOrderActionModel.php | 4 ++ .../Models/ProductType/ProductTypeDraft.php | 6 ++ .../ProductType/ProductTypeDraftBuilder.php | 6 ++ .../ProductType/ProductTypeDraftModel.php | 6 ++ .../Models/ProductType/ProductTypeModel.php | 14 +++- .../ProductTypePagedQueryResponse.php | 30 +++++--- .../ProductTypePagedQueryResponseBuilder.php | 50 ++++++++------ .../ProductTypePagedQueryResponseModel.php | 68 +++++++++++-------- ...uctTypeRemoveAttributeDefinitionAction.php | 2 +- ...RemoveAttributeDefinitionActionBuilder.php | 2 +- ...peRemoveAttributeDefinitionActionModel.php | 2 +- .../ProductTypeRemoveEnumValuesAction.php | 4 ++ ...oductTypeRemoveEnumValuesActionBuilder.php | 4 ++ ...ProductTypeRemoveEnumValuesActionModel.php | 4 ++ .../ProductTypeSetInputTipAction.php | 4 +- .../ProductTypeSetInputTipActionBuilder.php | 4 +- .../ProductTypeSetInputTipActionModel.php | 4 +- .../ProductType/ProductTypeSetKeyAction.php | 2 +- .../ProductTypeSetKeyActionBuilder.php | 2 +- .../ProductTypeSetKeyActionModel.php | 2 +- .../Models/ProductType/ProductTypeUpdate.php | 4 ++ .../ProductType/ProductTypeUpdateBuilder.php | 4 ++ .../ProductType/ProductTypeUpdateModel.php | 4 ++ .../Project/CartClassificationTypeModel.php | 2 - .../src/Models/Project/CartScoreTypeModel.php | 2 - .../src/Models/Project/CartValueTypeModel.php | 2 - .../Models/Project/ShippingRateInputType.php | 2 - .../Project/ShippingRateInputTypeModel.php | 2 - .../ShippingMethod/CartClassificationTier.php | 7 +- .../CartClassificationTierBuilder.php | 7 +- .../CartClassificationTierModel.php | 9 +-- .../Models/ShippingMethod/CartScoreTier.php | 15 ++-- .../ShippingMethod/CartScoreTierBuilder.php | 17 +++-- .../ShippingMethod/CartScoreTierModel.php | 25 ++++--- .../Models/ShippingMethod/CartValueTier.php | 7 +- .../ShippingMethod/CartValueTierBuilder.php | 7 +- .../ShippingMethod/CartValueTierModel.php | 9 +-- .../Models/ShippingMethod/PriceFunction.php | 3 + .../ShippingMethod/PriceFunctionBuilder.php | 3 + .../ShippingMethod/PriceFunctionModel.php | 3 + .../Models/ShippingMethod/ShippingMethod.php | 24 ++++++- .../ShippingMethodAddShippingRateAction.php | 4 ++ ...pingMethodAddShippingRateActionBuilder.php | 4 ++ ...ippingMethodAddShippingRateActionModel.php | 4 ++ .../ShippingMethodAddZoneAction.php | 2 + .../ShippingMethodAddZoneActionBuilder.php | 2 + .../ShippingMethodAddZoneActionModel.php | 2 + .../ShippingMethod/ShippingMethodBuilder.php | 24 ++++++- .../ShippingMethodChangeIsDefaultAction.php | 2 +- ...pingMethodChangeIsDefaultActionBuilder.php | 2 +- ...ippingMethodChangeIsDefaultActionModel.php | 2 +- .../ShippingMethodChangeNameAction.php | 2 + .../ShippingMethodChangeNameActionBuilder.php | 2 + .../ShippingMethodChangeNameActionModel.php | 2 + .../ShippingMethodChangeTaxCategoryAction.php | 2 + ...ngMethodChangeTaxCategoryActionBuilder.php | 2 + ...pingMethodChangeTaxCategoryActionModel.php | 2 + .../ShippingMethod/ShippingMethodDraft.php | 18 ++++- .../ShippingMethodDraftBuilder.php | 18 ++++- .../ShippingMethodDraftModel.php | 18 ++++- .../ShippingMethod/ShippingMethodModel.php | 24 ++++++- .../ShippingMethodPagedQueryResponse.php | 10 +++ ...hippingMethodPagedQueryResponseBuilder.php | 10 +++ .../ShippingMethodPagedQueryResponseModel.php | 10 +++ .../ShippingMethodReference.php | 2 +- .../ShippingMethodReferenceBuilder.php | 2 +- .../ShippingMethodReferenceModel.php | 2 +- ...ShippingMethodRemoveShippingRateAction.php | 4 ++ ...gMethodRemoveShippingRateActionBuilder.php | 4 ++ ...ingMethodRemoveShippingRateActionModel.php | 4 ++ .../ShippingMethodRemoveZoneAction.php | 2 + .../ShippingMethodRemoveZoneActionBuilder.php | 2 + .../ShippingMethodRemoveZoneActionModel.php | 2 + .../ShippingMethodSetDescriptionAction.php | 2 + ...ppingMethodSetDescriptionActionBuilder.php | 2 + ...hippingMethodSetDescriptionActionModel.php | 2 + .../ShippingMethodSetKeyAction.php | 2 +- .../ShippingMethodSetKeyActionBuilder.php | 2 +- .../ShippingMethodSetKeyActionModel.php | 2 +- ...ingMethodSetLocalizedDescriptionAction.php | 2 + ...odSetLocalizedDescriptionActionBuilder.php | 2 + ...thodSetLocalizedDescriptionActionModel.php | 2 + .../ShippingMethodSetLocalizedNameAction.php | 2 + ...ingMethodSetLocalizedNameActionBuilder.php | 2 + ...ppingMethodSetLocalizedNameActionModel.php | 2 + .../ShippingMethodSetPredicateAction.php | 3 +- ...hippingMethodSetPredicateActionBuilder.php | 3 +- .../ShippingMethodSetPredicateActionModel.php | 3 +- .../ShippingMethod/ShippingMethodUpdate.php | 4 ++ .../ShippingMethodUpdateBuilder.php | 4 ++ .../ShippingMethodUpdateModel.php | 4 ++ .../Models/ShippingMethod/ShippingRate.php | 12 ++-- .../ShippingMethod/ShippingRateBuilder.php | 12 ++-- .../ShippingMethod/ShippingRateDraft.php | 8 +-- .../ShippingRateDraftBuilder.php | 8 +-- .../ShippingMethod/ShippingRateDraftModel.php | 8 +-- .../ShippingMethod/ShippingRateModel.php | 12 ++-- .../ShippingMethod/ShippingRatePriceTier.php | 2 - .../ShippingRatePriceTierModel.php | 2 - .../src/Models/ShippingMethod/ZoneRate.php | 4 +- .../Models/ShippingMethod/ZoneRateBuilder.php | 4 +- .../Models/ShippingMethod/ZoneRateDraft.php | 4 +- .../ShippingMethod/ZoneRateDraftBuilder.php | 4 +- .../ShippingMethod/ZoneRateDraftModel.php | 4 +- .../Models/ShippingMethod/ZoneRateModel.php | 4 +- .../src/Models/Common/ShippingRate.php | 2 +- .../src/Models/Common/ShippingRateBuilder.php | 2 +- .../src/Models/Common/ShippingRateModel.php | 2 +- 194 files changed, 868 insertions(+), 312 deletions(-) diff --git a/lib/commercetools-api/docs/RequestBuilder.md b/lib/commercetools-api/docs/RequestBuilder.md index e83d38c5b4a..00f366c0544 100644 --- a/lib/commercetools-api/docs/RequestBuilder.md +++ b/lib/commercetools-api/docs/RequestBuilder.md @@ -2282,7 +2282,10 @@ $request = $builder ``` ## `withProjectKey("projectKey")->inStoreKeyWithStoreKeyValue("storeKey")->shippingMethods()->matchingCart()->get()` -null +Retrieves all the ShippingMethods that can ship to the shipping address of the given Cart in a given Store. +Each ShippingMethod contains exactly one ShippingRate with the flag `isMatching` set to `true`. +This ShippingRate is used when the ShippingMethod is [added to the Cart](ctp:api:type:CartSetShippingMethodAction). + ### Example ```php @@ -4548,7 +4551,10 @@ $request = $builder ``` ## `withProjectKey("projectKey")->shippingMethods()->matchingCart()->get()` -null +Retrieves all the ShippingMethods that can ship to the shipping address of the given Cart. +Each ShippingMethod contains exactly one ShippingRate with the flag `isMatching` set to `true`. +This ShippingRate is used when the ShippingMethod is [added to the Cart](ctp:api:type:CartSetShippingMethodAction). + ### Example ```php @@ -4563,7 +4569,11 @@ $request = $builder ``` ## `withProjectKey("projectKey")->shippingMethods()->matchingLocation()->get()` -null +Retrieves all the ShippingMethods that can ship to the given [Location](/projects/zones#location). +If the `currency` parameter is given, then the ShippingMethods must also have a rate defined in the specified currency. +Each ShippingMethod contains at least one ShippingRate with the flag `isMatching` set to `true`. +If the `currency` parameter is given, exactly one ShippingRate will contain it. + ### Example ```php @@ -4578,7 +4588,9 @@ $request = $builder ``` ## `withProjectKey("projectKey")->shippingMethods()->matchingOrderedit()->get()` -null +Retrieves all the ShippingMethods that can ship to the given [Location](/projects/zones#location) for an [OrderEdit](/projects/order-edits). +In case the OrderEdit preview cannot be created an [EditPreviewFailed](ctp:api:type:EditPreviewFailedError) error is raised. + ### Example ```php diff --git a/lib/commercetools-api/src/Models/Error/MaxResourceLimitExceededError.php b/lib/commercetools-api/src/Models/Error/MaxResourceLimitExceededError.php index 534167c5334..ea338d21856 100644 --- a/lib/commercetools-api/src/Models/Error/MaxResourceLimitExceededError.php +++ b/lib/commercetools-api/src/Models/Error/MaxResourceLimitExceededError.php @@ -16,7 +16,7 @@ interface MaxResourceLimitExceededError extends ErrorObject public const FIELD_EXCEEDED_RESOURCE = 'exceededResource'; /** - *

supported resource type identifiers:

+ *

Type of resource the value should reference. Supported resource type identifiers are:

* * @return null|string */ diff --git a/lib/commercetools-api/src/Models/Error/MaxResourceLimitExceededErrorBuilder.php b/lib/commercetools-api/src/Models/Error/MaxResourceLimitExceededErrorBuilder.php index f0f42fa5db5..f30c29f96b7 100644 --- a/lib/commercetools-api/src/Models/Error/MaxResourceLimitExceededErrorBuilder.php +++ b/lib/commercetools-api/src/Models/Error/MaxResourceLimitExceededErrorBuilder.php @@ -39,7 +39,7 @@ public function getMessage() } /** - *

supported resource type identifiers:

+ *

Type of resource the value should reference. Supported resource type identifiers are:

* * @return null|string */ diff --git a/lib/commercetools-api/src/Models/Error/MaxResourceLimitExceededErrorModel.php b/lib/commercetools-api/src/Models/Error/MaxResourceLimitExceededErrorModel.php index 383e626e809..314f9c4d82c 100644 --- a/lib/commercetools-api/src/Models/Error/MaxResourceLimitExceededErrorModel.php +++ b/lib/commercetools-api/src/Models/Error/MaxResourceLimitExceededErrorModel.php @@ -83,7 +83,7 @@ public function getMessage() } /** - *

supported resource type identifiers:

+ *

Type of resource the value should reference. Supported resource type identifiers are:

* * @return null|string */ diff --git a/lib/commercetools-api/src/Models/Error/ReferenceExistsError.php b/lib/commercetools-api/src/Models/Error/ReferenceExistsError.php index c541fd53e72..08aa6e9fed5 100644 --- a/lib/commercetools-api/src/Models/Error/ReferenceExistsError.php +++ b/lib/commercetools-api/src/Models/Error/ReferenceExistsError.php @@ -16,7 +16,7 @@ interface ReferenceExistsError extends ErrorObject public const FIELD_REFERENCED_BY = 'referencedBy'; /** - *

supported resource type identifiers:

+ *

Type of resource the value should reference. Supported resource type identifiers are:

* * @return null|string */ diff --git a/lib/commercetools-api/src/Models/Error/ReferenceExistsErrorBuilder.php b/lib/commercetools-api/src/Models/Error/ReferenceExistsErrorBuilder.php index 6e09c99bd44..83695490a3b 100644 --- a/lib/commercetools-api/src/Models/Error/ReferenceExistsErrorBuilder.php +++ b/lib/commercetools-api/src/Models/Error/ReferenceExistsErrorBuilder.php @@ -39,7 +39,7 @@ public function getMessage() } /** - *

supported resource type identifiers:

+ *

Type of resource the value should reference. Supported resource type identifiers are:

* * @return null|string */ diff --git a/lib/commercetools-api/src/Models/Error/ReferenceExistsErrorModel.php b/lib/commercetools-api/src/Models/Error/ReferenceExistsErrorModel.php index b35f68df3fa..0ae4e2b8ab9 100644 --- a/lib/commercetools-api/src/Models/Error/ReferenceExistsErrorModel.php +++ b/lib/commercetools-api/src/Models/Error/ReferenceExistsErrorModel.php @@ -83,7 +83,7 @@ public function getMessage() } /** - *

supported resource type identifiers:

+ *

Type of resource the value should reference. Supported resource type identifiers are:

* * @return null|string */ diff --git a/lib/commercetools-api/src/Models/Error/ReferencedResourceNotFoundError.php b/lib/commercetools-api/src/Models/Error/ReferencedResourceNotFoundError.php index 0d84aa6c464..4f0608e9e84 100644 --- a/lib/commercetools-api/src/Models/Error/ReferencedResourceNotFoundError.php +++ b/lib/commercetools-api/src/Models/Error/ReferencedResourceNotFoundError.php @@ -18,7 +18,7 @@ interface ReferencedResourceNotFoundError extends ErrorObject public const FIELD_KEY = 'key'; /** - *

supported resource type identifiers:

+ *

Type of resource the value should reference. Supported resource type identifiers are:

* * @return null|string */ diff --git a/lib/commercetools-api/src/Models/Error/ReferencedResourceNotFoundErrorBuilder.php b/lib/commercetools-api/src/Models/Error/ReferencedResourceNotFoundErrorBuilder.php index 18f658c120c..919068e6abd 100644 --- a/lib/commercetools-api/src/Models/Error/ReferencedResourceNotFoundErrorBuilder.php +++ b/lib/commercetools-api/src/Models/Error/ReferencedResourceNotFoundErrorBuilder.php @@ -49,7 +49,7 @@ public function getMessage() } /** - *

supported resource type identifiers:

+ *

Type of resource the value should reference. Supported resource type identifiers are:

* * @return null|string */ diff --git a/lib/commercetools-api/src/Models/Error/ReferencedResourceNotFoundErrorModel.php b/lib/commercetools-api/src/Models/Error/ReferencedResourceNotFoundErrorModel.php index 8d34e1d7484..2d9b9d1693d 100644 --- a/lib/commercetools-api/src/Models/Error/ReferencedResourceNotFoundErrorModel.php +++ b/lib/commercetools-api/src/Models/Error/ReferencedResourceNotFoundErrorModel.php @@ -97,7 +97,7 @@ public function getMessage() } /** - *

supported resource type identifiers:

+ *

Type of resource the value should reference. Supported resource type identifiers are:

* * @return null|string */ diff --git a/lib/commercetools-api/src/Models/ProductType/AttributeDefinition.php b/lib/commercetools-api/src/Models/ProductType/AttributeDefinition.php index 1c9fce3282a..cd69132b64f 100644 --- a/lib/commercetools-api/src/Models/ProductType/AttributeDefinition.php +++ b/lib/commercetools-api/src/Models/ProductType/AttributeDefinition.php @@ -24,66 +24,60 @@ interface AttributeDefinition extends JsonObject public const FIELD_IS_SEARCHABLE = 'isSearchable'; /** - *

Describes the type of the attribute.

+ *

Describes the Type of the Attribute.

* * @return null|AttributeType */ public function getType(); /** - *

The unique name of the attribute used in the API. - * The name must be between two and 256 characters long and can contain the ASCII letters A to Z in lowercase or uppercase, digits, underscores (_) and the hyphen-minus (-). - * When using the same name for an attribute in two or more product types all fields of the AttributeDefinition of this attribute need to be the same across the product types, otherwise an AttributeDefinitionAlreadyExists error code will be returned. - * An exception to this are the values of an enum or lenum type and sets thereof.

+ *

User-defined name of the Attribute that is unique within the Project.

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

A human-readable label for the attribute.

+ *

Human-readable label for the Attribute.

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

Whether the attribute is required to have a value.

+ *

If true, the Attribute must have a value on a ProductVariant.

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

Describes how an attribute or a set of attributes should be validated across all variants of a product.

+ *

Specifies how Attributes are validated across all variants of a Product.

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

Additional information about the attribute that aids content managers when setting product details.

+ *

Provides additional Attribute information to aid content managers configure Product details.

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

Provides a visual representation type for this attribute. - * only relevant for text-based attribute types - * like TextType and LocalizableTextType.

+ *

Provides a visual representation directive for values of this Attribute (only relevant for AttributeTextType and AttributeLocalizableTextType).

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

Whether the attribute's values should generally be enabled in product search. - * This determines whether the value is stored in products for matching terms in the context of full-text search queries and can be used in facets & filters as part of product search queries. - * The exact features that are enabled/disabled with this flag depend on the concrete attribute type and are described there. - * The max size of a searchable field is restricted to 10922 characters. - * This constraint is enforced at both product creation and product update. - * If the length of the input exceeds the maximum size an InvalidField error is returned.

+ *

If true, the Attribute's values are available for the Product Projections Search API for use in full-text search queries, filters, and facets.

+ *

Which exact features are available with this flag depends on the specific AttributeType. + * The maximum size of a searchable field is restricted by the Field content size limit. + * This constraint is enforced at both Product creation and Product update. + * If the length of the input exceeds the maximum size, an InvalidFieldError is returned.

* * @return null|bool */ diff --git a/lib/commercetools-api/src/Models/ProductType/AttributeDefinitionBuilder.php b/lib/commercetools-api/src/Models/ProductType/AttributeDefinitionBuilder.php index 4cc63b78e80..5decfc94a4a 100644 --- a/lib/commercetools-api/src/Models/ProductType/AttributeDefinitionBuilder.php +++ b/lib/commercetools-api/src/Models/ProductType/AttributeDefinitionBuilder.php @@ -63,7 +63,7 @@ final class AttributeDefinitionBuilder implements Builder private $isSearchable; /** - *

Describes the type of the attribute.

+ *

Describes the Type of the Attribute.

* * @return null|AttributeType */ @@ -73,10 +73,7 @@ public function getType() } /** - *

The unique name of the attribute used in the API. - * The name must be between two and 256 characters long and can contain the ASCII letters A to Z in lowercase or uppercase, digits, underscores (_) and the hyphen-minus (-). - * When using the same name for an attribute in two or more product types all fields of the AttributeDefinition of this attribute need to be the same across the product types, otherwise an AttributeDefinitionAlreadyExists error code will be returned. - * An exception to this are the values of an enum or lenum type and sets thereof.

+ *

User-defined name of the Attribute that is unique within the Project.

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

A human-readable label for the attribute.

+ *

Human-readable label for the Attribute.

* * @return null|LocalizedString */ @@ -96,7 +93,7 @@ public function getLabel() } /** - *

Whether the attribute is required to have a value.

+ *

If true, the Attribute must have a value on a ProductVariant.

* * @return null|bool */ @@ -106,7 +103,7 @@ public function getIsRequired() } /** - *

Describes how an attribute or a set of attributes should be validated across all variants of a product.

+ *

Specifies how Attributes are validated across all variants of a Product.

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

Additional information about the attribute that aids content managers when setting product details.

+ *

Provides additional Attribute information to aid content managers configure Product details.

* * @return null|LocalizedString */ @@ -126,9 +123,7 @@ public function getInputTip() } /** - *

Provides a visual representation type for this attribute. - * only relevant for text-based attribute types - * like TextType and LocalizableTextType.

+ *

Provides a visual representation directive for values of this Attribute (only relevant for AttributeTextType and AttributeLocalizableTextType).

* * @return null|string */ @@ -138,12 +133,11 @@ public function getInputHint() } /** - *

Whether the attribute's values should generally be enabled in product search. - * This determines whether the value is stored in products for matching terms in the context of full-text search queries and can be used in facets & filters as part of product search queries. - * The exact features that are enabled/disabled with this flag depend on the concrete attribute type and are described there. - * The max size of a searchable field is restricted to 10922 characters. - * This constraint is enforced at both product creation and product update. - * If the length of the input exceeds the maximum size an InvalidField error is returned.

+ *

If true, the Attribute's values are available for the Product Projections Search API for use in full-text search queries, filters, and facets.

+ *

Which exact features are available with this flag depends on the specific AttributeType. + * The maximum size of a searchable field is restricted by the Field content size limit. + * This constraint is enforced at both Product creation and Product update. + * If the length of the input exceeds the maximum size, an InvalidFieldError is returned.

* * @return null|bool */ diff --git a/lib/commercetools-api/src/Models/ProductType/AttributeDefinitionDraft.php b/lib/commercetools-api/src/Models/ProductType/AttributeDefinitionDraft.php index 94ac71a4536..62940aba3b4 100644 --- a/lib/commercetools-api/src/Models/ProductType/AttributeDefinitionDraft.php +++ b/lib/commercetools-api/src/Models/ProductType/AttributeDefinitionDraft.php @@ -24,61 +24,62 @@ interface AttributeDefinitionDraft extends JsonObject public const FIELD_IS_SEARCHABLE = 'isSearchable'; /** - *

Describes the type of the attribute.

+ *

Describes the Type of the Attribute.

* * @return null|AttributeType */ public function getType(); /** - *

The unique name of the attribute used in the API. - * The name must be between two and 256 characters long and can contain the ASCII letters A to Z in lowercase or uppercase, digits, underscores (_) and the hyphen-minus (-). - * When using the same name for an attribute in two or more product types all fields of the AttributeDefinition of this attribute need to be the same across the product types.

+ *

User-defined name of the Attribute that is unique with the Project. + * When using the same name for an Attribute in multiple ProductTypes, all fields of the AttributeDefinition of this Attribute must be the same across the ProductTypes. Otherwise an AttributeDefinitionAlreadyExistsError will be returned. + * An exception to this are the values of an enum or lenum Type and sets thereof.

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

A human-readable label for the attribute.

+ *

Human-readable label for the Attribute.

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

Whether the attribute is required to have a value.

+ *

Set to true if the Attribute is required to have a value on a ProductVariant.

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

Describes how an attribute or a set of attributes should be validated across all variants of a product.

+ *

Specifies how an Attribute or a combination of Attributes should be validated across all variants of a Product.

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

Additional information about the attribute that aids content managers when setting product details.

+ *

Provides additional information about the Attribute that aids content managers when setting Product details.

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

Provides a visual representation type for this attribute. - * only relevant for text-based attribute types like TextType and LocalizableTextType.

+ *

Provides a visual representation directive for values of this Attribute (only relevant for AttributeTextType and AttributeLocalizableTextType).

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

Whether the attribute's values should generally be enabled in product search. - * This determines whether the value is stored in products for matching terms in the context of full-text search queries and can be used in facets & filters as part of product search queries. - * The exact features that are enabled/disabled with this flag depend on the concrete attribute type and are described there.

+ *

Set to true if the Attribute's values should be available in the Product Projections Search API and can be used in full-text search queries, filters, and facets. + * Which exact features are available with this flag depends on the specific AttributeType. + * The maximum size of a searchable field is restricted by the Field content size limit. + * This constraint is enforced at both Product creation and Product update. + * If the length of the input exceeds the maximum size, an InvalidField error is returned.

* * @return null|bool */ diff --git a/lib/commercetools-api/src/Models/ProductType/AttributeDefinitionDraftBuilder.php b/lib/commercetools-api/src/Models/ProductType/AttributeDefinitionDraftBuilder.php index 052274dadab..43c1e4326e0 100644 --- a/lib/commercetools-api/src/Models/ProductType/AttributeDefinitionDraftBuilder.php +++ b/lib/commercetools-api/src/Models/ProductType/AttributeDefinitionDraftBuilder.php @@ -63,7 +63,7 @@ final class AttributeDefinitionDraftBuilder implements Builder private $isSearchable; /** - *

Describes the type of the attribute.

+ *

Describes the Type of the Attribute.

* * @return null|AttributeType */ @@ -73,9 +73,9 @@ public function getType() } /** - *

The unique name of the attribute used in the API. - * The name must be between two and 256 characters long and can contain the ASCII letters A to Z in lowercase or uppercase, digits, underscores (_) and the hyphen-minus (-). - * When using the same name for an attribute in two or more product types all fields of the AttributeDefinition of this attribute need to be the same across the product types.

+ *

User-defined name of the Attribute that is unique with the Project. + * When using the same name for an Attribute in multiple ProductTypes, all fields of the AttributeDefinition of this Attribute must be the same across the ProductTypes. Otherwise an AttributeDefinitionAlreadyExistsError will be returned. + * An exception to this are the values of an enum or lenum Type and sets thereof.

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

A human-readable label for the attribute.

+ *

Human-readable label for the Attribute.

* * @return null|LocalizedString */ @@ -95,7 +95,7 @@ public function getLabel() } /** - *

Whether the attribute is required to have a value.

+ *

Set to true if the Attribute is required to have a value on a ProductVariant.

* * @return null|bool */ @@ -105,7 +105,7 @@ public function getIsRequired() } /** - *

Describes how an attribute or a set of attributes should be validated across all variants of a product.

+ *

Specifies how an Attribute or a combination of Attributes should be validated across all variants of a Product.

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

Additional information about the attribute that aids content managers when setting product details.

+ *

Provides additional information about the Attribute that aids content managers when setting Product details.

* * @return null|LocalizedString */ @@ -125,8 +125,7 @@ public function getInputTip() } /** - *

Provides a visual representation type for this attribute. - * only relevant for text-based attribute types like TextType and LocalizableTextType.

+ *

Provides a visual representation directive for values of this Attribute (only relevant for AttributeTextType and AttributeLocalizableTextType).

* * @return null|string */ @@ -136,9 +135,11 @@ public function getInputHint() } /** - *

Whether the attribute's values should generally be enabled in product search. - * This determines whether the value is stored in products for matching terms in the context of full-text search queries and can be used in facets & filters as part of product search queries. - * The exact features that are enabled/disabled with this flag depend on the concrete attribute type and are described there.

+ *

Set to true if the Attribute's values should be available in the Product Projections Search API and can be used in full-text search queries, filters, and facets. + * Which exact features are available with this flag depends on the specific AttributeType. + * The maximum size of a searchable field is restricted by the Field content size limit. + * This constraint is enforced at both Product creation and Product update. + * If the length of the input exceeds the maximum size, an InvalidField error is returned.

* * @return null|bool */ diff --git a/lib/commercetools-api/src/Models/ProductType/AttributeDefinitionDraftModel.php b/lib/commercetools-api/src/Models/ProductType/AttributeDefinitionDraftModel.php index 910624bc495..dd0b4049cbf 100644 --- a/lib/commercetools-api/src/Models/ProductType/AttributeDefinitionDraftModel.php +++ b/lib/commercetools-api/src/Models/ProductType/AttributeDefinitionDraftModel.php @@ -86,7 +86,7 @@ public function __construct( } /** - *

Describes the type of the attribute.

+ *

Describes the Type of the Attribute.

* * @return null|AttributeType */ @@ -106,9 +106,9 @@ public function getType() } /** - *

The unique name of the attribute used in the API. - * The name must be between two and 256 characters long and can contain the ASCII letters A to Z in lowercase or uppercase, digits, underscores (_) and the hyphen-minus (-). - * When using the same name for an attribute in two or more product types all fields of the AttributeDefinition of this attribute need to be the same across the product types.

+ *

User-defined name of the Attribute that is unique with the Project. + * When using the same name for an Attribute in multiple ProductTypes, all fields of the AttributeDefinition of this Attribute must be the same across the ProductTypes. Otherwise an AttributeDefinitionAlreadyExistsError will be returned. + * An exception to this are the values of an enum or lenum Type and sets thereof.

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

A human-readable label for the attribute.

+ *

Human-readable label for the Attribute.

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

Whether the attribute is required to have a value.

+ *

Set to true if the Attribute is required to have a value on a ProductVariant.

* * @return null|bool */ @@ -166,7 +166,7 @@ public function getIsRequired() } /** - *

Describes how an attribute or a set of attributes should be validated across all variants of a product.

+ *

Specifies how an Attribute or a combination of Attributes should be validated across all variants of a Product.

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

Additional information about the attribute that aids content managers when setting product details.

+ *

Provides additional information about the Attribute that aids content managers when setting Product details.

* * @return null|LocalizedString */ @@ -205,8 +205,7 @@ public function getInputTip() } /** - *

Provides a visual representation type for this attribute. - * only relevant for text-based attribute types like TextType and LocalizableTextType.

+ *

Provides a visual representation directive for values of this Attribute (only relevant for AttributeTextType and AttributeLocalizableTextType).

* * @return null|string */ @@ -225,9 +224,11 @@ public function getInputHint() } /** - *

Whether the attribute's values should generally be enabled in product search. - * This determines whether the value is stored in products for matching terms in the context of full-text search queries and can be used in facets & filters as part of product search queries. - * The exact features that are enabled/disabled with this flag depend on the concrete attribute type and are described there.

+ *

Set to true if the Attribute's values should be available in the Product Projections Search API and can be used in full-text search queries, filters, and facets. + * Which exact features are available with this flag depends on the specific AttributeType. + * The maximum size of a searchable field is restricted by the Field content size limit. + * This constraint is enforced at both Product creation and Product update. + * If the length of the input exceeds the maximum size, an InvalidField error is returned.

* * @return null|bool */ diff --git a/lib/commercetools-api/src/Models/ProductType/AttributeDefinitionModel.php b/lib/commercetools-api/src/Models/ProductType/AttributeDefinitionModel.php index 7f62776c7a1..1771f9ddba2 100644 --- a/lib/commercetools-api/src/Models/ProductType/AttributeDefinitionModel.php +++ b/lib/commercetools-api/src/Models/ProductType/AttributeDefinitionModel.php @@ -86,7 +86,7 @@ public function __construct( } /** - *

Describes the type of the attribute.

+ *

Describes the Type of the Attribute.

* * @return null|AttributeType */ @@ -106,10 +106,7 @@ public function getType() } /** - *

The unique name of the attribute used in the API. - * The name must be between two and 256 characters long and can contain the ASCII letters A to Z in lowercase or uppercase, digits, underscores (_) and the hyphen-minus (-). - * When using the same name for an attribute in two or more product types all fields of the AttributeDefinition of this attribute need to be the same across the product types, otherwise an AttributeDefinitionAlreadyExists error code will be returned. - * An exception to this are the values of an enum or lenum type and sets thereof.

+ *

User-defined name of the Attribute that is unique within the Project.

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

A human-readable label for the attribute.

+ *

Human-readable label for the Attribute.

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

Whether the attribute is required to have a value.

+ *

If true, the Attribute must have a value on a ProductVariant.

* * @return null|bool */ @@ -167,7 +164,7 @@ public function getIsRequired() } /** - *

Describes how an attribute or a set of attributes should be validated across all variants of a product.

+ *

Specifies how Attributes are validated across all variants of a Product.

* * @return null|string */ @@ -186,7 +183,7 @@ public function getAttributeConstraint() } /** - *

Additional information about the attribute that aids content managers when setting product details.

+ *

Provides additional Attribute information to aid content managers configure Product details.

* * @return null|LocalizedString */ @@ -206,9 +203,7 @@ public function getInputTip() } /** - *

Provides a visual representation type for this attribute. - * only relevant for text-based attribute types - * like TextType and LocalizableTextType.

+ *

Provides a visual representation directive for values of this Attribute (only relevant for AttributeTextType and AttributeLocalizableTextType).

* * @return null|string */ @@ -227,12 +222,11 @@ public function getInputHint() } /** - *

Whether the attribute's values should generally be enabled in product search. - * This determines whether the value is stored in products for matching terms in the context of full-text search queries and can be used in facets & filters as part of product search queries. - * The exact features that are enabled/disabled with this flag depend on the concrete attribute type and are described there. - * The max size of a searchable field is restricted to 10922 characters. - * This constraint is enforced at both product creation and product update. - * If the length of the input exceeds the maximum size an InvalidField error is returned.

+ *

If true, the Attribute's values are available for the Product Projections Search API for use in full-text search queries, filters, and facets.

+ *

Which exact features are available with this flag depends on the specific AttributeType. + * The maximum size of a searchable field is restricted by the Field content size limit. + * This constraint is enforced at both Product creation and Product update. + * If the length of the input exceeds the maximum size, an InvalidFieldError is returned.

* * @return null|bool */ diff --git a/lib/commercetools-api/src/Models/ProductType/AttributeEnumType.php b/lib/commercetools-api/src/Models/ProductType/AttributeEnumType.php index f887386994f..89e74bfa913 100644 --- a/lib/commercetools-api/src/Models/ProductType/AttributeEnumType.php +++ b/lib/commercetools-api/src/Models/ProductType/AttributeEnumType.php @@ -16,6 +16,8 @@ interface AttributeEnumType extends AttributeType public const FIELD_VALUES = 'values'; /** + *

Available values that can be assigned to Products.

+ * * @return null|AttributePlainEnumValueCollection */ public function getValues(); diff --git a/lib/commercetools-api/src/Models/ProductType/AttributeEnumTypeBuilder.php b/lib/commercetools-api/src/Models/ProductType/AttributeEnumTypeBuilder.php index 051ce797641..16389ab03d3 100644 --- a/lib/commercetools-api/src/Models/ProductType/AttributeEnumTypeBuilder.php +++ b/lib/commercetools-api/src/Models/ProductType/AttributeEnumTypeBuilder.php @@ -26,6 +26,8 @@ final class AttributeEnumTypeBuilder implements Builder private $values; /** + *

Available values that can be assigned to Products.

+ * * @return null|AttributePlainEnumValueCollection */ public function getValues() diff --git a/lib/commercetools-api/src/Models/ProductType/AttributeEnumTypeModel.php b/lib/commercetools-api/src/Models/ProductType/AttributeEnumTypeModel.php index d6b6329b512..ac2f1f2e3cc 100644 --- a/lib/commercetools-api/src/Models/ProductType/AttributeEnumTypeModel.php +++ b/lib/commercetools-api/src/Models/ProductType/AttributeEnumTypeModel.php @@ -59,6 +59,8 @@ public function getName() } /** + *

Available values that can be assigned to Products.

+ * * @return null|AttributePlainEnumValueCollection */ public function getValues() diff --git a/lib/commercetools-api/src/Models/ProductType/AttributeLocalizedEnumType.php b/lib/commercetools-api/src/Models/ProductType/AttributeLocalizedEnumType.php index 47e330fd22e..ce064d10f67 100644 --- a/lib/commercetools-api/src/Models/ProductType/AttributeLocalizedEnumType.php +++ b/lib/commercetools-api/src/Models/ProductType/AttributeLocalizedEnumType.php @@ -16,6 +16,8 @@ interface AttributeLocalizedEnumType extends AttributeType public const FIELD_VALUES = 'values'; /** + *

Available values that can be assigned to Products.

+ * * @return null|AttributeLocalizedEnumValueCollection */ public function getValues(); diff --git a/lib/commercetools-api/src/Models/ProductType/AttributeLocalizedEnumTypeBuilder.php b/lib/commercetools-api/src/Models/ProductType/AttributeLocalizedEnumTypeBuilder.php index b4dbf451d2a..aaef738e8cc 100644 --- a/lib/commercetools-api/src/Models/ProductType/AttributeLocalizedEnumTypeBuilder.php +++ b/lib/commercetools-api/src/Models/ProductType/AttributeLocalizedEnumTypeBuilder.php @@ -26,6 +26,8 @@ final class AttributeLocalizedEnumTypeBuilder implements Builder private $values; /** + *

Available values that can be assigned to Products.

+ * * @return null|AttributeLocalizedEnumValueCollection */ public function getValues() diff --git a/lib/commercetools-api/src/Models/ProductType/AttributeLocalizedEnumTypeModel.php b/lib/commercetools-api/src/Models/ProductType/AttributeLocalizedEnumTypeModel.php index 698921a2a6c..ba6d0d59ff4 100644 --- a/lib/commercetools-api/src/Models/ProductType/AttributeLocalizedEnumTypeModel.php +++ b/lib/commercetools-api/src/Models/ProductType/AttributeLocalizedEnumTypeModel.php @@ -59,6 +59,8 @@ public function getName() } /** + *

Available values that can be assigned to Products.

+ * * @return null|AttributeLocalizedEnumValueCollection */ public function getValues() diff --git a/lib/commercetools-api/src/Models/ProductType/AttributeLocalizedEnumValue.php b/lib/commercetools-api/src/Models/ProductType/AttributeLocalizedEnumValue.php index f71d3b4b119..4709d802834 100644 --- a/lib/commercetools-api/src/Models/ProductType/AttributeLocalizedEnumValue.php +++ b/lib/commercetools-api/src/Models/ProductType/AttributeLocalizedEnumValue.php @@ -18,12 +18,14 @@ interface AttributeLocalizedEnumValue extends JsonObject public const FIELD_LABEL = 'label'; /** + *

Key of the value used as a programmatic identifier, for example in facets & filters.

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

JSON object where the keys are of type Locale, and the values are the strings used for the corresponding language.

+ *

Descriptive, localized label of the value.

* * @return null|LocalizedString */ diff --git a/lib/commercetools-api/src/Models/ProductType/AttributeLocalizedEnumValueBuilder.php b/lib/commercetools-api/src/Models/ProductType/AttributeLocalizedEnumValueBuilder.php index d1920a88fd4..d607c72cee5 100644 --- a/lib/commercetools-api/src/Models/ProductType/AttributeLocalizedEnumValueBuilder.php +++ b/lib/commercetools-api/src/Models/ProductType/AttributeLocalizedEnumValueBuilder.php @@ -33,6 +33,8 @@ final class AttributeLocalizedEnumValueBuilder implements Builder private $label; /** + *

Key of the value used as a programmatic identifier, for example in facets & filters.

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

JSON object where the keys are of type Locale, and the values are the strings used for the corresponding language.

+ *

Descriptive, localized label of the value.

* * @return null|LocalizedString */ diff --git a/lib/commercetools-api/src/Models/ProductType/AttributeLocalizedEnumValueModel.php b/lib/commercetools-api/src/Models/ProductType/AttributeLocalizedEnumValueModel.php index 1669c9da582..482858bad12 100644 --- a/lib/commercetools-api/src/Models/ProductType/AttributeLocalizedEnumValueModel.php +++ b/lib/commercetools-api/src/Models/ProductType/AttributeLocalizedEnumValueModel.php @@ -44,6 +44,8 @@ public function __construct( } /** + *

Key of the value used as a programmatic identifier, for example in facets & filters.

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

JSON object where the keys are of type Locale, and the values are the strings used for the corresponding language.

+ *

Descriptive, localized label of the value.

* * @return null|LocalizedString */ diff --git a/lib/commercetools-api/src/Models/ProductType/AttributeNestedType.php b/lib/commercetools-api/src/Models/ProductType/AttributeNestedType.php index 6a15f14a53e..e56a0020e2d 100644 --- a/lib/commercetools-api/src/Models/ProductType/AttributeNestedType.php +++ b/lib/commercetools-api/src/Models/ProductType/AttributeNestedType.php @@ -16,7 +16,7 @@ interface AttributeNestedType extends AttributeType public const FIELD_TYPE_REFERENCE = 'typeReference'; /** - *

Reference to a ProductType.

+ *

Attributes that can be stored as nested Attributes of the current Attribute.

* * @return null|ProductTypeReference */ diff --git a/lib/commercetools-api/src/Models/ProductType/AttributeNestedTypeBuilder.php b/lib/commercetools-api/src/Models/ProductType/AttributeNestedTypeBuilder.php index 1b6e94c30f3..e21745c54f1 100644 --- a/lib/commercetools-api/src/Models/ProductType/AttributeNestedTypeBuilder.php +++ b/lib/commercetools-api/src/Models/ProductType/AttributeNestedTypeBuilder.php @@ -26,7 +26,7 @@ final class AttributeNestedTypeBuilder implements Builder private $typeReference; /** - *

Reference to a ProductType.

+ *

Attributes that can be stored as nested Attributes of the current Attribute.

* * @return null|ProductTypeReference */ diff --git a/lib/commercetools-api/src/Models/ProductType/AttributeNestedTypeModel.php b/lib/commercetools-api/src/Models/ProductType/AttributeNestedTypeModel.php index 5f2acf0a7d1..b4d0560f603 100644 --- a/lib/commercetools-api/src/Models/ProductType/AttributeNestedTypeModel.php +++ b/lib/commercetools-api/src/Models/ProductType/AttributeNestedTypeModel.php @@ -59,7 +59,7 @@ public function getName() } /** - *

Reference to a ProductType.

+ *

Attributes that can be stored as nested Attributes of the current Attribute.

* * @return null|ProductTypeReference */ diff --git a/lib/commercetools-api/src/Models/ProductType/AttributePlainEnumValue.php b/lib/commercetools-api/src/Models/ProductType/AttributePlainEnumValue.php index c0c2621dd28..ae87d2f12a7 100644 --- a/lib/commercetools-api/src/Models/ProductType/AttributePlainEnumValue.php +++ b/lib/commercetools-api/src/Models/ProductType/AttributePlainEnumValue.php @@ -17,11 +17,15 @@ interface AttributePlainEnumValue extends JsonObject public const FIELD_LABEL = 'label'; /** + *

Key of the value used as a programmatic identifier, for example in facets & filters.

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

Descriptive label of the value.

+ * * @return null|string */ public function getLabel(); diff --git a/lib/commercetools-api/src/Models/ProductType/AttributePlainEnumValueBuilder.php b/lib/commercetools-api/src/Models/ProductType/AttributePlainEnumValueBuilder.php index bc81e61cd89..19d4755ccf5 100644 --- a/lib/commercetools-api/src/Models/ProductType/AttributePlainEnumValueBuilder.php +++ b/lib/commercetools-api/src/Models/ProductType/AttributePlainEnumValueBuilder.php @@ -31,6 +31,8 @@ final class AttributePlainEnumValueBuilder implements Builder private $label; /** + *

Key of the value used as a programmatic identifier, for example in facets & filters.

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

Descriptive label of the value.

+ * * @return null|string */ public function getLabel() diff --git a/lib/commercetools-api/src/Models/ProductType/AttributePlainEnumValueModel.php b/lib/commercetools-api/src/Models/ProductType/AttributePlainEnumValueModel.php index 3403501869b..507c9a46356 100644 --- a/lib/commercetools-api/src/Models/ProductType/AttributePlainEnumValueModel.php +++ b/lib/commercetools-api/src/Models/ProductType/AttributePlainEnumValueModel.php @@ -42,6 +42,8 @@ public function __construct( } /** + *

Key of the value used as a programmatic identifier, for example in facets & filters.

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

Descriptive label of the value.

+ * * @return null|string */ public function getLabel() diff --git a/lib/commercetools-api/src/Models/ProductType/AttributeReferenceType.php b/lib/commercetools-api/src/Models/ProductType/AttributeReferenceType.php index 9a7d020aae4..ee7feddea96 100644 --- a/lib/commercetools-api/src/Models/ProductType/AttributeReferenceType.php +++ b/lib/commercetools-api/src/Models/ProductType/AttributeReferenceType.php @@ -16,7 +16,7 @@ interface AttributeReferenceType extends AttributeType public const FIELD_REFERENCE_TYPE_ID = 'referenceTypeId'; /** - *

supported resource type identifiers:

+ *

Name of the resource type that the value should reference.

* * @return null|string */ diff --git a/lib/commercetools-api/src/Models/ProductType/AttributeReferenceTypeBuilder.php b/lib/commercetools-api/src/Models/ProductType/AttributeReferenceTypeBuilder.php index b3849db4c70..014e28eded7 100644 --- a/lib/commercetools-api/src/Models/ProductType/AttributeReferenceTypeBuilder.php +++ b/lib/commercetools-api/src/Models/ProductType/AttributeReferenceTypeBuilder.php @@ -26,7 +26,7 @@ final class AttributeReferenceTypeBuilder implements Builder private $referenceTypeId; /** - *

supported resource type identifiers:

+ *

Name of the resource type that the value should reference.

* * @return null|string */ diff --git a/lib/commercetools-api/src/Models/ProductType/AttributeReferenceTypeModel.php b/lib/commercetools-api/src/Models/ProductType/AttributeReferenceTypeModel.php index 4f611ef54e8..819000b813e 100644 --- a/lib/commercetools-api/src/Models/ProductType/AttributeReferenceTypeModel.php +++ b/lib/commercetools-api/src/Models/ProductType/AttributeReferenceTypeModel.php @@ -59,7 +59,7 @@ public function getName() } /** - *

supported resource type identifiers:

+ *

Name of the resource type that the value should reference.

* * @return null|string */ diff --git a/lib/commercetools-api/src/Models/ProductType/AttributeSetType.php b/lib/commercetools-api/src/Models/ProductType/AttributeSetType.php index 11f3eda5241..47018f56394 100644 --- a/lib/commercetools-api/src/Models/ProductType/AttributeSetType.php +++ b/lib/commercetools-api/src/Models/ProductType/AttributeSetType.php @@ -16,6 +16,8 @@ interface AttributeSetType extends AttributeType public const FIELD_ELEMENT_TYPE = 'elementType'; /** + *

Attribute type of the elements in the set.

+ * * @return null|AttributeType */ public function getElementType(); diff --git a/lib/commercetools-api/src/Models/ProductType/AttributeSetTypeBuilder.php b/lib/commercetools-api/src/Models/ProductType/AttributeSetTypeBuilder.php index b7b5ca50d47..f4f117a7c12 100644 --- a/lib/commercetools-api/src/Models/ProductType/AttributeSetTypeBuilder.php +++ b/lib/commercetools-api/src/Models/ProductType/AttributeSetTypeBuilder.php @@ -26,6 +26,8 @@ final class AttributeSetTypeBuilder implements Builder private $elementType; /** + *

Attribute type of the elements in the set.

+ * * @return null|AttributeType */ public function getElementType() diff --git a/lib/commercetools-api/src/Models/ProductType/AttributeSetTypeModel.php b/lib/commercetools-api/src/Models/ProductType/AttributeSetTypeModel.php index a028b31d22d..1414770c1f8 100644 --- a/lib/commercetools-api/src/Models/ProductType/AttributeSetTypeModel.php +++ b/lib/commercetools-api/src/Models/ProductType/AttributeSetTypeModel.php @@ -59,6 +59,8 @@ public function getName() } /** + *

Attribute type of the elements in the set.

+ * * @return null|AttributeType */ public function getElementType() @@ -69,8 +71,8 @@ public function getElementType() if (is_null($data)) { return null; } - $className = AttributeTypeModel::resolveDiscriminatorClass($data); - $this->elementType = $className::of($data); + + $this->elementType = AttributeTypeModel::of($data); } return $this->elementType; diff --git a/lib/commercetools-api/src/Models/ProductType/ProductType.php b/lib/commercetools-api/src/Models/ProductType/ProductType.php index ea571be8fd4..e093b61810a 100644 --- a/lib/commercetools-api/src/Models/ProductType/ProductType.php +++ b/lib/commercetools-api/src/Models/ProductType/ProductType.php @@ -25,25 +25,29 @@ interface ProductType extends BaseResource public const FIELD_ATTRIBUTES = 'attributes'; /** - *

Unique identifier for the ProductType.

+ *

Unique identifier of the ProductType.

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

The current version of the product type.

+ *

Current version of the ProductType.

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

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

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

Date and time (UTC) the Channel was last updated.

+ * * @return null|DateTimeImmutable */ public function getLastModifiedAt(); @@ -70,16 +74,22 @@ public function getCreatedBy(); public function getKey(); /** + *

Name of the ProductType.

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

Description of the ProductType.

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

Attributes specified for the ProductType.

+ * * @return null|AttributeDefinitionCollection */ public function getAttributes(); diff --git a/lib/commercetools-api/src/Models/ProductType/ProductTypeAddAttributeDefinitionAction.php b/lib/commercetools-api/src/Models/ProductType/ProductTypeAddAttributeDefinitionAction.php index 817cac6149b..f749028c2e4 100644 --- a/lib/commercetools-api/src/Models/ProductType/ProductTypeAddAttributeDefinitionAction.php +++ b/lib/commercetools-api/src/Models/ProductType/ProductTypeAddAttributeDefinitionAction.php @@ -16,6 +16,8 @@ interface ProductTypeAddAttributeDefinitionAction extends ProductTypeUpdateActio public const FIELD_ATTRIBUTE = 'attribute'; /** + *

Value to append to attributes.

+ * * @return null|AttributeDefinitionDraft */ public function getAttribute(); diff --git a/lib/commercetools-api/src/Models/ProductType/ProductTypeAddAttributeDefinitionActionBuilder.php b/lib/commercetools-api/src/Models/ProductType/ProductTypeAddAttributeDefinitionActionBuilder.php index 06d8944b23f..d7c11fe38a2 100644 --- a/lib/commercetools-api/src/Models/ProductType/ProductTypeAddAttributeDefinitionActionBuilder.php +++ b/lib/commercetools-api/src/Models/ProductType/ProductTypeAddAttributeDefinitionActionBuilder.php @@ -26,6 +26,8 @@ final class ProductTypeAddAttributeDefinitionActionBuilder implements Builder private $attribute; /** + *

Value to append to attributes.

+ * * @return null|AttributeDefinitionDraft */ public function getAttribute() diff --git a/lib/commercetools-api/src/Models/ProductType/ProductTypeAddAttributeDefinitionActionModel.php b/lib/commercetools-api/src/Models/ProductType/ProductTypeAddAttributeDefinitionActionModel.php index d513687e505..a6790e31ca2 100644 --- a/lib/commercetools-api/src/Models/ProductType/ProductTypeAddAttributeDefinitionActionModel.php +++ b/lib/commercetools-api/src/Models/ProductType/ProductTypeAddAttributeDefinitionActionModel.php @@ -59,6 +59,8 @@ public function getAction() } /** + *

Value to append to attributes.

+ * * @return null|AttributeDefinitionDraft */ public function getAttribute() diff --git a/lib/commercetools-api/src/Models/ProductType/ProductTypeAddLocalizedEnumValueAction.php b/lib/commercetools-api/src/Models/ProductType/ProductTypeAddLocalizedEnumValueAction.php index b5828739bb3..98902593811 100644 --- a/lib/commercetools-api/src/Models/ProductType/ProductTypeAddLocalizedEnumValueAction.php +++ b/lib/commercetools-api/src/Models/ProductType/ProductTypeAddLocalizedEnumValueAction.php @@ -17,11 +17,15 @@ interface ProductTypeAddLocalizedEnumValueAction extends ProductTypeUpdateAction public const FIELD_VALUE = 'value'; /** + *

Name of the AttributeDefinition to update.

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

Value to append to the array.

+ * * @return null|AttributeLocalizedEnumValue */ public function getValue(); diff --git a/lib/commercetools-api/src/Models/ProductType/ProductTypeAddLocalizedEnumValueActionBuilder.php b/lib/commercetools-api/src/Models/ProductType/ProductTypeAddLocalizedEnumValueActionBuilder.php index 0d9ebe64fd7..70bb5fbf0a0 100644 --- a/lib/commercetools-api/src/Models/ProductType/ProductTypeAddLocalizedEnumValueActionBuilder.php +++ b/lib/commercetools-api/src/Models/ProductType/ProductTypeAddLocalizedEnumValueActionBuilder.php @@ -31,6 +31,8 @@ final class ProductTypeAddLocalizedEnumValueActionBuilder implements Builder private $value; /** + *

Name of the AttributeDefinition to update.

+ * * @return null|string */ public function getAttributeName() @@ -39,6 +41,8 @@ public function getAttributeName() } /** + *

Value to append to the array.

+ * * @return null|AttributeLocalizedEnumValue */ public function getValue() diff --git a/lib/commercetools-api/src/Models/ProductType/ProductTypeAddLocalizedEnumValueActionModel.php b/lib/commercetools-api/src/Models/ProductType/ProductTypeAddLocalizedEnumValueActionModel.php index a553089135a..f274c4d74f2 100644 --- a/lib/commercetools-api/src/Models/ProductType/ProductTypeAddLocalizedEnumValueActionModel.php +++ b/lib/commercetools-api/src/Models/ProductType/ProductTypeAddLocalizedEnumValueActionModel.php @@ -66,6 +66,8 @@ public function getAction() } /** + *

Name of the AttributeDefinition to update.

+ * * @return null|string */ public function getAttributeName() @@ -83,6 +85,8 @@ public function getAttributeName() } /** + *

Value to append to the array.

+ * * @return null|AttributeLocalizedEnumValue */ public function getValue() diff --git a/lib/commercetools-api/src/Models/ProductType/ProductTypeAddPlainEnumValueAction.php b/lib/commercetools-api/src/Models/ProductType/ProductTypeAddPlainEnumValueAction.php index a435475a3e1..2b950e61714 100644 --- a/lib/commercetools-api/src/Models/ProductType/ProductTypeAddPlainEnumValueAction.php +++ b/lib/commercetools-api/src/Models/ProductType/ProductTypeAddPlainEnumValueAction.php @@ -17,11 +17,15 @@ interface ProductTypeAddPlainEnumValueAction extends ProductTypeUpdateAction public const FIELD_VALUE = 'value'; /** + *

Name of the AttributeDefinition to update.

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

Value to append to the array.

+ * * @return null|AttributePlainEnumValue */ public function getValue(); diff --git a/lib/commercetools-api/src/Models/ProductType/ProductTypeAddPlainEnumValueActionBuilder.php b/lib/commercetools-api/src/Models/ProductType/ProductTypeAddPlainEnumValueActionBuilder.php index aa125731671..819f4c2b5e4 100644 --- a/lib/commercetools-api/src/Models/ProductType/ProductTypeAddPlainEnumValueActionBuilder.php +++ b/lib/commercetools-api/src/Models/ProductType/ProductTypeAddPlainEnumValueActionBuilder.php @@ -31,6 +31,8 @@ final class ProductTypeAddPlainEnumValueActionBuilder implements Builder private $value; /** + *

Name of the AttributeDefinition to update.

+ * * @return null|string */ public function getAttributeName() @@ -39,6 +41,8 @@ public function getAttributeName() } /** + *

Value to append to the array.

+ * * @return null|AttributePlainEnumValue */ public function getValue() diff --git a/lib/commercetools-api/src/Models/ProductType/ProductTypeAddPlainEnumValueActionModel.php b/lib/commercetools-api/src/Models/ProductType/ProductTypeAddPlainEnumValueActionModel.php index f61fcb4a4bc..ca25c92adb1 100644 --- a/lib/commercetools-api/src/Models/ProductType/ProductTypeAddPlainEnumValueActionModel.php +++ b/lib/commercetools-api/src/Models/ProductType/ProductTypeAddPlainEnumValueActionModel.php @@ -66,6 +66,8 @@ public function getAction() } /** + *

Name of the AttributeDefinition to update.

+ * * @return null|string */ public function getAttributeName() @@ -83,6 +85,8 @@ public function getAttributeName() } /** + *

Value to append to the array.

+ * * @return null|AttributePlainEnumValue */ public function getValue() diff --git a/lib/commercetools-api/src/Models/ProductType/ProductTypeBuilder.php b/lib/commercetools-api/src/Models/ProductType/ProductTypeBuilder.php index 8ea622bfbb8..c5cc36c8aa4 100644 --- a/lib/commercetools-api/src/Models/ProductType/ProductTypeBuilder.php +++ b/lib/commercetools-api/src/Models/ProductType/ProductTypeBuilder.php @@ -78,7 +78,7 @@ final class ProductTypeBuilder implements Builder private $attributes; /** - *

Unique identifier for the ProductType.

+ *

Unique identifier of the ProductType.

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

The current version of the product type.

+ *

Current version of the ProductType.

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

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

+ * * @return null|DateTimeImmutable */ public function getCreatedAt() @@ -106,6 +108,8 @@ public function getCreatedAt() } /** + *

Date and time (UTC) the Channel was last updated.

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

Name of the ProductType.

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

Description of the ProductType.

+ * * @return null|string */ public function getDescription() @@ -160,6 +168,8 @@ public function getDescription() } /** + *

Attributes specified for the ProductType.

+ * * @return null|AttributeDefinitionCollection */ public function getAttributes() diff --git a/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeAttributeConstraintAction.php b/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeAttributeConstraintAction.php index e3289f40f07..9f6eb14c790 100644 --- a/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeAttributeConstraintAction.php +++ b/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeAttributeConstraintAction.php @@ -17,11 +17,15 @@ interface ProductTypeChangeAttributeConstraintAction extends ProductTypeUpdateAc public const FIELD_NEW_VALUE = 'newValue'; /** + *

Name of the AttributeDefinition to update.

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

None

+ * * @return null|string */ public function getNewValue(); diff --git a/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeAttributeConstraintActionBuilder.php b/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeAttributeConstraintActionBuilder.php index 2a817c8d2d7..82d56cbfa83 100644 --- a/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeAttributeConstraintActionBuilder.php +++ b/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeAttributeConstraintActionBuilder.php @@ -31,6 +31,8 @@ final class ProductTypeChangeAttributeConstraintActionBuilder implements Builder private $newValue; /** + *

Name of the AttributeDefinition to update.

+ * * @return null|string */ public function getAttributeName() @@ -39,6 +41,8 @@ public function getAttributeName() } /** + *

None

+ * * @return null|string */ public function getNewValue() diff --git a/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeAttributeConstraintActionModel.php b/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeAttributeConstraintActionModel.php index 46f7acd9176..70b09670cc9 100644 --- a/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeAttributeConstraintActionModel.php +++ b/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeAttributeConstraintActionModel.php @@ -66,6 +66,8 @@ public function getAction() } /** + *

Name of the AttributeDefinition to update.

+ * * @return null|string */ public function getAttributeName() @@ -83,6 +85,8 @@ public function getAttributeName() } /** + *

None

+ * * @return null|string */ public function getNewValue() diff --git a/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeAttributeNameAction.php b/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeAttributeNameAction.php index e90d3fb1b7d..c51363a9de9 100644 --- a/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeAttributeNameAction.php +++ b/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeAttributeNameAction.php @@ -17,11 +17,17 @@ interface ProductTypeChangeAttributeNameAction extends ProductTypeUpdateAction public const FIELD_NEW_ATTRIBUTE_NAME = 'newAttributeName'; /** + *

Name of the AttributeDefinition to update.

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

New user-defined name of the Attribute that is unique with the Project. + * When using the same name for an Attribute in two or more ProductTypes all fields of the AttributeDefinition of this Attribute need to be the same across the ProductTypes, otherwise an AttributeDefinitionAlreadyExistsError will be returned. + * An exception to this are the values of an enum or lenum type and sets thereof.

+ * * @return null|string */ public function getNewAttributeName(); diff --git a/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeAttributeNameActionBuilder.php b/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeAttributeNameActionBuilder.php index 38dd9d898c5..b6d6b1a2ce1 100644 --- a/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeAttributeNameActionBuilder.php +++ b/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeAttributeNameActionBuilder.php @@ -31,6 +31,8 @@ final class ProductTypeChangeAttributeNameActionBuilder implements Builder private $newAttributeName; /** + *

Name of the AttributeDefinition to update.

+ * * @return null|string */ public function getAttributeName() @@ -39,6 +41,10 @@ public function getAttributeName() } /** + *

New user-defined name of the Attribute that is unique with the Project. + * When using the same name for an Attribute in two or more ProductTypes all fields of the AttributeDefinition of this Attribute need to be the same across the ProductTypes, otherwise an AttributeDefinitionAlreadyExistsError will be returned. + * An exception to this are the values of an enum or lenum type and sets thereof.

+ * * @return null|string */ public function getNewAttributeName() diff --git a/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeAttributeNameActionModel.php b/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeAttributeNameActionModel.php index 973ab01c385..61e47c4d2f8 100644 --- a/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeAttributeNameActionModel.php +++ b/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeAttributeNameActionModel.php @@ -66,6 +66,8 @@ public function getAction() } /** + *

Name of the AttributeDefinition to update.

+ * * @return null|string */ public function getAttributeName() @@ -83,6 +85,10 @@ public function getAttributeName() } /** + *

New user-defined name of the Attribute that is unique with the Project. + * When using the same name for an Attribute in two or more ProductTypes all fields of the AttributeDefinition of this Attribute need to be the same across the ProductTypes, otherwise an AttributeDefinitionAlreadyExistsError will be returned. + * An exception to this are the values of an enum or lenum type and sets thereof.

+ * * @return null|string */ public function getNewAttributeName() diff --git a/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeAttributeOrderByNameAction.php b/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeAttributeOrderByNameAction.php index 597311ed62b..be12b9e20b4 100644 --- a/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeAttributeOrderByNameAction.php +++ b/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeAttributeOrderByNameAction.php @@ -16,6 +16,8 @@ interface ProductTypeChangeAttributeOrderByNameAction extends ProductTypeUpdateA public const FIELD_ATTRIBUTE_NAMES = 'attributeNames'; /** + *

Names of Attributes to reorder. This array must include all Attributes currently present on a ProductType in a different order.

+ * * @return null|array */ public function getAttributeNames(); diff --git a/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeAttributeOrderByNameActionBuilder.php b/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeAttributeOrderByNameActionBuilder.php index 31386d027d9..d8b7db80bfa 100644 --- a/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeAttributeOrderByNameActionBuilder.php +++ b/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeAttributeOrderByNameActionBuilder.php @@ -26,6 +26,8 @@ final class ProductTypeChangeAttributeOrderByNameActionBuilder implements Builde private $attributeNames; /** + *

Names of Attributes to reorder. This array must include all Attributes currently present on a ProductType in a different order.

+ * * @return null|array */ public function getAttributeNames() diff --git a/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeAttributeOrderByNameActionModel.php b/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeAttributeOrderByNameActionModel.php index b080c46f7ae..0ca24cf082e 100644 --- a/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeAttributeOrderByNameActionModel.php +++ b/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeAttributeOrderByNameActionModel.php @@ -59,6 +59,8 @@ public function getAction() } /** + *

Names of Attributes to reorder. This array must include all Attributes currently present on a ProductType in a different order.

+ * * @return null|array */ public function getAttributeNames() diff --git a/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeDescriptionAction.php b/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeDescriptionAction.php index 0f4fa90a5b2..64d8d8fd050 100644 --- a/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeDescriptionAction.php +++ b/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeDescriptionAction.php @@ -16,6 +16,8 @@ interface ProductTypeChangeDescriptionAction extends ProductTypeUpdateAction public const FIELD_DESCRIPTION = 'description'; /** + *

New value to set.

+ * * @return null|string */ public function getDescription(); diff --git a/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeDescriptionActionBuilder.php b/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeDescriptionActionBuilder.php index 5a54592fc97..1eeb562eb3d 100644 --- a/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeDescriptionActionBuilder.php +++ b/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeDescriptionActionBuilder.php @@ -26,6 +26,8 @@ final class ProductTypeChangeDescriptionActionBuilder implements Builder private $description; /** + *

New value to set.

+ * * @return null|string */ public function getDescription() diff --git a/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeDescriptionActionModel.php b/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeDescriptionActionModel.php index 7e9d665224e..7c231db8951 100644 --- a/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeDescriptionActionModel.php +++ b/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeDescriptionActionModel.php @@ -59,6 +59,8 @@ public function getAction() } /** + *

New value to set.

+ * * @return null|string */ public function getDescription() diff --git a/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeEnumKeyAction.php b/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeEnumKeyAction.php index 6e2e4a19618..5a479320298 100644 --- a/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeEnumKeyAction.php +++ b/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeEnumKeyAction.php @@ -18,16 +18,22 @@ interface ProductTypeChangeEnumKeyAction extends ProductTypeUpdateAction public const FIELD_NEW_KEY = 'newKey'; /** + *

Name of the AttributeDefinition to update.

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

Existing key to be changed.

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

New key to be set.

+ * * @return null|string */ public function getNewKey(); diff --git a/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeEnumKeyActionBuilder.php b/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeEnumKeyActionBuilder.php index eeca7b0cb4c..805cc006e28 100644 --- a/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeEnumKeyActionBuilder.php +++ b/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeEnumKeyActionBuilder.php @@ -36,6 +36,8 @@ final class ProductTypeChangeEnumKeyActionBuilder implements Builder private $newKey; /** + *

Name of the AttributeDefinition to update.

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

Existing key to be changed.

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

New key to be set.

+ * * @return null|string */ public function getNewKey() diff --git a/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeEnumKeyActionModel.php b/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeEnumKeyActionModel.php index 9b86ffb34e7..8c89c267a0a 100644 --- a/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeEnumKeyActionModel.php +++ b/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeEnumKeyActionModel.php @@ -73,6 +73,8 @@ public function getAction() } /** + *

Name of the AttributeDefinition to update.

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

Existing key to be changed.

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

New key to be set.

+ * * @return null|string */ public function getNewKey() diff --git a/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeInputHintAction.php b/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeInputHintAction.php index e59d737ad17..bbe55362ac6 100644 --- a/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeInputHintAction.php +++ b/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeInputHintAction.php @@ -17,11 +17,15 @@ interface ProductTypeChangeInputHintAction extends ProductTypeUpdateAction public const FIELD_NEW_VALUE = 'newValue'; /** + *

Name of the AttributeDefinition to update.

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

SingleLine or MultiLine

+ * * @return null|string */ public function getNewValue(); diff --git a/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeInputHintActionBuilder.php b/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeInputHintActionBuilder.php index 703051faf27..c994bb1ecb0 100644 --- a/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeInputHintActionBuilder.php +++ b/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeInputHintActionBuilder.php @@ -31,6 +31,8 @@ final class ProductTypeChangeInputHintActionBuilder implements Builder private $newValue; /** + *

Name of the AttributeDefinition to update.

+ * * @return null|string */ public function getAttributeName() @@ -39,6 +41,8 @@ public function getAttributeName() } /** + *

SingleLine or MultiLine

+ * * @return null|string */ public function getNewValue() diff --git a/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeInputHintActionModel.php b/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeInputHintActionModel.php index 7efdf939f73..be783ae511d 100644 --- a/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeInputHintActionModel.php +++ b/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeInputHintActionModel.php @@ -66,6 +66,8 @@ public function getAction() } /** + *

Name of the AttributeDefinition to update.

+ * * @return null|string */ public function getAttributeName() @@ -83,6 +85,8 @@ public function getAttributeName() } /** + *

SingleLine or MultiLine

+ * * @return null|string */ public function getNewValue() diff --git a/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeIsSearchableAction.php b/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeIsSearchableAction.php index c2b72b4381a..33efe7cb182 100644 --- a/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeIsSearchableAction.php +++ b/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeIsSearchableAction.php @@ -17,11 +17,15 @@ interface ProductTypeChangeIsSearchableAction extends ProductTypeUpdateAction public const FIELD_IS_SEARCHABLE = 'isSearchable'; /** + *

Name of the AttributeDefinition to update.

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

Determines whether the Attribute's values can be used in full-text search queries, filters, and facets. See AttributeDefinition for details.

+ * * @return null|bool */ public function getIsSearchable(); diff --git a/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeIsSearchableActionBuilder.php b/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeIsSearchableActionBuilder.php index 561f1104902..9a6a444a9b6 100644 --- a/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeIsSearchableActionBuilder.php +++ b/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeIsSearchableActionBuilder.php @@ -31,6 +31,8 @@ final class ProductTypeChangeIsSearchableActionBuilder implements Builder private $isSearchable; /** + *

Name of the AttributeDefinition to update.

+ * * @return null|string */ public function getAttributeName() @@ -39,6 +41,8 @@ public function getAttributeName() } /** + *

Determines whether the Attribute's values can be used in full-text search queries, filters, and facets. See AttributeDefinition for details.

+ * * @return null|bool */ public function getIsSearchable() diff --git a/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeIsSearchableActionModel.php b/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeIsSearchableActionModel.php index b563b9bdf89..c67f3620013 100644 --- a/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeIsSearchableActionModel.php +++ b/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeIsSearchableActionModel.php @@ -66,6 +66,8 @@ public function getAction() } /** + *

Name of the AttributeDefinition to update.

+ * * @return null|string */ public function getAttributeName() @@ -83,6 +85,8 @@ public function getAttributeName() } /** + *

Determines whether the Attribute's values can be used in full-text search queries, filters, and facets. See AttributeDefinition for details.

+ * * @return null|bool */ public function getIsSearchable() diff --git a/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeLabelAction.php b/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeLabelAction.php index 5a256bd8d50..5206e67d845 100644 --- a/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeLabelAction.php +++ b/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeLabelAction.php @@ -18,12 +18,14 @@ interface ProductTypeChangeLabelAction extends ProductTypeUpdateAction public const FIELD_LABEL = 'label'; /** + *

Name of the AttributeDefinition to update.

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

JSON object where the keys are of type Locale, and the values are the strings used for the corresponding language.

+ *

New value to set. Must not be empty.

* * @return null|LocalizedString */ diff --git a/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeLabelActionBuilder.php b/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeLabelActionBuilder.php index 69906225ccf..978ee5c40c4 100644 --- a/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeLabelActionBuilder.php +++ b/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeLabelActionBuilder.php @@ -33,6 +33,8 @@ final class ProductTypeChangeLabelActionBuilder implements Builder private $label; /** + *

Name of the AttributeDefinition to update.

+ * * @return null|string */ public function getAttributeName() @@ -41,7 +43,7 @@ public function getAttributeName() } /** - *

JSON object where the keys are of type Locale, and the values are the strings used for the corresponding language.

+ *

New value to set. Must not be empty.

* * @return null|LocalizedString */ diff --git a/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeLabelActionModel.php b/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeLabelActionModel.php index 53f0ca97d2d..0a40f1a74ac 100644 --- a/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeLabelActionModel.php +++ b/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeLabelActionModel.php @@ -68,6 +68,8 @@ public function getAction() } /** + *

Name of the AttributeDefinition to update.

+ * * @return null|string */ public function getAttributeName() @@ -85,7 +87,7 @@ public function getAttributeName() } /** - *

JSON object where the keys are of type Locale, and the values are the strings used for the corresponding language.

+ *

New value to set. Must not be empty.

* * @return null|LocalizedString */ diff --git a/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeLocalizedEnumValueLabelAction.php b/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeLocalizedEnumValueLabelAction.php index 63a3a84f7d1..83654a3b36e 100644 --- a/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeLocalizedEnumValueLabelAction.php +++ b/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeLocalizedEnumValueLabelAction.php @@ -17,11 +17,15 @@ interface ProductTypeChangeLocalizedEnumValueLabelAction extends ProductTypeUpda public const FIELD_NEW_VALUE = 'newValue'; /** + *

Name of the AttributeDefinition to update.

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

New value to set. Must be different from the existing value.

+ * * @return null|AttributeLocalizedEnumValue */ public function getNewValue(); diff --git a/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeLocalizedEnumValueLabelActionBuilder.php b/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeLocalizedEnumValueLabelActionBuilder.php index 8d4f11c89d3..c09465cdbf4 100644 --- a/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeLocalizedEnumValueLabelActionBuilder.php +++ b/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeLocalizedEnumValueLabelActionBuilder.php @@ -31,6 +31,8 @@ final class ProductTypeChangeLocalizedEnumValueLabelActionBuilder implements Bui private $newValue; /** + *

Name of the AttributeDefinition to update.

+ * * @return null|string */ public function getAttributeName() @@ -39,6 +41,8 @@ public function getAttributeName() } /** + *

New value to set. Must be different from the existing value.

+ * * @return null|AttributeLocalizedEnumValue */ public function getNewValue() diff --git a/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeLocalizedEnumValueLabelActionModel.php b/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeLocalizedEnumValueLabelActionModel.php index a044f6d178c..ce8c417c6e3 100644 --- a/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeLocalizedEnumValueLabelActionModel.php +++ b/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeLocalizedEnumValueLabelActionModel.php @@ -66,6 +66,8 @@ public function getAction() } /** + *

Name of the AttributeDefinition to update.

+ * * @return null|string */ public function getAttributeName() @@ -83,6 +85,8 @@ public function getAttributeName() } /** + *

New value to set. Must be different from the existing value.

+ * * @return null|AttributeLocalizedEnumValue */ public function getNewValue() diff --git a/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeLocalizedEnumValueOrderAction.php b/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeLocalizedEnumValueOrderAction.php index 9f8cf382456..d82a53262b8 100644 --- a/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeLocalizedEnumValueOrderAction.php +++ b/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeLocalizedEnumValueOrderAction.php @@ -17,11 +17,15 @@ interface ProductTypeChangeLocalizedEnumValueOrderAction extends ProductTypeUpda public const FIELD_VALUES = 'values'; /** + *

Name of the AttributeDefinition to update.

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

Values must be equal to the values of the Attribute enum values (except for the order). If not, an EnumValuesMustMatch error code will be returned.

+ * * @return null|AttributeLocalizedEnumValueCollection */ public function getValues(); diff --git a/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeLocalizedEnumValueOrderActionBuilder.php b/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeLocalizedEnumValueOrderActionBuilder.php index 17ee1dfb7e4..3eb85f005be 100644 --- a/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeLocalizedEnumValueOrderActionBuilder.php +++ b/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeLocalizedEnumValueOrderActionBuilder.php @@ -31,6 +31,8 @@ final class ProductTypeChangeLocalizedEnumValueOrderActionBuilder implements Bui private $values; /** + *

Name of the AttributeDefinition to update.

+ * * @return null|string */ public function getAttributeName() @@ -39,6 +41,8 @@ public function getAttributeName() } /** + *

Values must be equal to the values of the Attribute enum values (except for the order). If not, an EnumValuesMustMatch error code will be returned.

+ * * @return null|AttributeLocalizedEnumValueCollection */ public function getValues() diff --git a/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeLocalizedEnumValueOrderActionModel.php b/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeLocalizedEnumValueOrderActionModel.php index adc0016aeca..94b0bfbc4da 100644 --- a/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeLocalizedEnumValueOrderActionModel.php +++ b/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeLocalizedEnumValueOrderActionModel.php @@ -66,6 +66,8 @@ public function getAction() } /** + *

Name of the AttributeDefinition to update.

+ * * @return null|string */ public function getAttributeName() @@ -83,6 +85,8 @@ public function getAttributeName() } /** + *

Values must be equal to the values of the Attribute enum values (except for the order). If not, an EnumValuesMustMatch error code will be returned.

+ * * @return null|AttributeLocalizedEnumValueCollection */ public function getValues() diff --git a/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeNameAction.php b/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeNameAction.php index 83afecbb33b..3d845a94b56 100644 --- a/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeNameAction.php +++ b/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeNameAction.php @@ -16,6 +16,8 @@ interface ProductTypeChangeNameAction extends ProductTypeUpdateAction public const FIELD_NAME = 'name'; /** + *

New value to set.

+ * * @return null|string */ public function getName(); diff --git a/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeNameActionBuilder.php b/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeNameActionBuilder.php index 6e4f90b53c6..f07ae250480 100644 --- a/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeNameActionBuilder.php +++ b/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeNameActionBuilder.php @@ -26,6 +26,8 @@ final class ProductTypeChangeNameActionBuilder implements Builder private $name; /** + *

New value to set.

+ * * @return null|string */ public function getName() diff --git a/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeNameActionModel.php b/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeNameActionModel.php index 61d76146ba1..6b20b064d20 100644 --- a/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeNameActionModel.php +++ b/lib/commercetools-api/src/Models/ProductType/ProductTypeChangeNameActionModel.php @@ -59,6 +59,8 @@ public function getAction() } /** + *

New value to set.

+ * * @return null|string */ public function getName() diff --git a/lib/commercetools-api/src/Models/ProductType/ProductTypeChangePlainEnumValueLabelAction.php b/lib/commercetools-api/src/Models/ProductType/ProductTypeChangePlainEnumValueLabelAction.php index 939195aeb13..514c97be435 100644 --- a/lib/commercetools-api/src/Models/ProductType/ProductTypeChangePlainEnumValueLabelAction.php +++ b/lib/commercetools-api/src/Models/ProductType/ProductTypeChangePlainEnumValueLabelAction.php @@ -17,11 +17,15 @@ interface ProductTypeChangePlainEnumValueLabelAction extends ProductTypeUpdateAc public const FIELD_NEW_VALUE = 'newValue'; /** + *

Name of the AttributeDefinition to update.

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

New value to set. Must be different from the existing value.

+ * * @return null|AttributePlainEnumValue */ public function getNewValue(); diff --git a/lib/commercetools-api/src/Models/ProductType/ProductTypeChangePlainEnumValueLabelActionBuilder.php b/lib/commercetools-api/src/Models/ProductType/ProductTypeChangePlainEnumValueLabelActionBuilder.php index abd689afbe6..76e54511bde 100644 --- a/lib/commercetools-api/src/Models/ProductType/ProductTypeChangePlainEnumValueLabelActionBuilder.php +++ b/lib/commercetools-api/src/Models/ProductType/ProductTypeChangePlainEnumValueLabelActionBuilder.php @@ -31,6 +31,8 @@ final class ProductTypeChangePlainEnumValueLabelActionBuilder implements Builder private $newValue; /** + *

Name of the AttributeDefinition to update.

+ * * @return null|string */ public function getAttributeName() @@ -39,6 +41,8 @@ public function getAttributeName() } /** + *

New value to set. Must be different from the existing value.

+ * * @return null|AttributePlainEnumValue */ public function getNewValue() diff --git a/lib/commercetools-api/src/Models/ProductType/ProductTypeChangePlainEnumValueLabelActionModel.php b/lib/commercetools-api/src/Models/ProductType/ProductTypeChangePlainEnumValueLabelActionModel.php index 57359cb157d..68b9967c47d 100644 --- a/lib/commercetools-api/src/Models/ProductType/ProductTypeChangePlainEnumValueLabelActionModel.php +++ b/lib/commercetools-api/src/Models/ProductType/ProductTypeChangePlainEnumValueLabelActionModel.php @@ -66,6 +66,8 @@ public function getAction() } /** + *

Name of the AttributeDefinition to update.

+ * * @return null|string */ public function getAttributeName() @@ -83,6 +85,8 @@ public function getAttributeName() } /** + *

New value to set. Must be different from the existing value.

+ * * @return null|AttributePlainEnumValue */ public function getNewValue() diff --git a/lib/commercetools-api/src/Models/ProductType/ProductTypeChangePlainEnumValueOrderAction.php b/lib/commercetools-api/src/Models/ProductType/ProductTypeChangePlainEnumValueOrderAction.php index 216d491544b..b1ec096cdee 100644 --- a/lib/commercetools-api/src/Models/ProductType/ProductTypeChangePlainEnumValueOrderAction.php +++ b/lib/commercetools-api/src/Models/ProductType/ProductTypeChangePlainEnumValueOrderAction.php @@ -17,11 +17,15 @@ interface ProductTypeChangePlainEnumValueOrderAction extends ProductTypeUpdateAc public const FIELD_VALUES = 'values'; /** + *

Name of the AttributeDefinition to update.

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

Values must be equal to the values of the Attribute enum values (except for the order). If not, an EnumValuesMustMatch error code will be returned.

+ * * @return null|AttributePlainEnumValueCollection */ public function getValues(); diff --git a/lib/commercetools-api/src/Models/ProductType/ProductTypeChangePlainEnumValueOrderActionBuilder.php b/lib/commercetools-api/src/Models/ProductType/ProductTypeChangePlainEnumValueOrderActionBuilder.php index b4a63202138..ca561f31fdd 100644 --- a/lib/commercetools-api/src/Models/ProductType/ProductTypeChangePlainEnumValueOrderActionBuilder.php +++ b/lib/commercetools-api/src/Models/ProductType/ProductTypeChangePlainEnumValueOrderActionBuilder.php @@ -31,6 +31,8 @@ final class ProductTypeChangePlainEnumValueOrderActionBuilder implements Builder private $values; /** + *

Name of the AttributeDefinition to update.

+ * * @return null|string */ public function getAttributeName() @@ -39,6 +41,8 @@ public function getAttributeName() } /** + *

Values must be equal to the values of the Attribute enum values (except for the order). If not, an EnumValuesMustMatch error code will be returned.

+ * * @return null|AttributePlainEnumValueCollection */ public function getValues() diff --git a/lib/commercetools-api/src/Models/ProductType/ProductTypeChangePlainEnumValueOrderActionModel.php b/lib/commercetools-api/src/Models/ProductType/ProductTypeChangePlainEnumValueOrderActionModel.php index b6c1c9f5693..fd366d49b92 100644 --- a/lib/commercetools-api/src/Models/ProductType/ProductTypeChangePlainEnumValueOrderActionModel.php +++ b/lib/commercetools-api/src/Models/ProductType/ProductTypeChangePlainEnumValueOrderActionModel.php @@ -66,6 +66,8 @@ public function getAction() } /** + *

Name of the AttributeDefinition to update.

+ * * @return null|string */ public function getAttributeName() @@ -83,6 +85,8 @@ public function getAttributeName() } /** + *

Values must be equal to the values of the Attribute enum values (except for the order). If not, an EnumValuesMustMatch error code will be returned.

+ * * @return null|AttributePlainEnumValueCollection */ public function getValues() diff --git a/lib/commercetools-api/src/Models/ProductType/ProductTypeDraft.php b/lib/commercetools-api/src/Models/ProductType/ProductTypeDraft.php index e340849695a..f75bf9d304f 100644 --- a/lib/commercetools-api/src/Models/ProductType/ProductTypeDraft.php +++ b/lib/commercetools-api/src/Models/ProductType/ProductTypeDraft.php @@ -26,16 +26,22 @@ interface ProductTypeDraft extends JsonObject public function getKey(); /** + *

Name of the ProductType.

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

Description of the ProductType.

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

Attributes to specify for the ProductType. Products of this ProductType have these Attributes available on their ProductVariants.

+ * * @return null|AttributeDefinitionDraftCollection */ public function getAttributes(); diff --git a/lib/commercetools-api/src/Models/ProductType/ProductTypeDraftBuilder.php b/lib/commercetools-api/src/Models/ProductType/ProductTypeDraftBuilder.php index 60fee4c866e..2f9197a6bbb 100644 --- a/lib/commercetools-api/src/Models/ProductType/ProductTypeDraftBuilder.php +++ b/lib/commercetools-api/src/Models/ProductType/ProductTypeDraftBuilder.php @@ -51,6 +51,8 @@ public function getKey() } /** + *

Name of the ProductType.

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

Description of the ProductType.

+ * * @return null|string */ public function getDescription() @@ -67,6 +71,8 @@ public function getDescription() } /** + *

Attributes to specify for the ProductType. Products of this ProductType have these Attributes available on their ProductVariants.

+ * * @return null|AttributeDefinitionDraftCollection */ public function getAttributes() diff --git a/lib/commercetools-api/src/Models/ProductType/ProductTypeDraftModel.php b/lib/commercetools-api/src/Models/ProductType/ProductTypeDraftModel.php index ab34986a080..2a69161c8f8 100644 --- a/lib/commercetools-api/src/Models/ProductType/ProductTypeDraftModel.php +++ b/lib/commercetools-api/src/Models/ProductType/ProductTypeDraftModel.php @@ -75,6 +75,8 @@ public function getKey() } /** + *

Name of the ProductType.

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

Description of the ProductType.

+ * * @return null|string */ public function getDescription() @@ -109,6 +113,8 @@ public function getDescription() } /** + *

Attributes to specify for the ProductType. Products of this ProductType have these Attributes available on their ProductVariants.

+ * * @return null|AttributeDefinitionDraftCollection */ public function getAttributes() diff --git a/lib/commercetools-api/src/Models/ProductType/ProductTypeModel.php b/lib/commercetools-api/src/Models/ProductType/ProductTypeModel.php index b5ec6cdc729..d05fa264249 100644 --- a/lib/commercetools-api/src/Models/ProductType/ProductTypeModel.php +++ b/lib/commercetools-api/src/Models/ProductType/ProductTypeModel.php @@ -105,7 +105,7 @@ public function __construct( } /** - *

Unique identifier for the ProductType.

+ *

Unique identifier of the ProductType.

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

The current version of the product type.

+ *

Current version of the ProductType.

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

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

+ * * @return null|DateTimeImmutable */ public function getCreatedAt() @@ -164,6 +166,8 @@ public function getCreatedAt() } /** + *

Date and time (UTC) the Channel was last updated.

+ * * @return null|DateTimeImmutable */ public function getLastModifiedAt() @@ -244,6 +248,8 @@ public function getKey() } /** + *

Name of the ProductType.

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

Description of the ProductType.

+ * * @return null|string */ public function getDescription() @@ -278,6 +286,8 @@ public function getDescription() } /** + *

Attributes specified for the ProductType.

+ * * @return null|AttributeDefinitionCollection */ public function getAttributes() diff --git a/lib/commercetools-api/src/Models/ProductType/ProductTypePagedQueryResponse.php b/lib/commercetools-api/src/Models/ProductType/ProductTypePagedQueryResponse.php index 0c54b602b52..0b05c2bc2df 100644 --- a/lib/commercetools-api/src/Models/ProductType/ProductTypePagedQueryResponse.php +++ b/lib/commercetools-api/src/Models/ProductType/ProductTypePagedQueryResponse.php @@ -14,9 +14,9 @@ interface ProductTypePagedQueryResponse extends JsonObject { public const FIELD_LIMIT = 'limit'; + public const FIELD_OFFSET = 'offset'; public const FIELD_COUNT = 'count'; public const FIELD_TOTAL = 'total'; - public const FIELD_OFFSET = 'offset'; public const FIELD_RESULTS = 'results'; /** @@ -27,23 +27,33 @@ interface ProductTypePagedQueryResponse extends JsonObject public function getLimit(); /** + *

Number of elements skipped.

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

Actual number of results returned.

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

Number of elements skipped.

+ *

Total number of results matching the query. + * This number is an estimation that is not strongly consistent. + * This field is returned by default. + * For improved performance, calculating this field can be deactivated by using the query parameter withTotal=false. + * When the results are filtered with a Query Predicate, total is subject to a limit.

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

ProductTypes matching the query.

+ * * @return null|ProductTypeCollection */ public function getResults(); @@ -53,6 +63,11 @@ public function getResults(); */ public function setLimit(?int $limit): void; + /** + * @param ?int $offset + */ + public function setOffset(?int $offset): void; + /** * @param ?int $count */ @@ -63,11 +78,6 @@ public function setCount(?int $count): void; */ public function setTotal(?int $total): void; - /** - * @param ?int $offset - */ - public function setOffset(?int $offset): void; - /** * @param ?ProductTypeCollection $results */ diff --git a/lib/commercetools-api/src/Models/ProductType/ProductTypePagedQueryResponseBuilder.php b/lib/commercetools-api/src/Models/ProductType/ProductTypePagedQueryResponseBuilder.php index 8d3b4fc808b..f00324ed078 100644 --- a/lib/commercetools-api/src/Models/ProductType/ProductTypePagedQueryResponseBuilder.php +++ b/lib/commercetools-api/src/Models/ProductType/ProductTypePagedQueryResponseBuilder.php @@ -28,17 +28,17 @@ final class ProductTypePagedQueryResponseBuilder implements Builder /** * @var ?int */ - private $count; + private $offset; /** * @var ?int */ - private $total; + private $count; /** * @var ?int */ - private $offset; + private $total; /** * @var ?ProductTypeCollection @@ -56,32 +56,42 @@ public function getLimit() } /** + *

Number of elements skipped.

+ * * @return null|int */ - public function getCount() + public function getOffset() { - return $this->count; + return $this->offset; } /** + *

Actual number of results returned.

+ * * @return null|int */ - public function getTotal() + public function getCount() { - return $this->total; + return $this->count; } /** - *

Number of elements skipped.

+ *

Total number of results matching the query. + * This number is an estimation that is not strongly consistent. + * This field is returned by default. + * For improved performance, calculating this field can be deactivated by using the query parameter withTotal=false. + * When the results are filtered with a Query Predicate, total is subject to a limit.

* * @return null|int */ - public function getOffset() + public function getTotal() { - return $this->offset; + return $this->total; } /** + *

ProductTypes matching the query.

+ * * @return null|ProductTypeCollection */ public function getResults() @@ -101,34 +111,34 @@ public function withLimit(?int $limit) } /** - * @param ?int $count + * @param ?int $offset * @return $this */ - public function withCount(?int $count) + public function withOffset(?int $offset) { - $this->count = $count; + $this->offset = $offset; return $this; } /** - * @param ?int $total + * @param ?int $count * @return $this */ - public function withTotal(?int $total) + public function withCount(?int $count) { - $this->total = $total; + $this->count = $count; return $this; } /** - * @param ?int $offset + * @param ?int $total * @return $this */ - public function withOffset(?int $offset) + public function withTotal(?int $total) { - $this->offset = $offset; + $this->total = $total; return $this; } @@ -149,9 +159,9 @@ public function build(): ProductTypePagedQueryResponse { return new ProductTypePagedQueryResponseModel( $this->limit, + $this->offset, $this->count, $this->total, - $this->offset, $this->results ); } diff --git a/lib/commercetools-api/src/Models/ProductType/ProductTypePagedQueryResponseModel.php b/lib/commercetools-api/src/Models/ProductType/ProductTypePagedQueryResponseModel.php index b0fbd8d68bc..3cf17d85a73 100644 --- a/lib/commercetools-api/src/Models/ProductType/ProductTypePagedQueryResponseModel.php +++ b/lib/commercetools-api/src/Models/ProductType/ProductTypePagedQueryResponseModel.php @@ -27,17 +27,17 @@ final class ProductTypePagedQueryResponseModel extends JsonObjectModel implement /** * @var ?int */ - protected $count; + protected $offset; /** * @var ?int */ - protected $total; + protected $count; /** * @var ?int */ - protected $offset; + protected $total; /** * @var ?ProductTypeCollection @@ -50,15 +50,15 @@ final class ProductTypePagedQueryResponseModel extends JsonObjectModel implement */ public function __construct( ?int $limit = null, + ?int $offset = null, ?int $count = null, ?int $total = null, - ?int $offset = null, ?ProductTypeCollection $results = null ) { $this->limit = $limit; + $this->offset = $offset; $this->count = $count; $this->total = $total; - $this->offset = $offset; $this->results = $results; } @@ -82,59 +82,69 @@ public function getLimit() } /** + *

Number of elements skipped.

+ * * @return null|int */ - public function getCount() + public function getOffset() { - if (is_null($this->count)) { + if (is_null($this->offset)) { /** @psalm-var ?int $data */ - $data = $this->raw(self::FIELD_COUNT); + $data = $this->raw(self::FIELD_OFFSET); if (is_null($data)) { return null; } - $this->count = (int) $data; + $this->offset = (int) $data; } - return $this->count; + return $this->offset; } /** + *

Actual number of results returned.

+ * * @return null|int */ - public function getTotal() + public function getCount() { - if (is_null($this->total)) { + if (is_null($this->count)) { /** @psalm-var ?int $data */ - $data = $this->raw(self::FIELD_TOTAL); + $data = $this->raw(self::FIELD_COUNT); if (is_null($data)) { return null; } - $this->total = (int) $data; + $this->count = (int) $data; } - return $this->total; + return $this->count; } /** - *

Number of elements skipped.

+ *

Total number of results matching the query. + * This number is an estimation that is not strongly consistent. + * This field is returned by default. + * For improved performance, calculating this field can be deactivated by using the query parameter withTotal=false. + * When the results are filtered with a Query Predicate, total is subject to a limit.

* * @return null|int */ - public function getOffset() + public function getTotal() { - if (is_null($this->offset)) { + if (is_null($this->total)) { /** @psalm-var ?int $data */ - $data = $this->raw(self::FIELD_OFFSET); + $data = $this->raw(self::FIELD_TOTAL); if (is_null($data)) { return null; } - $this->offset = (int) $data; + $this->total = (int) $data; } - return $this->offset; + return $this->total; } /** + *

ProductTypes matching the query.

+ * * @return null|ProductTypeCollection */ public function getResults() @@ -160,6 +170,14 @@ public function setLimit(?int $limit): void $this->limit = $limit; } + /** + * @param ?int $offset + */ + public function setOffset(?int $offset): void + { + $this->offset = $offset; + } + /** * @param ?int $count */ @@ -176,14 +194,6 @@ public function setTotal(?int $total): void $this->total = $total; } - /** - * @param ?int $offset - */ - public function setOffset(?int $offset): void - { - $this->offset = $offset; - } - /** * @param ?ProductTypeCollection $results */ diff --git a/lib/commercetools-api/src/Models/ProductType/ProductTypeRemoveAttributeDefinitionAction.php b/lib/commercetools-api/src/Models/ProductType/ProductTypeRemoveAttributeDefinitionAction.php index 8f6bf2ab72e..d505c85a1dc 100644 --- a/lib/commercetools-api/src/Models/ProductType/ProductTypeRemoveAttributeDefinitionAction.php +++ b/lib/commercetools-api/src/Models/ProductType/ProductTypeRemoveAttributeDefinitionAction.php @@ -16,7 +16,7 @@ interface ProductTypeRemoveAttributeDefinitionAction extends ProductTypeUpdateAc public const FIELD_NAME = 'name'; /** - *

The name of the attribute to remove.

+ *

Name of the Attribute to remove.

* * @return null|string */ diff --git a/lib/commercetools-api/src/Models/ProductType/ProductTypeRemoveAttributeDefinitionActionBuilder.php b/lib/commercetools-api/src/Models/ProductType/ProductTypeRemoveAttributeDefinitionActionBuilder.php index 9bf9227b430..ba9c7a396a3 100644 --- a/lib/commercetools-api/src/Models/ProductType/ProductTypeRemoveAttributeDefinitionActionBuilder.php +++ b/lib/commercetools-api/src/Models/ProductType/ProductTypeRemoveAttributeDefinitionActionBuilder.php @@ -26,7 +26,7 @@ final class ProductTypeRemoveAttributeDefinitionActionBuilder implements Builder private $name; /** - *

The name of the attribute to remove.

+ *

Name of the Attribute to remove.

* * @return null|string */ diff --git a/lib/commercetools-api/src/Models/ProductType/ProductTypeRemoveAttributeDefinitionActionModel.php b/lib/commercetools-api/src/Models/ProductType/ProductTypeRemoveAttributeDefinitionActionModel.php index e0e00f92065..48a0c67a92b 100644 --- a/lib/commercetools-api/src/Models/ProductType/ProductTypeRemoveAttributeDefinitionActionModel.php +++ b/lib/commercetools-api/src/Models/ProductType/ProductTypeRemoveAttributeDefinitionActionModel.php @@ -59,7 +59,7 @@ public function getAction() } /** - *

The name of the attribute to remove.

+ *

Name of the Attribute to remove.

* * @return null|string */ diff --git a/lib/commercetools-api/src/Models/ProductType/ProductTypeRemoveEnumValuesAction.php b/lib/commercetools-api/src/Models/ProductType/ProductTypeRemoveEnumValuesAction.php index 45225fe1deb..381118ccfd6 100644 --- a/lib/commercetools-api/src/Models/ProductType/ProductTypeRemoveEnumValuesAction.php +++ b/lib/commercetools-api/src/Models/ProductType/ProductTypeRemoveEnumValuesAction.php @@ -17,11 +17,15 @@ interface ProductTypeRemoveEnumValuesAction extends ProductTypeUpdateAction public const FIELD_KEYS = 'keys'; /** + *

Name of the AttributeDefinition to update.

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

Keys of AttributeEnumType or AttributeLocalizedEnumType to remove.

+ * * @return null|array */ public function getKeys(); diff --git a/lib/commercetools-api/src/Models/ProductType/ProductTypeRemoveEnumValuesActionBuilder.php b/lib/commercetools-api/src/Models/ProductType/ProductTypeRemoveEnumValuesActionBuilder.php index ddf09a5064d..7a8423747d6 100644 --- a/lib/commercetools-api/src/Models/ProductType/ProductTypeRemoveEnumValuesActionBuilder.php +++ b/lib/commercetools-api/src/Models/ProductType/ProductTypeRemoveEnumValuesActionBuilder.php @@ -31,6 +31,8 @@ final class ProductTypeRemoveEnumValuesActionBuilder implements Builder private $keys; /** + *

Name of the AttributeDefinition to update.

+ * * @return null|string */ public function getAttributeName() @@ -39,6 +41,8 @@ public function getAttributeName() } /** + *

Keys of AttributeEnumType or AttributeLocalizedEnumType to remove.

+ * * @return null|array */ public function getKeys() diff --git a/lib/commercetools-api/src/Models/ProductType/ProductTypeRemoveEnumValuesActionModel.php b/lib/commercetools-api/src/Models/ProductType/ProductTypeRemoveEnumValuesActionModel.php index 057edcfe108..92112503da6 100644 --- a/lib/commercetools-api/src/Models/ProductType/ProductTypeRemoveEnumValuesActionModel.php +++ b/lib/commercetools-api/src/Models/ProductType/ProductTypeRemoveEnumValuesActionModel.php @@ -66,6 +66,8 @@ public function getAction() } /** + *

Name of the AttributeDefinition to update.

+ * * @return null|string */ public function getAttributeName() @@ -83,6 +85,8 @@ public function getAttributeName() } /** + *

Keys of AttributeEnumType or AttributeLocalizedEnumType to remove.

+ * * @return null|array */ public function getKeys() diff --git a/lib/commercetools-api/src/Models/ProductType/ProductTypeSetInputTipAction.php b/lib/commercetools-api/src/Models/ProductType/ProductTypeSetInputTipAction.php index ad8d3d98370..1e722d61029 100644 --- a/lib/commercetools-api/src/Models/ProductType/ProductTypeSetInputTipAction.php +++ b/lib/commercetools-api/src/Models/ProductType/ProductTypeSetInputTipAction.php @@ -18,12 +18,14 @@ interface ProductTypeSetInputTipAction extends ProductTypeUpdateAction public const FIELD_INPUT_TIP = 'inputTip'; /** + *

Name of the AttributeDefinition to update.

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

JSON object where the keys are of type Locale, and the values are the strings used for the corresponding language.

+ *

Value to set. If empty, any existing value will be removed.

* * @return null|LocalizedString */ diff --git a/lib/commercetools-api/src/Models/ProductType/ProductTypeSetInputTipActionBuilder.php b/lib/commercetools-api/src/Models/ProductType/ProductTypeSetInputTipActionBuilder.php index 0c92dae1854..7fd50f28f49 100644 --- a/lib/commercetools-api/src/Models/ProductType/ProductTypeSetInputTipActionBuilder.php +++ b/lib/commercetools-api/src/Models/ProductType/ProductTypeSetInputTipActionBuilder.php @@ -33,6 +33,8 @@ final class ProductTypeSetInputTipActionBuilder implements Builder private $inputTip; /** + *

Name of the AttributeDefinition to update.

+ * * @return null|string */ public function getAttributeName() @@ -41,7 +43,7 @@ public function getAttributeName() } /** - *

JSON object where the keys are of type Locale, and the values are the strings used for the corresponding language.

+ *

Value to set. If empty, any existing value will be removed.

* * @return null|LocalizedString */ diff --git a/lib/commercetools-api/src/Models/ProductType/ProductTypeSetInputTipActionModel.php b/lib/commercetools-api/src/Models/ProductType/ProductTypeSetInputTipActionModel.php index c0feb633478..30476df4669 100644 --- a/lib/commercetools-api/src/Models/ProductType/ProductTypeSetInputTipActionModel.php +++ b/lib/commercetools-api/src/Models/ProductType/ProductTypeSetInputTipActionModel.php @@ -68,6 +68,8 @@ public function getAction() } /** + *

Name of the AttributeDefinition to update.

+ * * @return null|string */ public function getAttributeName() @@ -85,7 +87,7 @@ public function getAttributeName() } /** - *

JSON object where the keys are of type Locale, and the values are the strings used for the corresponding language.

+ *

Value to set. If empty, any existing value will be removed.

* * @return null|LocalizedString */ diff --git a/lib/commercetools-api/src/Models/ProductType/ProductTypeSetKeyAction.php b/lib/commercetools-api/src/Models/ProductType/ProductTypeSetKeyAction.php index 4a9d8ccc327..197b39e313f 100644 --- a/lib/commercetools-api/src/Models/ProductType/ProductTypeSetKeyAction.php +++ b/lib/commercetools-api/src/Models/ProductType/ProductTypeSetKeyAction.php @@ -16,7 +16,7 @@ interface ProductTypeSetKeyAction extends ProductTypeUpdateAction public const FIELD_KEY = 'key'; /** - *

If key is absent or null, this field will be removed if it exists.

+ *

Value to set. If empty, any existing value will be removed.

* * @return null|string */ diff --git a/lib/commercetools-api/src/Models/ProductType/ProductTypeSetKeyActionBuilder.php b/lib/commercetools-api/src/Models/ProductType/ProductTypeSetKeyActionBuilder.php index d3584eaa9e8..e36f47c2c1a 100644 --- a/lib/commercetools-api/src/Models/ProductType/ProductTypeSetKeyActionBuilder.php +++ b/lib/commercetools-api/src/Models/ProductType/ProductTypeSetKeyActionBuilder.php @@ -26,7 +26,7 @@ final class ProductTypeSetKeyActionBuilder implements Builder private $key; /** - *

If key is absent or null, this field will be removed if it exists.

+ *

Value to set. If empty, any existing value will be removed.

* * @return null|string */ diff --git a/lib/commercetools-api/src/Models/ProductType/ProductTypeSetKeyActionModel.php b/lib/commercetools-api/src/Models/ProductType/ProductTypeSetKeyActionModel.php index 63bb40f83f2..7684fe060a0 100644 --- a/lib/commercetools-api/src/Models/ProductType/ProductTypeSetKeyActionModel.php +++ b/lib/commercetools-api/src/Models/ProductType/ProductTypeSetKeyActionModel.php @@ -59,7 +59,7 @@ public function getAction() } /** - *

If key is absent or null, this field will be removed if it exists.

+ *

Value to set. If empty, any existing value will be removed.

* * @return null|string */ diff --git a/lib/commercetools-api/src/Models/ProductType/ProductTypeUpdate.php b/lib/commercetools-api/src/Models/ProductType/ProductTypeUpdate.php index 2aa4ed86705..faf3a798d8a 100644 --- a/lib/commercetools-api/src/Models/ProductType/ProductTypeUpdate.php +++ b/lib/commercetools-api/src/Models/ProductType/ProductTypeUpdate.php @@ -17,11 +17,15 @@ interface ProductTypeUpdate extends JsonObject public const FIELD_ACTIONS = 'actions'; /** + *

Expected version of the ProductType on which the changes should be applied. If the expected version does not match the actual version, a 409 Conflict will be returned.

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

Update actions to be performed on the ProductType.

+ * * @return null|ProductTypeUpdateActionCollection */ public function getActions(); diff --git a/lib/commercetools-api/src/Models/ProductType/ProductTypeUpdateBuilder.php b/lib/commercetools-api/src/Models/ProductType/ProductTypeUpdateBuilder.php index d141e702198..5e574f103a2 100644 --- a/lib/commercetools-api/src/Models/ProductType/ProductTypeUpdateBuilder.php +++ b/lib/commercetools-api/src/Models/ProductType/ProductTypeUpdateBuilder.php @@ -31,6 +31,8 @@ final class ProductTypeUpdateBuilder implements Builder private $actions; /** + *

Expected version of the ProductType on which the changes should be applied. If the expected version does not match the actual version, a 409 Conflict will be returned.

+ * * @return null|int */ public function getVersion() @@ -39,6 +41,8 @@ public function getVersion() } /** + *

Update actions to be performed on the ProductType.

+ * * @return null|ProductTypeUpdateActionCollection */ public function getActions() diff --git a/lib/commercetools-api/src/Models/ProductType/ProductTypeUpdateModel.php b/lib/commercetools-api/src/Models/ProductType/ProductTypeUpdateModel.php index 176ca92361b..e2bf12c3bf8 100644 --- a/lib/commercetools-api/src/Models/ProductType/ProductTypeUpdateModel.php +++ b/lib/commercetools-api/src/Models/ProductType/ProductTypeUpdateModel.php @@ -42,6 +42,8 @@ public function __construct( } /** + *

Expected version of the ProductType on which the changes should be applied. If the expected version does not match the actual version, a 409 Conflict will be returned.

+ * * @return null|int */ public function getVersion() @@ -59,6 +61,8 @@ public function getVersion() } /** + *

Update actions to be performed on the ProductType.

+ * * @return null|ProductTypeUpdateActionCollection */ public function getActions() diff --git a/lib/commercetools-api/src/Models/Project/CartClassificationTypeModel.php b/lib/commercetools-api/src/Models/Project/CartClassificationTypeModel.php index a26abdcf5d1..7ba4b59b690 100644 --- a/lib/commercetools-api/src/Models/Project/CartClassificationTypeModel.php +++ b/lib/commercetools-api/src/Models/Project/CartClassificationTypeModel.php @@ -43,8 +43,6 @@ public function __construct( } /** - *

Can be one of the following or absent.

- * * @return null|string */ public function getType() diff --git a/lib/commercetools-api/src/Models/Project/CartScoreTypeModel.php b/lib/commercetools-api/src/Models/Project/CartScoreTypeModel.php index 77a51dced8e..79e462afee3 100644 --- a/lib/commercetools-api/src/Models/Project/CartScoreTypeModel.php +++ b/lib/commercetools-api/src/Models/Project/CartScoreTypeModel.php @@ -35,8 +35,6 @@ public function __construct( } /** - *

Can be one of the following or absent.

- * * @return null|string */ public function getType() diff --git a/lib/commercetools-api/src/Models/Project/CartValueTypeModel.php b/lib/commercetools-api/src/Models/Project/CartValueTypeModel.php index 4e24e44c721..2f2b5e2bee3 100644 --- a/lib/commercetools-api/src/Models/Project/CartValueTypeModel.php +++ b/lib/commercetools-api/src/Models/Project/CartValueTypeModel.php @@ -35,8 +35,6 @@ public function __construct( } /** - *

Can be one of the following or absent.

- * * @return null|string */ public function getType() diff --git a/lib/commercetools-api/src/Models/Project/ShippingRateInputType.php b/lib/commercetools-api/src/Models/Project/ShippingRateInputType.php index cf387ce7dad..47e08d82f96 100644 --- a/lib/commercetools-api/src/Models/Project/ShippingRateInputType.php +++ b/lib/commercetools-api/src/Models/Project/ShippingRateInputType.php @@ -17,8 +17,6 @@ interface ShippingRateInputType extends JsonObject public const FIELD_TYPE = 'type'; /** - *

Can be one of the following or absent.

- * * @return null|string */ public function getType(); diff --git a/lib/commercetools-api/src/Models/Project/ShippingRateInputTypeModel.php b/lib/commercetools-api/src/Models/Project/ShippingRateInputTypeModel.php index 9fa080ca846..857b0581293 100644 --- a/lib/commercetools-api/src/Models/Project/ShippingRateInputTypeModel.php +++ b/lib/commercetools-api/src/Models/Project/ShippingRateInputTypeModel.php @@ -44,8 +44,6 @@ public function __construct( } /** - *

Can be one of the following or absent.

- * * @return null|string */ public function getType() diff --git a/lib/commercetools-api/src/Models/ShippingMethod/CartClassificationTier.php b/lib/commercetools-api/src/Models/ShippingMethod/CartClassificationTier.php index 45eee17d764..bfc3dd5fdc8 100644 --- a/lib/commercetools-api/src/Models/ShippingMethod/CartClassificationTier.php +++ b/lib/commercetools-api/src/Models/ShippingMethod/CartClassificationTier.php @@ -19,19 +19,22 @@ interface CartClassificationTier extends ShippingRatePriceTier public const FIELD_IS_MATCHING = 'isMatching'; /** + *

key selected from the values of the CartClassificationType configured in the Project.

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

Draft type that stores amounts in cent precision for the specified currency.

- *

For storing money values in fractions of the minor unit in a currency, use HighPrecisionMoneyDraft instead.

+ *

Fixed shipping rate for the selected classification.

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

Appears in response to Get ShippingMethods for a Cart if the shipping rate matches the search query.

+ * * @return null|bool */ public function getIsMatching(); diff --git a/lib/commercetools-api/src/Models/ShippingMethod/CartClassificationTierBuilder.php b/lib/commercetools-api/src/Models/ShippingMethod/CartClassificationTierBuilder.php index 20fed13a129..267e698b000 100644 --- a/lib/commercetools-api/src/Models/ShippingMethod/CartClassificationTierBuilder.php +++ b/lib/commercetools-api/src/Models/ShippingMethod/CartClassificationTierBuilder.php @@ -38,6 +38,8 @@ final class CartClassificationTierBuilder implements Builder private $isMatching; /** + *

key selected from the values of the CartClassificationType configured in the Project.

+ * * @return null|string */ public function getValue() @@ -46,8 +48,7 @@ public function getValue() } /** - *

Draft type that stores amounts in cent precision for the specified currency.

- *

For storing money values in fractions of the minor unit in a currency, use HighPrecisionMoneyDraft instead.

+ *

Fixed shipping rate for the selected classification.

* * @return null|Money */ @@ -57,6 +58,8 @@ public function getPrice() } /** + *

Appears in response to Get ShippingMethods for a Cart if the shipping rate matches the search query.

+ * * @return null|bool */ public function getIsMatching() diff --git a/lib/commercetools-api/src/Models/ShippingMethod/CartClassificationTierModel.php b/lib/commercetools-api/src/Models/ShippingMethod/CartClassificationTierModel.php index fb9a2cb9217..0ca8820fb7f 100644 --- a/lib/commercetools-api/src/Models/ShippingMethod/CartClassificationTierModel.php +++ b/lib/commercetools-api/src/Models/ShippingMethod/CartClassificationTierModel.php @@ -58,8 +58,6 @@ public function __construct( } /** - *

Can be one of the following or absent.

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

key selected from the values of the CartClassificationType configured in the Project.

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

Draft type that stores amounts in cent precision for the specified currency.

- *

For storing money values in fractions of the minor unit in a currency, use HighPrecisionMoneyDraft instead.

+ *

Fixed shipping rate for the selected classification.

* * @return null|Money */ @@ -115,6 +114,8 @@ public function getPrice() } /** + *

Appears in response to Get ShippingMethods for a Cart if the shipping rate matches the search query.

+ * * @return null|bool */ public function getIsMatching() diff --git a/lib/commercetools-api/src/Models/ShippingMethod/CartScoreTier.php b/lib/commercetools-api/src/Models/ShippingMethod/CartScoreTier.php index 8d5dd211861..e77ee1eb744 100644 --- a/lib/commercetools-api/src/Models/ShippingMethod/CartScoreTier.php +++ b/lib/commercetools-api/src/Models/ShippingMethod/CartScoreTier.php @@ -20,32 +20,37 @@ interface CartScoreTier extends ShippingRatePriceTier public const FIELD_IS_MATCHING = 'isMatching'; /** - * @return null|float + *

Abstract value for categorizing a Cart. The range starts at 0. The default price covers 0, tiers start at 1. See Using Tiered Shipping Rates for details and examples.

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

Draft type that stores amounts in cent precision for the specified currency.

- *

For storing money values in fractions of the minor unit in a currency, use HighPrecisionMoneyDraft instead.

+ *

Defines a fixed price for the score.

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

Dynamically calculates a Price for a range of scores.

+ * * @return null|PriceFunction */ public function getPriceFunction(); /** + *

Appears in response to Get ShippingMethods for a Cart if the shipping rate matches the search query.

+ * * @return null|bool */ public function getIsMatching(); /** - * @param ?float $score + * @param ?int $score */ - public function setScore(?float $score): void; + public function setScore(?int $score): void; /** * @param ?Money $price diff --git a/lib/commercetools-api/src/Models/ShippingMethod/CartScoreTierBuilder.php b/lib/commercetools-api/src/Models/ShippingMethod/CartScoreTierBuilder.php index e37d1627270..2119c19611a 100644 --- a/lib/commercetools-api/src/Models/ShippingMethod/CartScoreTierBuilder.php +++ b/lib/commercetools-api/src/Models/ShippingMethod/CartScoreTierBuilder.php @@ -23,7 +23,7 @@ final class CartScoreTierBuilder implements Builder { /** - * @var ?float + * @var ?int */ private $score; @@ -43,7 +43,9 @@ final class CartScoreTierBuilder implements Builder private $isMatching; /** - * @return null|float + *

Abstract value for categorizing a Cart. The range starts at 0. The default price covers 0, tiers start at 1. See Using Tiered Shipping Rates for details and examples.

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

Draft type that stores amounts in cent precision for the specified currency.

- *

For storing money values in fractions of the minor unit in a currency, use HighPrecisionMoneyDraft instead.

+ *

Defines a fixed price for the score.

* * @return null|Money */ @@ -62,6 +63,8 @@ public function getPrice() } /** + *

Dynamically calculates a Price for a range of scores.

+ * * @return null|PriceFunction */ public function getPriceFunction() @@ -70,6 +73,8 @@ public function getPriceFunction() } /** + *

Appears in response to Get ShippingMethods for a Cart if the shipping rate matches the search query.

+ * * @return null|bool */ public function getIsMatching() @@ -78,10 +83,10 @@ public function getIsMatching() } /** - * @param ?float $score + * @param ?int $score * @return $this */ - public function withScore(?float $score) + public function withScore(?int $score) { $this->score = $score; diff --git a/lib/commercetools-api/src/Models/ShippingMethod/CartScoreTierModel.php b/lib/commercetools-api/src/Models/ShippingMethod/CartScoreTierModel.php index 9dd8311d9e3..345b58e448a 100644 --- a/lib/commercetools-api/src/Models/ShippingMethod/CartScoreTierModel.php +++ b/lib/commercetools-api/src/Models/ShippingMethod/CartScoreTierModel.php @@ -28,7 +28,7 @@ final class CartScoreTierModel extends JsonObjectModel implements CartScoreTier protected $type; /** - * @var ?float + * @var ?int */ protected $score; @@ -52,7 +52,7 @@ final class CartScoreTierModel extends JsonObjectModel implements CartScoreTier * @psalm-suppress MissingParamType */ public function __construct( - ?float $score = null, + ?int $score = null, ?Money $price = null, ?PriceFunction $priceFunction = null, ?bool $isMatching = null @@ -65,8 +65,6 @@ public function __construct( } /** - *

Can be one of the following or absent.

- * * @return null|string */ public function getType() @@ -84,25 +82,26 @@ public function getType() } /** - * @return null|float + *

Abstract value for categorizing a Cart. The range starts at 0. The default price covers 0, tiers start at 1. See Using Tiered Shipping Rates for details and examples.

+ * + * @return null|int */ public function getScore() { if (is_null($this->score)) { - /** @psalm-var ?float $data */ + /** @psalm-var ?int $data */ $data = $this->raw(self::FIELD_SCORE); if (is_null($data)) { return null; } - $this->score = (float) $data; + $this->score = (int) $data; } return $this->score; } /** - *

Draft type that stores amounts in cent precision for the specified currency.

- *

For storing money values in fractions of the minor unit in a currency, use HighPrecisionMoneyDraft instead.

+ *

Defines a fixed price for the score.

* * @return null|Money */ @@ -122,6 +121,8 @@ public function getPrice() } /** + *

Dynamically calculates a Price for a range of scores.

+ * * @return null|PriceFunction */ public function getPriceFunction() @@ -140,6 +141,8 @@ public function getPriceFunction() } /** + *

Appears in response to Get ShippingMethods for a Cart if the shipping rate matches the search query.

+ * * @return null|bool */ public function getIsMatching() @@ -158,9 +161,9 @@ public function getIsMatching() /** - * @param ?float $score + * @param ?int $score */ - public function setScore(?float $score): void + public function setScore(?int $score): void { $this->score = $score; } diff --git a/lib/commercetools-api/src/Models/ShippingMethod/CartValueTier.php b/lib/commercetools-api/src/Models/ShippingMethod/CartValueTier.php index b4657166d42..7b08bdccf95 100644 --- a/lib/commercetools-api/src/Models/ShippingMethod/CartValueTier.php +++ b/lib/commercetools-api/src/Models/ShippingMethod/CartValueTier.php @@ -19,19 +19,22 @@ interface CartValueTier extends ShippingRatePriceTier public const FIELD_IS_MATCHING = 'isMatching'; /** + *

Minimum total price of a Cart for which a shipping rate applies.

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

Draft type that stores amounts in cent precision for the specified currency.

- *

For storing money values in fractions of the minor unit in a currency, use HighPrecisionMoneyDraft instead.

+ *

Fixed shipping rate Price for a CartValue.

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

Appears in response to Get ShippingMethods for a Cart if the shipping rate matches the search query.

+ * * @return null|bool */ public function getIsMatching(); diff --git a/lib/commercetools-api/src/Models/ShippingMethod/CartValueTierBuilder.php b/lib/commercetools-api/src/Models/ShippingMethod/CartValueTierBuilder.php index ff1666fad4c..7c39c1d8058 100644 --- a/lib/commercetools-api/src/Models/ShippingMethod/CartValueTierBuilder.php +++ b/lib/commercetools-api/src/Models/ShippingMethod/CartValueTierBuilder.php @@ -38,6 +38,8 @@ final class CartValueTierBuilder implements Builder private $isMatching; /** + *

Minimum total price of a Cart for which a shipping rate applies.

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

Draft type that stores amounts in cent precision for the specified currency.

- *

For storing money values in fractions of the minor unit in a currency, use HighPrecisionMoneyDraft instead.

+ *

Fixed shipping rate Price for a CartValue.

* * @return null|Money */ @@ -57,6 +58,8 @@ public function getPrice() } /** + *

Appears in response to Get ShippingMethods for a Cart if the shipping rate matches the search query.

+ * * @return null|bool */ public function getIsMatching() diff --git a/lib/commercetools-api/src/Models/ShippingMethod/CartValueTierModel.php b/lib/commercetools-api/src/Models/ShippingMethod/CartValueTierModel.php index e5981ebbe95..df4b6041009 100644 --- a/lib/commercetools-api/src/Models/ShippingMethod/CartValueTierModel.php +++ b/lib/commercetools-api/src/Models/ShippingMethod/CartValueTierModel.php @@ -58,8 +58,6 @@ public function __construct( } /** - *

Can be one of the following or absent.

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

Minimum total price of a Cart for which a shipping rate applies.

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

Draft type that stores amounts in cent precision for the specified currency.

- *

For storing money values in fractions of the minor unit in a currency, use HighPrecisionMoneyDraft instead.

+ *

Fixed shipping rate Price for a CartValue.

* * @return null|Money */ @@ -115,6 +114,8 @@ public function getPrice() } /** + *

Appears in response to Get ShippingMethods for a Cart if the shipping rate matches the search query.

+ * * @return null|bool */ public function getIsMatching() diff --git a/lib/commercetools-api/src/Models/ShippingMethod/PriceFunction.php b/lib/commercetools-api/src/Models/ShippingMethod/PriceFunction.php index 252b6665760..1c9e7b2b51c 100644 --- a/lib/commercetools-api/src/Models/ShippingMethod/PriceFunction.php +++ b/lib/commercetools-api/src/Models/ShippingMethod/PriceFunction.php @@ -24,6 +24,9 @@ interface PriceFunction extends JsonObject public function getCurrencyCode(); /** + *

To calculate a Price based on the score, use +, -, * and parentheses. The score is inserted with x. The function returns the cent amount.

+ *

For example, to charge $1.99 for a score of 1, $3.99 for a score of 2, $5.99 for a score of 3 and onwards, the function is: (200 * x) - 1). To charge $4.50, $6.00, and $7.50 for express shipping, the function is: (150 * x) + 300.

+ * * @return null|string */ public function getFunction(); diff --git a/lib/commercetools-api/src/Models/ShippingMethod/PriceFunctionBuilder.php b/lib/commercetools-api/src/Models/ShippingMethod/PriceFunctionBuilder.php index 23c05fa7eae..975f7e44810 100644 --- a/lib/commercetools-api/src/Models/ShippingMethod/PriceFunctionBuilder.php +++ b/lib/commercetools-api/src/Models/ShippingMethod/PriceFunctionBuilder.php @@ -41,6 +41,9 @@ public function getCurrencyCode() } /** + *

To calculate a Price based on the score, use +, -, * and parentheses. The score is inserted with x. The function returns the cent amount.

+ *

For example, to charge $1.99 for a score of 1, $3.99 for a score of 2, $5.99 for a score of 3 and onwards, the function is: (200 * x) - 1). To charge $4.50, $6.00, and $7.50 for express shipping, the function is: (150 * x) + 300.

+ * * @return null|string */ public function getFunction() diff --git a/lib/commercetools-api/src/Models/ShippingMethod/PriceFunctionModel.php b/lib/commercetools-api/src/Models/ShippingMethod/PriceFunctionModel.php index a4144a0f971..e9359e420ff 100644 --- a/lib/commercetools-api/src/Models/ShippingMethod/PriceFunctionModel.php +++ b/lib/commercetools-api/src/Models/ShippingMethod/PriceFunctionModel.php @@ -61,6 +61,9 @@ public function getCurrencyCode() } /** + *

To calculate a Price based on the score, use +, -, * and parentheses. The score is inserted with x. The function returns the cent amount.

+ *

For example, to charge $1.99 for a score of 1, $3.99 for a score of 2, $5.99 for a score of 3 and onwards, the function is: (200 * x) - 1). To charge $4.50, $6.00, and $7.50 for express shipping, the function is: (150 * x) + 300.

+ * * @return null|string */ public function getFunction() diff --git a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethod.php b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethod.php index 9e5a303b870..469eb172116 100644 --- a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethod.php +++ b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethod.php @@ -41,18 +41,22 @@ interface ShippingMethod extends BaseResource public function getId(); /** - *

The current version of the shipping method.

+ *

Current version of the ShippingMethod.

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

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

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

Date and time (UTC) the ShippingMethod was last updated.

+ * * @return null|DateTimeImmutable */ public function getLastModifiedAt(); @@ -79,50 +83,64 @@ public function getCreatedBy(); public function getKey(); /** + *

Name of the ShippingMethod.

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

Localized name of the ShippingMethod.

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

Description of the ShippingMethod.

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

Localized description of the ShippingMethod.

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

TaxCategory of all ZoneRates of the ShippingMethod.

+ * * @return null|TaxCategoryReference */ public function getTaxCategory(); /** + *

Defines ShippingRates (prices) for specific Zones.

+ * * @return null|ZoneRateCollection */ public function getZoneRates(); /** - *

One shipping method in a project can be default.

+ *

If true this ShippingMethod is the Project's default ShippingMethod.

* * @return null|bool */ public function getIsDefault(); /** - *

A Cart predicate which can be used to more precisely select a shipping method for a cart.

+ *

Valid Cart predicate to select a ShippingMethod for a Cart.

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

Custom Fields of the ShippingMethod.

+ * * @return null|CustomFields */ public function getCustom(); diff --git a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodAddShippingRateAction.php b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodAddShippingRateAction.php index dbf801ccedf..558a9f890ff 100644 --- a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodAddShippingRateAction.php +++ b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodAddShippingRateAction.php @@ -18,11 +18,15 @@ interface ShippingMethodAddShippingRateAction extends ShippingMethodUpdateAction public const FIELD_SHIPPING_RATE = 'shippingRate'; /** + *

Zone to which the ShippingRate should be added.

+ * * @return null|ZoneResourceIdentifier */ public function getZone(); /** + *

Value to add to shippingRates.

+ * * @return null|ShippingRateDraft */ public function getShippingRate(); diff --git a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodAddShippingRateActionBuilder.php b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodAddShippingRateActionBuilder.php index 976f6ec5271..c5c71bc077f 100644 --- a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodAddShippingRateActionBuilder.php +++ b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodAddShippingRateActionBuilder.php @@ -33,6 +33,8 @@ final class ShippingMethodAddShippingRateActionBuilder implements Builder private $shippingRate; /** + *

Zone to which the ShippingRate should be added.

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

Value to add to shippingRates.

+ * * @return null|ShippingRateDraft */ public function getShippingRate() diff --git a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodAddShippingRateActionModel.php b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodAddShippingRateActionModel.php index 8dde66c1304..749a95e2d10 100644 --- a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodAddShippingRateActionModel.php +++ b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodAddShippingRateActionModel.php @@ -68,6 +68,8 @@ public function getAction() } /** + *

Zone to which the ShippingRate should be added.

+ * * @return null|ZoneResourceIdentifier */ public function getZone() @@ -86,6 +88,8 @@ public function getZone() } /** + *

Value to add to shippingRates.

+ * * @return null|ShippingRateDraft */ public function getShippingRate() diff --git a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodAddZoneAction.php b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodAddZoneAction.php index a33573e2b28..0f605f28244 100644 --- a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodAddZoneAction.php +++ b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodAddZoneAction.php @@ -17,6 +17,8 @@ interface ShippingMethodAddZoneAction extends ShippingMethodUpdateAction public const FIELD_ZONE = 'zone'; /** + *

Value to add to zoneRates.

+ * * @return null|ZoneResourceIdentifier */ public function getZone(); diff --git a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodAddZoneActionBuilder.php b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodAddZoneActionBuilder.php index b78782f9aca..aee04d9b4d4 100644 --- a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodAddZoneActionBuilder.php +++ b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodAddZoneActionBuilder.php @@ -28,6 +28,8 @@ final class ShippingMethodAddZoneActionBuilder implements Builder private $zone; /** + *

Value to add to zoneRates.

+ * * @return null|ZoneResourceIdentifier */ public function getZone() diff --git a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodAddZoneActionModel.php b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodAddZoneActionModel.php index bd31c4b4c7a..e045046417b 100644 --- a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodAddZoneActionModel.php +++ b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodAddZoneActionModel.php @@ -61,6 +61,8 @@ public function getAction() } /** + *

Value to add to zoneRates.

+ * * @return null|ZoneResourceIdentifier */ public function getZone() diff --git a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodBuilder.php b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodBuilder.php index a8f0eaeb0fb..4e5f8acf380 100644 --- a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodBuilder.php +++ b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodBuilder.php @@ -124,7 +124,7 @@ public function getId() } /** - *

The current version of the shipping method.

+ *

Current version of the ShippingMethod.

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

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

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

Date and time (UTC) the ShippingMethod was last updated.

+ * * @return null|DateTimeImmutable */ public function getLastModifiedAt() @@ -180,6 +184,8 @@ public function getKey() } /** + *

Name of the ShippingMethod.

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

Localized name of the ShippingMethod.

+ * * @return null|LocalizedString */ public function getLocalizedName() @@ -196,6 +204,8 @@ public function getLocalizedName() } /** + *

Description of the ShippingMethod.

+ * * @return null|string */ public function getDescription() @@ -204,6 +214,8 @@ public function getDescription() } /** + *

Localized description of the ShippingMethod.

+ * * @return null|LocalizedString */ public function getLocalizedDescription() @@ -212,6 +224,8 @@ public function getLocalizedDescription() } /** + *

TaxCategory of all ZoneRates of the ShippingMethod.

+ * * @return null|TaxCategoryReference */ public function getTaxCategory() @@ -220,6 +234,8 @@ public function getTaxCategory() } /** + *

Defines ShippingRates (prices) for specific Zones.

+ * * @return null|ZoneRateCollection */ public function getZoneRates() @@ -228,7 +244,7 @@ public function getZoneRates() } /** - *

One shipping method in a project can be default.

+ *

If true this ShippingMethod is the Project's default ShippingMethod.

* * @return null|bool */ @@ -238,7 +254,7 @@ public function getIsDefault() } /** - *

A Cart predicate which can be used to more precisely select a shipping method for a cart.

+ *

Valid Cart predicate to select a ShippingMethod for a Cart.

* * @return null|string */ @@ -248,6 +264,8 @@ public function getPredicate() } /** + *

Custom Fields of the ShippingMethod.

+ * * @return null|CustomFields */ public function getCustom() diff --git a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodChangeIsDefaultAction.php b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodChangeIsDefaultAction.php index 4f0ff5131d1..fcad9ff237a 100644 --- a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodChangeIsDefaultAction.php +++ b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodChangeIsDefaultAction.php @@ -16,7 +16,7 @@ interface ShippingMethodChangeIsDefaultAction extends ShippingMethodUpdateAction public const FIELD_IS_DEFAULT = 'isDefault'; /** - *

Only one ShippingMethod in a project can be default.

+ *

Value to set. Only one ShippingMethod can be default in a Project.

* * @return null|bool */ diff --git a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodChangeIsDefaultActionBuilder.php b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodChangeIsDefaultActionBuilder.php index 7ad6981719a..d01a80bf2d5 100644 --- a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodChangeIsDefaultActionBuilder.php +++ b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodChangeIsDefaultActionBuilder.php @@ -26,7 +26,7 @@ final class ShippingMethodChangeIsDefaultActionBuilder implements Builder private $isDefault; /** - *

Only one ShippingMethod in a project can be default.

+ *

Value to set. Only one ShippingMethod can be default in a Project.

* * @return null|bool */ diff --git a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodChangeIsDefaultActionModel.php b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodChangeIsDefaultActionModel.php index f7e79cf7096..48164b93d34 100644 --- a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodChangeIsDefaultActionModel.php +++ b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodChangeIsDefaultActionModel.php @@ -59,7 +59,7 @@ public function getAction() } /** - *

Only one ShippingMethod in a project can be default.

+ *

Value to set. Only one ShippingMethod can be default in a Project.

* * @return null|bool */ diff --git a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodChangeNameAction.php b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodChangeNameAction.php index 18933ac86d3..98e5f193efb 100644 --- a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodChangeNameAction.php +++ b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodChangeNameAction.php @@ -16,6 +16,8 @@ interface ShippingMethodChangeNameAction extends ShippingMethodUpdateAction public const FIELD_NAME = 'name'; /** + *

Value to set. Must not be empty.

+ * * @return null|string */ public function getName(); diff --git a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodChangeNameActionBuilder.php b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodChangeNameActionBuilder.php index c06d5f4ed35..23109c3f47e 100644 --- a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodChangeNameActionBuilder.php +++ b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodChangeNameActionBuilder.php @@ -26,6 +26,8 @@ final class ShippingMethodChangeNameActionBuilder implements Builder private $name; /** + *

Value to set. Must not be empty.

+ * * @return null|string */ public function getName() diff --git a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodChangeNameActionModel.php b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodChangeNameActionModel.php index 62b72ee6a0d..bd15219541f 100644 --- a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodChangeNameActionModel.php +++ b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodChangeNameActionModel.php @@ -59,6 +59,8 @@ public function getAction() } /** + *

Value to set. Must not be empty.

+ * * @return null|string */ public function getName() diff --git a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodChangeTaxCategoryAction.php b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodChangeTaxCategoryAction.php index 558d1777947..2bd28777d71 100644 --- a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodChangeTaxCategoryAction.php +++ b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodChangeTaxCategoryAction.php @@ -17,6 +17,8 @@ interface ShippingMethodChangeTaxCategoryAction extends ShippingMethodUpdateActi public const FIELD_TAX_CATEGORY = 'taxCategory'; /** + *

Value to set.

+ * * @return null|TaxCategoryResourceIdentifier */ public function getTaxCategory(); diff --git a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodChangeTaxCategoryActionBuilder.php b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodChangeTaxCategoryActionBuilder.php index bfd4aaeec25..7c89f25c6b1 100644 --- a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodChangeTaxCategoryActionBuilder.php +++ b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodChangeTaxCategoryActionBuilder.php @@ -28,6 +28,8 @@ final class ShippingMethodChangeTaxCategoryActionBuilder implements Builder private $taxCategory; /** + *

Value to set.

+ * * @return null|TaxCategoryResourceIdentifier */ public function getTaxCategory() diff --git a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodChangeTaxCategoryActionModel.php b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodChangeTaxCategoryActionModel.php index b549ddd1a1d..0d49d2927aa 100644 --- a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodChangeTaxCategoryActionModel.php +++ b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodChangeTaxCategoryActionModel.php @@ -61,6 +61,8 @@ public function getAction() } /** + *

Value to set.

+ * * @return null|TaxCategoryResourceIdentifier */ public function getTaxCategory() diff --git a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodDraft.php b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodDraft.php index 116b30daf37..252be9f7932 100644 --- a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodDraft.php +++ b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodDraft.php @@ -35,50 +35,64 @@ interface ShippingMethodDraft extends JsonObject public function getKey(); /** + *

Name of the ShippingMethod.

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

Localized name of the ShippingMethod.

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

Description of the ShippingMethod.

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

Localized description of the ShippingMethod.

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

TaxCategory for all ZoneRates of the ShippingMethod.

+ * * @return null|TaxCategoryResourceIdentifier */ public function getTaxCategory(); /** + *

Defines ShippingRates (prices) for specific zones.

+ * * @return null|ZoneRateDraftCollection */ public function getZoneRates(); /** - *

If true the shipping method will be the default one in a project.

+ *

If true the ShippingMethod will be the Project's default ShippingMethod.

* * @return null|bool */ public function getIsDefault(); /** - *

A Cart predicate which can be used to more precisely select a shipping method for a cart.

+ *

Valid Cart predicate to select a ShippingMethod for a Cart.

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

Custom Fields for the ShippingMethod.

+ * * @return null|CustomFieldsDraft */ public function getCustom(); diff --git a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodDraftBuilder.php b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodDraftBuilder.php index 3ee6b85fea6..08eff4b49c4 100644 --- a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodDraftBuilder.php +++ b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodDraftBuilder.php @@ -87,6 +87,8 @@ public function getKey() } /** + *

Name of the ShippingMethod.

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

Localized name of the ShippingMethod.

+ * * @return null|LocalizedString */ public function getLocalizedName() @@ -103,6 +107,8 @@ public function getLocalizedName() } /** + *

Description of the ShippingMethod.

+ * * @return null|string */ public function getDescription() @@ -111,6 +117,8 @@ public function getDescription() } /** + *

Localized description of the ShippingMethod.

+ * * @return null|LocalizedString */ public function getLocalizedDescription() @@ -119,6 +127,8 @@ public function getLocalizedDescription() } /** + *

TaxCategory for all ZoneRates of the ShippingMethod.

+ * * @return null|TaxCategoryResourceIdentifier */ public function getTaxCategory() @@ -127,6 +137,8 @@ public function getTaxCategory() } /** + *

Defines ShippingRates (prices) for specific zones.

+ * * @return null|ZoneRateDraftCollection */ public function getZoneRates() @@ -135,7 +147,7 @@ public function getZoneRates() } /** - *

If true the shipping method will be the default one in a project.

+ *

If true the ShippingMethod will be the Project's default ShippingMethod.

* * @return null|bool */ @@ -145,7 +157,7 @@ public function getIsDefault() } /** - *

A Cart predicate which can be used to more precisely select a shipping method for a cart.

+ *

Valid Cart predicate to select a ShippingMethod for a Cart.

* * @return null|string */ @@ -155,6 +167,8 @@ public function getPredicate() } /** + *

Custom Fields for the ShippingMethod.

+ * * @return null|CustomFieldsDraft */ public function getCustom() diff --git a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodDraftModel.php b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodDraftModel.php index e9cce3f0840..75211a4c856 100644 --- a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodDraftModel.php +++ b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodDraftModel.php @@ -123,6 +123,8 @@ public function getKey() } /** + *

Name of the ShippingMethod.

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

Localized name of the ShippingMethod.

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

Description of the ShippingMethod.

+ * * @return null|string */ public function getDescription() @@ -175,6 +181,8 @@ public function getDescription() } /** + *

Localized description of the ShippingMethod.

+ * * @return null|LocalizedString */ public function getLocalizedDescription() @@ -193,6 +201,8 @@ public function getLocalizedDescription() } /** + *

TaxCategory for all ZoneRates of the ShippingMethod.

+ * * @return null|TaxCategoryResourceIdentifier */ public function getTaxCategory() @@ -211,6 +221,8 @@ public function getTaxCategory() } /** + *

Defines ShippingRates (prices) for specific zones.

+ * * @return null|ZoneRateDraftCollection */ public function getZoneRates() @@ -228,7 +240,7 @@ public function getZoneRates() } /** - *

If true the shipping method will be the default one in a project.

+ *

If true the ShippingMethod will be the Project's default ShippingMethod.

* * @return null|bool */ @@ -247,7 +259,7 @@ public function getIsDefault() } /** - *

A Cart predicate which can be used to more precisely select a shipping method for a cart.

+ *

Valid Cart predicate to select a ShippingMethod for a Cart.

* * @return null|string */ @@ -266,6 +278,8 @@ public function getPredicate() } /** + *

Custom Fields for the ShippingMethod.

+ * * @return null|CustomFieldsDraft */ public function getCustom() diff --git a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodModel.php b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodModel.php index e9a9aea9419..4ad696076ec 100644 --- a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodModel.php +++ b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodModel.php @@ -172,7 +172,7 @@ public function getId() } /** - *

The current version of the shipping method.

+ *

Current version of the ShippingMethod.

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

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

+ * * @return null|DateTimeImmutable */ public function getCreatedAt() @@ -212,6 +214,8 @@ public function getCreatedAt() } /** + *

Date and time (UTC) the ShippingMethod was last updated.

+ * * @return null|DateTimeImmutable */ public function getLastModifiedAt() @@ -292,6 +296,8 @@ public function getKey() } /** + *

Name of the ShippingMethod.

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

Localized name of the ShippingMethod.

+ * * @return null|LocalizedString */ public function getLocalizedName() @@ -327,6 +335,8 @@ public function getLocalizedName() } /** + *

Description of the ShippingMethod.

+ * * @return null|string */ public function getDescription() @@ -344,6 +354,8 @@ public function getDescription() } /** + *

Localized description of the ShippingMethod.

+ * * @return null|LocalizedString */ public function getLocalizedDescription() @@ -362,6 +374,8 @@ public function getLocalizedDescription() } /** + *

TaxCategory of all ZoneRates of the ShippingMethod.

+ * * @return null|TaxCategoryReference */ public function getTaxCategory() @@ -380,6 +394,8 @@ public function getTaxCategory() } /** + *

Defines ShippingRates (prices) for specific Zones.

+ * * @return null|ZoneRateCollection */ public function getZoneRates() @@ -397,7 +413,7 @@ public function getZoneRates() } /** - *

One shipping method in a project can be default.

+ *

If true this ShippingMethod is the Project's default ShippingMethod.

* * @return null|bool */ @@ -416,7 +432,7 @@ public function getIsDefault() } /** - *

A Cart predicate which can be used to more precisely select a shipping method for a cart.

+ *

Valid Cart predicate to select a ShippingMethod for a Cart.

* * @return null|string */ @@ -435,6 +451,8 @@ public function getPredicate() } /** + *

Custom Fields of the ShippingMethod.

+ * * @return null|CustomFields */ public function getCustom() diff --git a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodPagedQueryResponse.php b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodPagedQueryResponse.php index 03c6bc9c2c0..7fbe40aae7e 100644 --- a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodPagedQueryResponse.php +++ b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodPagedQueryResponse.php @@ -27,11 +27,19 @@ interface ShippingMethodPagedQueryResponse extends JsonObject public function getLimit(); /** + *

Actual number of results returned.

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

Total number of results matching the query. + * This number is an estimation that is not strongly consistent. + * This field is returned by default. + * For improved performance, calculating this field can be deactivated by using the query parameter withTotal=false. + * When the results are filtered with a Query Predicate, total is subject to a limit.

+ * * @return null|int */ public function getTotal(); @@ -44,6 +52,8 @@ public function getTotal(); public function getOffset(); /** + *

Shipping Methods matching the query.

+ * * @return null|ShippingMethodCollection */ public function getResults(); diff --git a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodPagedQueryResponseBuilder.php b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodPagedQueryResponseBuilder.php index 7349c5c863e..2b6c20ca1d3 100644 --- a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodPagedQueryResponseBuilder.php +++ b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodPagedQueryResponseBuilder.php @@ -56,6 +56,8 @@ public function getLimit() } /** + *

Actual number of results returned.

+ * * @return null|int */ public function getCount() @@ -64,6 +66,12 @@ public function getCount() } /** + *

Total number of results matching the query. + * This number is an estimation that is not strongly consistent. + * This field is returned by default. + * For improved performance, calculating this field can be deactivated by using the query parameter withTotal=false. + * When the results are filtered with a Query Predicate, total is subject to a limit.

+ * * @return null|int */ public function getTotal() @@ -82,6 +90,8 @@ public function getOffset() } /** + *

Shipping Methods matching the query.

+ * * @return null|ShippingMethodCollection */ public function getResults() diff --git a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodPagedQueryResponseModel.php b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodPagedQueryResponseModel.php index 2bc11106870..7156e5111e1 100644 --- a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodPagedQueryResponseModel.php +++ b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodPagedQueryResponseModel.php @@ -82,6 +82,8 @@ public function getLimit() } /** + *

Actual number of results returned.

+ * * @return null|int */ public function getCount() @@ -99,6 +101,12 @@ public function getCount() } /** + *

Total number of results matching the query. + * This number is an estimation that is not strongly consistent. + * This field is returned by default. + * For improved performance, calculating this field can be deactivated by using the query parameter withTotal=false. + * When the results are filtered with a Query Predicate, total is subject to a limit.

+ * * @return null|int */ public function getTotal() @@ -135,6 +143,8 @@ public function getOffset() } /** + *

Shipping Methods matching the query.

+ * * @return null|ShippingMethodCollection */ public function getResults() diff --git a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodReference.php b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodReference.php index 589aa280682..6b5a732446f 100644 --- a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodReference.php +++ b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodReference.php @@ -17,7 +17,7 @@ interface ShippingMethodReference extends Reference public const FIELD_OBJ = 'obj'; /** - *

Contains the representation of the expanded Review. Only present in responses to requests with Reference Expansion for ShippingMethods.

+ *

Contains the representation of the expanded ShippingMethod. Only present in responses to requests with Reference Expansion for ShippingMethods.

* * @return null|ShippingMethod */ diff --git a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodReferenceBuilder.php b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodReferenceBuilder.php index d630e7f9270..acfa03cda53 100644 --- a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodReferenceBuilder.php +++ b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodReferenceBuilder.php @@ -43,7 +43,7 @@ public function getId() } /** - *

Contains the representation of the expanded Review. Only present in responses to requests with Reference Expansion for ShippingMethods.

+ *

Contains the representation of the expanded ShippingMethod. Only present in responses to requests with Reference Expansion for ShippingMethods.

* * @return null|ShippingMethod */ diff --git a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodReferenceModel.php b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodReferenceModel.php index 821da4c4f9c..9b939b61ec9 100644 --- a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodReferenceModel.php +++ b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodReferenceModel.php @@ -89,7 +89,7 @@ public function getId() } /** - *

Contains the representation of the expanded Review. Only present in responses to requests with Reference Expansion for ShippingMethods.

+ *

Contains the representation of the expanded ShippingMethod. Only present in responses to requests with Reference Expansion for ShippingMethods.

* * @return null|ShippingMethod */ diff --git a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodRemoveShippingRateAction.php b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodRemoveShippingRateAction.php index 32f3de912b1..c2decdbbff6 100644 --- a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodRemoveShippingRateAction.php +++ b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodRemoveShippingRateAction.php @@ -18,11 +18,15 @@ interface ShippingMethodRemoveShippingRateAction extends ShippingMethodUpdateAct public const FIELD_SHIPPING_RATE = 'shippingRate'; /** + *

Zone from which the ShippingRate should be removed.

+ * * @return null|ZoneResourceIdentifier */ public function getZone(); /** + *

Value to remove from shippingRates.

+ * * @return null|ShippingRateDraft */ public function getShippingRate(); diff --git a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodRemoveShippingRateActionBuilder.php b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodRemoveShippingRateActionBuilder.php index 07ee2f9b4f6..dd27c97f9cd 100644 --- a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodRemoveShippingRateActionBuilder.php +++ b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodRemoveShippingRateActionBuilder.php @@ -33,6 +33,8 @@ final class ShippingMethodRemoveShippingRateActionBuilder implements Builder private $shippingRate; /** + *

Zone from which the ShippingRate should be removed.

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

Value to remove from shippingRates.

+ * * @return null|ShippingRateDraft */ public function getShippingRate() diff --git a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodRemoveShippingRateActionModel.php b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodRemoveShippingRateActionModel.php index 425e8412803..2057244c86c 100644 --- a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodRemoveShippingRateActionModel.php +++ b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodRemoveShippingRateActionModel.php @@ -68,6 +68,8 @@ public function getAction() } /** + *

Zone from which the ShippingRate should be removed.

+ * * @return null|ZoneResourceIdentifier */ public function getZone() @@ -86,6 +88,8 @@ public function getZone() } /** + *

Value to remove from shippingRates.

+ * * @return null|ShippingRateDraft */ public function getShippingRate() diff --git a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodRemoveZoneAction.php b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodRemoveZoneAction.php index 4db4b7253d3..0b7a1c47df3 100644 --- a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodRemoveZoneAction.php +++ b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodRemoveZoneAction.php @@ -17,6 +17,8 @@ interface ShippingMethodRemoveZoneAction extends ShippingMethodUpdateAction public const FIELD_ZONE = 'zone'; /** + *

Value to remove from zoneRates.

+ * * @return null|ZoneResourceIdentifier */ public function getZone(); diff --git a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodRemoveZoneActionBuilder.php b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodRemoveZoneActionBuilder.php index c91a0144b2e..d441d31fb4b 100644 --- a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodRemoveZoneActionBuilder.php +++ b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodRemoveZoneActionBuilder.php @@ -28,6 +28,8 @@ final class ShippingMethodRemoveZoneActionBuilder implements Builder private $zone; /** + *

Value to remove from zoneRates.

+ * * @return null|ZoneResourceIdentifier */ public function getZone() diff --git a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodRemoveZoneActionModel.php b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodRemoveZoneActionModel.php index 0b99ab28808..68ab5d577f1 100644 --- a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodRemoveZoneActionModel.php +++ b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodRemoveZoneActionModel.php @@ -61,6 +61,8 @@ public function getAction() } /** + *

Value to remove from zoneRates.

+ * * @return null|ZoneResourceIdentifier */ public function getZone() diff --git a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodSetDescriptionAction.php b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodSetDescriptionAction.php index 9228e6fe883..d4a05c09291 100644 --- a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodSetDescriptionAction.php +++ b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodSetDescriptionAction.php @@ -16,6 +16,8 @@ interface ShippingMethodSetDescriptionAction extends ShippingMethodUpdateAction public const FIELD_DESCRIPTION = 'description'; /** + *

Value to set. If empty, any existing value will be removed.

+ * * @return null|string */ public function getDescription(); diff --git a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodSetDescriptionActionBuilder.php b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodSetDescriptionActionBuilder.php index 935a54d4b53..ecf7ac5b692 100644 --- a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodSetDescriptionActionBuilder.php +++ b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodSetDescriptionActionBuilder.php @@ -26,6 +26,8 @@ final class ShippingMethodSetDescriptionActionBuilder implements Builder private $description; /** + *

Value to set. If empty, any existing value will be removed.

+ * * @return null|string */ public function getDescription() diff --git a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodSetDescriptionActionModel.php b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodSetDescriptionActionModel.php index 8e3094a889c..39c628e4b11 100644 --- a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodSetDescriptionActionModel.php +++ b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodSetDescriptionActionModel.php @@ -59,6 +59,8 @@ public function getAction() } /** + *

Value to set. If empty, any existing value will be removed.

+ * * @return null|string */ public function getDescription() diff --git a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodSetKeyAction.php b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodSetKeyAction.php index daa8cd2d993..f90a0816a22 100644 --- a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodSetKeyAction.php +++ b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodSetKeyAction.php @@ -16,7 +16,7 @@ interface ShippingMethodSetKeyAction extends ShippingMethodUpdateAction public const FIELD_KEY = 'key'; /** - *

If key is absent or null, it is removed if it exists.

+ *

If key is absent or null, the existing key, if any, will be removed.

* * @return null|string */ diff --git a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodSetKeyActionBuilder.php b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodSetKeyActionBuilder.php index 0d0bbaef1e6..e301adf8d49 100644 --- a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodSetKeyActionBuilder.php +++ b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodSetKeyActionBuilder.php @@ -26,7 +26,7 @@ final class ShippingMethodSetKeyActionBuilder implements Builder private $key; /** - *

If key is absent or null, it is removed if it exists.

+ *

If key is absent or null, the existing key, if any, will be removed.

* * @return null|string */ diff --git a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodSetKeyActionModel.php b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodSetKeyActionModel.php index 033de8e7f7e..c0d27f4dd99 100644 --- a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodSetKeyActionModel.php +++ b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodSetKeyActionModel.php @@ -59,7 +59,7 @@ public function getAction() } /** - *

If key is absent or null, it is removed if it exists.

+ *

If key is absent or null, the existing key, if any, will be removed.

* * @return null|string */ diff --git a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodSetLocalizedDescriptionAction.php b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodSetLocalizedDescriptionAction.php index a34f31c8aea..0f4de8b2566 100644 --- a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodSetLocalizedDescriptionAction.php +++ b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodSetLocalizedDescriptionAction.php @@ -17,6 +17,8 @@ interface ShippingMethodSetLocalizedDescriptionAction extends ShippingMethodUpda public const FIELD_LOCALIZED_DESCRIPTION = 'localizedDescription'; /** + *

Value to set. If empty, any existing value will be removed.

+ * * @return null|LocalizedString */ public function getLocalizedDescription(); diff --git a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodSetLocalizedDescriptionActionBuilder.php b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodSetLocalizedDescriptionActionBuilder.php index 777885c93d6..80d6c1f3b40 100644 --- a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodSetLocalizedDescriptionActionBuilder.php +++ b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodSetLocalizedDescriptionActionBuilder.php @@ -28,6 +28,8 @@ final class ShippingMethodSetLocalizedDescriptionActionBuilder implements Builde private $localizedDescription; /** + *

Value to set. If empty, any existing value will be removed.

+ * * @return null|LocalizedString */ public function getLocalizedDescription() diff --git a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodSetLocalizedDescriptionActionModel.php b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodSetLocalizedDescriptionActionModel.php index 9811133d50c..0c7d435c319 100644 --- a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodSetLocalizedDescriptionActionModel.php +++ b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodSetLocalizedDescriptionActionModel.php @@ -61,6 +61,8 @@ public function getAction() } /** + *

Value to set. If empty, any existing value will be removed.

+ * * @return null|LocalizedString */ public function getLocalizedDescription() diff --git a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodSetLocalizedNameAction.php b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodSetLocalizedNameAction.php index f67848ff65d..4bdef4e9b3e 100644 --- a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodSetLocalizedNameAction.php +++ b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodSetLocalizedNameAction.php @@ -17,6 +17,8 @@ interface ShippingMethodSetLocalizedNameAction extends ShippingMethodUpdateActio public const FIELD_LOCALIZED_NAME = 'localizedName'; /** + *

Value to set. If empty, any existing value will be removed.

+ * * @return null|LocalizedString */ public function getLocalizedName(); diff --git a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodSetLocalizedNameActionBuilder.php b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodSetLocalizedNameActionBuilder.php index a7e1aaed91c..3aed788be47 100644 --- a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodSetLocalizedNameActionBuilder.php +++ b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodSetLocalizedNameActionBuilder.php @@ -28,6 +28,8 @@ final class ShippingMethodSetLocalizedNameActionBuilder implements Builder private $localizedName; /** + *

Value to set. If empty, any existing value will be removed.

+ * * @return null|LocalizedString */ public function getLocalizedName() diff --git a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodSetLocalizedNameActionModel.php b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodSetLocalizedNameActionModel.php index f5d1a2efe41..c4b8d283ebc 100644 --- a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodSetLocalizedNameActionModel.php +++ b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodSetLocalizedNameActionModel.php @@ -61,6 +61,8 @@ public function getAction() } /** + *

Value to set. If empty, any existing value will be removed.

+ * * @return null|LocalizedString */ public function getLocalizedName() diff --git a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodSetPredicateAction.php b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodSetPredicateAction.php index cc5d4c4aae3..e6039aab3d6 100644 --- a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodSetPredicateAction.php +++ b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodSetPredicateAction.php @@ -16,8 +16,7 @@ interface ShippingMethodSetPredicateAction extends ShippingMethodUpdateAction public const FIELD_PREDICATE = 'predicate'; /** - *

A valid Cart predicate. - * If predicate is absent or null, it is removed if it exists.

+ *

A valid Cart predicate. If predicate is absent or null, it is removed if it exists.

* * @return null|string */ diff --git a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodSetPredicateActionBuilder.php b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodSetPredicateActionBuilder.php index aabbc095ec2..85ba2562607 100644 --- a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodSetPredicateActionBuilder.php +++ b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodSetPredicateActionBuilder.php @@ -26,8 +26,7 @@ final class ShippingMethodSetPredicateActionBuilder implements Builder private $predicate; /** - *

A valid Cart predicate. - * If predicate is absent or null, it is removed if it exists.

+ *

A valid Cart predicate. If predicate is absent or null, it is removed if it exists.

* * @return null|string */ diff --git a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodSetPredicateActionModel.php b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodSetPredicateActionModel.php index 869b26eab6b..6f34f06d759 100644 --- a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodSetPredicateActionModel.php +++ b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodSetPredicateActionModel.php @@ -59,8 +59,7 @@ public function getAction() } /** - *

A valid Cart predicate. - * If predicate is absent or null, it is removed if it exists.

+ *

A valid Cart predicate. If predicate is absent or null, it is removed if it exists.

* * @return null|string */ diff --git a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodUpdate.php b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodUpdate.php index a86cf1c141c..5bdcc6caa86 100644 --- a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodUpdate.php +++ b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodUpdate.php @@ -17,11 +17,15 @@ interface ShippingMethodUpdate extends JsonObject public const FIELD_ACTIONS = 'actions'; /** + *

Expected version of the ShippingMethod on which the changes should be applied. If the expected version does not match the actual version, a 409 Conflict will be returned.

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

Update actions to be performed on the ShippingMethod.

+ * * @return null|ShippingMethodUpdateActionCollection */ public function getActions(); diff --git a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodUpdateBuilder.php b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodUpdateBuilder.php index 31b33472c7f..181ce80b96a 100644 --- a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodUpdateBuilder.php +++ b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodUpdateBuilder.php @@ -31,6 +31,8 @@ final class ShippingMethodUpdateBuilder implements Builder private $actions; /** + *

Expected version of the ShippingMethod on which the changes should be applied. If the expected version does not match the actual version, a 409 Conflict will be returned.

+ * * @return null|int */ public function getVersion() @@ -39,6 +41,8 @@ public function getVersion() } /** + *

Update actions to be performed on the ShippingMethod.

+ * * @return null|ShippingMethodUpdateActionCollection */ public function getActions() diff --git a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodUpdateModel.php b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodUpdateModel.php index e23d7f95744..b792ab99ade 100644 --- a/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodUpdateModel.php +++ b/lib/commercetools-api/src/Models/ShippingMethod/ShippingMethodUpdateModel.php @@ -42,6 +42,8 @@ public function __construct( } /** + *

Expected version of the ShippingMethod on which the changes should be applied. If the expected version does not match the actual version, a 409 Conflict will be returned.

+ * * @return null|int */ public function getVersion() @@ -59,6 +61,8 @@ public function getVersion() } /** + *

Update actions to be performed on the ShippingMethod.

+ * * @return null|ShippingMethodUpdateActionCollection */ public function getActions() diff --git a/lib/commercetools-api/src/Models/ShippingMethod/ShippingRate.php b/lib/commercetools-api/src/Models/ShippingMethod/ShippingRate.php index e41879844bd..3782683dd72 100644 --- a/lib/commercetools-api/src/Models/ShippingMethod/ShippingRate.php +++ b/lib/commercetools-api/src/Models/ShippingMethod/ShippingRate.php @@ -20,28 +20,30 @@ interface ShippingRate extends JsonObject public const FIELD_TIERS = 'tiers'; /** + *

Currency amount of the ShippingRate.

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

The shipping is free if the order total (the sum of line item prices) exceeds the freeAbove value. - * Note: freeAbove applies before any Cart or Product discounts, and can cause discounts to apply in invalid scenarios. - * Use a Cart Discount to set the shipping price to 0 to avoid providing free shipping in invalid discount scenarios.

+ *

Shipping is free if the sum of the (Custom) Line Item Prices reaches the specified value.

* * @return null|TypedMoney */ public function getFreeAbove(); /** - *

Only appears in response to requests for shipping methods by cart or location to mark this shipping rate as one that matches the cart or location.

+ *

true if the ShippingRate matches given Cart or Location. + * Only appears in response to requests for Get ShippingMethods for a Cart or + * Get ShippingMethods for a Location.

* * @return null|bool */ public function getIsMatching(); /** - *

A list of shipping rate price tiers.

+ *

Price tiers for the ShippingRate.

* * @return null|ShippingRatePriceTierCollection */ diff --git a/lib/commercetools-api/src/Models/ShippingMethod/ShippingRateBuilder.php b/lib/commercetools-api/src/Models/ShippingMethod/ShippingRateBuilder.php index e54f97218bc..df06c71845f 100644 --- a/lib/commercetools-api/src/Models/ShippingMethod/ShippingRateBuilder.php +++ b/lib/commercetools-api/src/Models/ShippingMethod/ShippingRateBuilder.php @@ -43,6 +43,8 @@ final class ShippingRateBuilder implements Builder private $tiers; /** + *

Currency amount of the ShippingRate.

+ * * @return null|TypedMoney */ public function getPrice() @@ -51,9 +53,7 @@ public function getPrice() } /** - *

The shipping is free if the order total (the sum of line item prices) exceeds the freeAbove value. - * Note: freeAbove applies before any Cart or Product discounts, and can cause discounts to apply in invalid scenarios. - * Use a Cart Discount to set the shipping price to 0 to avoid providing free shipping in invalid discount scenarios.

+ *

Shipping is free if the sum of the (Custom) Line Item Prices reaches the specified value.

* * @return null|TypedMoney */ @@ -63,7 +63,9 @@ public function getFreeAbove() } /** - *

Only appears in response to requests for shipping methods by cart or location to mark this shipping rate as one that matches the cart or location.

+ *

true if the ShippingRate matches given Cart or Location. + * Only appears in response to requests for Get ShippingMethods for a Cart or + * Get ShippingMethods for a Location.

* * @return null|bool */ @@ -73,7 +75,7 @@ public function getIsMatching() } /** - *

A list of shipping rate price tiers.

+ *

Price tiers for the ShippingRate.

* * @return null|ShippingRatePriceTierCollection */ diff --git a/lib/commercetools-api/src/Models/ShippingMethod/ShippingRateDraft.php b/lib/commercetools-api/src/Models/ShippingMethod/ShippingRateDraft.php index b046a00c1e5..048e9604604 100644 --- a/lib/commercetools-api/src/Models/ShippingMethod/ShippingRateDraft.php +++ b/lib/commercetools-api/src/Models/ShippingMethod/ShippingRateDraft.php @@ -19,21 +19,21 @@ interface ShippingRateDraft extends JsonObject public const FIELD_TIERS = 'tiers'; /** + *

Money value of the ShippingRate.

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

The shipping is free if the order total (the sum of line item prices) exceeds the freeAbove value. - * Note: freeAbove applies before any Cart or Product discounts, and can cause discounts to apply in invalid scenarios. - * Use a Cart Discount to set the shipping price to 0 to avoid providing free shipping in invalid discount scenarios.

+ *

Shipping is free if the sum of the (Custom) Line Item Prices reaches the specified value.

* * @return null|Money */ public function getFreeAbove(); /** - *

A list of shipping rate price tiers.

+ *

Price tiers for the ShippingRate.

* * @return null|ShippingRatePriceTierCollection */ diff --git a/lib/commercetools-api/src/Models/ShippingMethod/ShippingRateDraftBuilder.php b/lib/commercetools-api/src/Models/ShippingMethod/ShippingRateDraftBuilder.php index c2a381e8805..0c4252a2dd2 100644 --- a/lib/commercetools-api/src/Models/ShippingMethod/ShippingRateDraftBuilder.php +++ b/lib/commercetools-api/src/Models/ShippingMethod/ShippingRateDraftBuilder.php @@ -38,6 +38,8 @@ final class ShippingRateDraftBuilder implements Builder private $tiers; /** + *

Money value of the ShippingRate.

+ * * @return null|Money */ public function getPrice() @@ -46,9 +48,7 @@ public function getPrice() } /** - *

The shipping is free if the order total (the sum of line item prices) exceeds the freeAbove value. - * Note: freeAbove applies before any Cart or Product discounts, and can cause discounts to apply in invalid scenarios. - * Use a Cart Discount to set the shipping price to 0 to avoid providing free shipping in invalid discount scenarios.

+ *

Shipping is free if the sum of the (Custom) Line Item Prices reaches the specified value.

* * @return null|Money */ @@ -58,7 +58,7 @@ public function getFreeAbove() } /** - *

A list of shipping rate price tiers.

+ *

Price tiers for the ShippingRate.

* * @return null|ShippingRatePriceTierCollection */ diff --git a/lib/commercetools-api/src/Models/ShippingMethod/ShippingRateDraftModel.php b/lib/commercetools-api/src/Models/ShippingMethod/ShippingRateDraftModel.php index ad91f752701..656b4c9e077 100644 --- a/lib/commercetools-api/src/Models/ShippingMethod/ShippingRateDraftModel.php +++ b/lib/commercetools-api/src/Models/ShippingMethod/ShippingRateDraftModel.php @@ -51,6 +51,8 @@ public function __construct( } /** + *

Money value of the ShippingRate.

+ * * @return null|Money */ public function getPrice() @@ -69,9 +71,7 @@ public function getPrice() } /** - *

The shipping is free if the order total (the sum of line item prices) exceeds the freeAbove value. - * Note: freeAbove applies before any Cart or Product discounts, and can cause discounts to apply in invalid scenarios. - * Use a Cart Discount to set the shipping price to 0 to avoid providing free shipping in invalid discount scenarios.

+ *

Shipping is free if the sum of the (Custom) Line Item Prices reaches the specified value.

* * @return null|Money */ @@ -91,7 +91,7 @@ public function getFreeAbove() } /** - *

A list of shipping rate price tiers.

+ *

Price tiers for the ShippingRate.

* * @return null|ShippingRatePriceTierCollection */ diff --git a/lib/commercetools-api/src/Models/ShippingMethod/ShippingRateModel.php b/lib/commercetools-api/src/Models/ShippingMethod/ShippingRateModel.php index 9e6b3e03d34..288447d4228 100644 --- a/lib/commercetools-api/src/Models/ShippingMethod/ShippingRateModel.php +++ b/lib/commercetools-api/src/Models/ShippingMethod/ShippingRateModel.php @@ -58,6 +58,8 @@ public function __construct( } /** + *

Currency amount of the ShippingRate.

+ * * @return null|TypedMoney */ public function getPrice() @@ -76,9 +78,7 @@ public function getPrice() } /** - *

The shipping is free if the order total (the sum of line item prices) exceeds the freeAbove value. - * Note: freeAbove applies before any Cart or Product discounts, and can cause discounts to apply in invalid scenarios. - * Use a Cart Discount to set the shipping price to 0 to avoid providing free shipping in invalid discount scenarios.

+ *

Shipping is free if the sum of the (Custom) Line Item Prices reaches the specified value.

* * @return null|TypedMoney */ @@ -98,7 +98,9 @@ public function getFreeAbove() } /** - *

Only appears in response to requests for shipping methods by cart or location to mark this shipping rate as one that matches the cart or location.

+ *

true if the ShippingRate matches given Cart or Location. + * Only appears in response to requests for Get ShippingMethods for a Cart or + * Get ShippingMethods for a Location.

* * @return null|bool */ @@ -117,7 +119,7 @@ public function getIsMatching() } /** - *

A list of shipping rate price tiers.

+ *

Price tiers for the ShippingRate.

* * @return null|ShippingRatePriceTierCollection */ diff --git a/lib/commercetools-api/src/Models/ShippingMethod/ShippingRatePriceTier.php b/lib/commercetools-api/src/Models/ShippingMethod/ShippingRatePriceTier.php index d3ab12ad332..b867837a6f2 100644 --- a/lib/commercetools-api/src/Models/ShippingMethod/ShippingRatePriceTier.php +++ b/lib/commercetools-api/src/Models/ShippingMethod/ShippingRatePriceTier.php @@ -17,8 +17,6 @@ interface ShippingRatePriceTier extends JsonObject public const FIELD_TYPE = 'type'; /** - *

Can be one of the following or absent.

- * * @return null|string */ public function getType(); diff --git a/lib/commercetools-api/src/Models/ShippingMethod/ShippingRatePriceTierModel.php b/lib/commercetools-api/src/Models/ShippingMethod/ShippingRatePriceTierModel.php index 3a0470e0d03..1ddc429f9be 100644 --- a/lib/commercetools-api/src/Models/ShippingMethod/ShippingRatePriceTierModel.php +++ b/lib/commercetools-api/src/Models/ShippingMethod/ShippingRatePriceTierModel.php @@ -44,8 +44,6 @@ public function __construct( } /** - *

Can be one of the following or absent.

- * * @return null|string */ public function getType() diff --git a/lib/commercetools-api/src/Models/ShippingMethod/ZoneRate.php b/lib/commercetools-api/src/Models/ShippingMethod/ZoneRate.php index 77332aa4b58..85944e29cc5 100644 --- a/lib/commercetools-api/src/Models/ShippingMethod/ZoneRate.php +++ b/lib/commercetools-api/src/Models/ShippingMethod/ZoneRate.php @@ -18,12 +18,14 @@ interface ZoneRate extends JsonObject public const FIELD_SHIPPING_RATES = 'shippingRates'; /** + *

Zone for which the shipping rates are valid.

+ * * @return null|ZoneReference */ public function getZone(); /** - *

The array does not contain two shipping rates with the same currency.

+ *

Shipping rates defined per currency.

* * @return null|ShippingRateCollection */ diff --git a/lib/commercetools-api/src/Models/ShippingMethod/ZoneRateBuilder.php b/lib/commercetools-api/src/Models/ShippingMethod/ZoneRateBuilder.php index b357a269018..3da87714b32 100644 --- a/lib/commercetools-api/src/Models/ShippingMethod/ZoneRateBuilder.php +++ b/lib/commercetools-api/src/Models/ShippingMethod/ZoneRateBuilder.php @@ -33,6 +33,8 @@ final class ZoneRateBuilder implements Builder private $shippingRates; /** + *

Zone for which the shipping rates are valid.

+ * * @return null|ZoneReference */ public function getZone() @@ -41,7 +43,7 @@ public function getZone() } /** - *

The array does not contain two shipping rates with the same currency.

+ *

Shipping rates defined per currency.

* * @return null|ShippingRateCollection */ diff --git a/lib/commercetools-api/src/Models/ShippingMethod/ZoneRateDraft.php b/lib/commercetools-api/src/Models/ShippingMethod/ZoneRateDraft.php index 106ad0f69dd..869bf5cc3ab 100644 --- a/lib/commercetools-api/src/Models/ShippingMethod/ZoneRateDraft.php +++ b/lib/commercetools-api/src/Models/ShippingMethod/ZoneRateDraft.php @@ -18,12 +18,14 @@ interface ZoneRateDraft extends JsonObject public const FIELD_SHIPPING_RATES = 'shippingRates'; /** + *

Sets the Zone for which the shippng rates are valid.

+ * * @return null|ZoneResourceIdentifier */ public function getZone(); /** - *

The array must not contain two shipping rates with the same currency.

+ *

Shipping rates for the currencies configured in the Project. The array must not contain two ShippingRates with the same CurrencyCode.

* * @return null|ShippingRateDraftCollection */ diff --git a/lib/commercetools-api/src/Models/ShippingMethod/ZoneRateDraftBuilder.php b/lib/commercetools-api/src/Models/ShippingMethod/ZoneRateDraftBuilder.php index 38acc552a33..d25c14de87d 100644 --- a/lib/commercetools-api/src/Models/ShippingMethod/ZoneRateDraftBuilder.php +++ b/lib/commercetools-api/src/Models/ShippingMethod/ZoneRateDraftBuilder.php @@ -33,6 +33,8 @@ final class ZoneRateDraftBuilder implements Builder private $shippingRates; /** + *

Sets the Zone for which the shippng rates are valid.

+ * * @return null|ZoneResourceIdentifier */ public function getZone() @@ -41,7 +43,7 @@ public function getZone() } /** - *

The array must not contain two shipping rates with the same currency.

+ *

Shipping rates for the currencies configured in the Project. The array must not contain two ShippingRates with the same CurrencyCode.

* * @return null|ShippingRateDraftCollection */ diff --git a/lib/commercetools-api/src/Models/ShippingMethod/ZoneRateDraftModel.php b/lib/commercetools-api/src/Models/ShippingMethod/ZoneRateDraftModel.php index 4973a67c3c3..95445cd5c04 100644 --- a/lib/commercetools-api/src/Models/ShippingMethod/ZoneRateDraftModel.php +++ b/lib/commercetools-api/src/Models/ShippingMethod/ZoneRateDraftModel.php @@ -44,6 +44,8 @@ public function __construct( } /** + *

Sets the Zone for which the shippng rates are valid.

+ * * @return null|ZoneResourceIdentifier */ public function getZone() @@ -62,7 +64,7 @@ public function getZone() } /** - *

The array must not contain two shipping rates with the same currency.

+ *

Shipping rates for the currencies configured in the Project. The array must not contain two ShippingRates with the same CurrencyCode.

* * @return null|ShippingRateDraftCollection */ diff --git a/lib/commercetools-api/src/Models/ShippingMethod/ZoneRateModel.php b/lib/commercetools-api/src/Models/ShippingMethod/ZoneRateModel.php index 3f7ab9a09f0..2619cb1d659 100644 --- a/lib/commercetools-api/src/Models/ShippingMethod/ZoneRateModel.php +++ b/lib/commercetools-api/src/Models/ShippingMethod/ZoneRateModel.php @@ -44,6 +44,8 @@ public function __construct( } /** + *

Zone for which the shipping rates are valid.

+ * * @return null|ZoneReference */ public function getZone() @@ -62,7 +64,7 @@ public function getZone() } /** - *

The array does not contain two shipping rates with the same currency.

+ *

Shipping rates defined per currency.

* * @return null|ShippingRateCollection */ diff --git a/lib/commercetools-history/src/Models/Common/ShippingRate.php b/lib/commercetools-history/src/Models/Common/ShippingRate.php index 88aecdd174b..47bf5653070 100644 --- a/lib/commercetools-history/src/Models/Common/ShippingRate.php +++ b/lib/commercetools-history/src/Models/Common/ShippingRate.php @@ -30,7 +30,7 @@ public function getPrice(); public function getFreeAbove(); /** - *

Only appears in response to requests for shipping methods by cart or location to mark this shipping rate as one that matches the cart or location.

+ *

Only appears in response to requests for ShippingMethods by Cart or location to mark this shipping rate as one that matches the Cart or location.

* * @return null|bool */ diff --git a/lib/commercetools-history/src/Models/Common/ShippingRateBuilder.php b/lib/commercetools-history/src/Models/Common/ShippingRateBuilder.php index 5a6639b01e8..0dd87138f2f 100644 --- a/lib/commercetools-history/src/Models/Common/ShippingRateBuilder.php +++ b/lib/commercetools-history/src/Models/Common/ShippingRateBuilder.php @@ -57,7 +57,7 @@ public function getFreeAbove() } /** - *

Only appears in response to requests for shipping methods by cart or location to mark this shipping rate as one that matches the cart or location.

+ *

Only appears in response to requests for ShippingMethods by Cart or location to mark this shipping rate as one that matches the Cart or location.

* * @return null|bool */ diff --git a/lib/commercetools-history/src/Models/Common/ShippingRateModel.php b/lib/commercetools-history/src/Models/Common/ShippingRateModel.php index aa5099fd0fb..b1d314d0796 100644 --- a/lib/commercetools-history/src/Models/Common/ShippingRateModel.php +++ b/lib/commercetools-history/src/Models/Common/ShippingRateModel.php @@ -95,7 +95,7 @@ public function getFreeAbove() } /** - *

Only appears in response to requests for shipping methods by cart or location to mark this shipping rate as one that matches the cart or location.

+ *

Only appears in response to requests for ShippingMethods by Cart or location to mark this shipping rate as one that matches the Cart or location.

* * @return null|bool */ From afe4173c90682483704d2673bde6212b1128b081 Mon Sep 17 00:00:00 2001 From: Auto Mation Date: Wed, 22 Jun 2022 09:36:53 +0000 Subject: [PATCH 2/2] TASK: Updating SDK --- lib/commercetools-api/docs/RequestBuilder.md | 30 ++++++++++---------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/lib/commercetools-api/docs/RequestBuilder.md b/lib/commercetools-api/docs/RequestBuilder.md index 00f366c0544..00140fb8b43 100644 --- a/lib/commercetools-api/docs/RequestBuilder.md +++ b/lib/commercetools-api/docs/RequestBuilder.md @@ -1216,10 +1216,10 @@ $request = $builder ``` ## `withProjectKey("projectKey")->inStoreKeyWithStoreKeyValue("storeKey")->carts()->post(null)` -Creates a cart in the store specified by {storeKey}. -When using this endpoint the cart's store field is always set to the store specified in the path parameter. -Creating a cart can fail with an InvalidOperation if the referenced shipping method -in the CartDraft has a predicate which does not match the cart. +Creates a [Cart](ctp:api:type:Cart) in the Store specified by `storeKey`. +When using this endpoint the Cart's `store` field is always set to the store specified in the path parameter. +Creating a Cart can fail with an [InvalidOperationError](ctp:api:type:InvalidOperationError) if the referenced [ShippingMethod](ctp:api:type:ShippingMethod) +in the [CartDraft](ctp:api:type:CartDraft) has a predicate which does not match the Cart. ### Example @@ -1256,9 +1256,9 @@ $request = $builder ``` ## `withProjectKey("projectKey")->inStoreKeyWithStoreKeyValue("storeKey")->carts()->withId("ID")->post(null)` -Updates a cart in the store specified by {storeKey}. -If the cart exists in the project but does not have the store field, -or the store field references a different store, this method returns a ResourceNotFound error. +Updates a [Cart](ctp:api:type:Cart) in the Store specified by `storeKey`. +If the Cart exists in the Project but does not have the store field, +or the `store` field references a different Store, this method returns a [ResourceNotFoundError](ctp:api:type:ResourceNotFoundError). ### Example @@ -1335,9 +1335,9 @@ $request = $builder ``` ## `withProjectKey("projectKey")->inStoreKeyWithStoreKeyValue("storeKey")->carts()->withKey("key")->post(null)` -Updates a cart in the store specified by {storeKey}. -If the cart exists in the project but does not have the store field, -or the store field references a different store, this method returns a ResourceNotFound error. +Updates a [Cart](ctp:api:type:Cart) in the Store specified by `storeKey`. +If the Cart exists in the Project but does not have the store field, +or the `store` field references a different Store, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFound) error. ### Example @@ -2217,9 +2217,9 @@ $request = $builder ``` ## `withProjectKey("projectKey")->inStoreKeyWithStoreKeyValue("storeKey")->productProjections()->get()` -You can use the product projections query endpoint to get the current or staged representations of Products. -When used with an API client that has the view_published_products:{projectKey} scope, -this endpoint only returns published (current) product projections. +Use this endpoint to get the current or staged projection of [Products](ctp:api:type:Product) in the Store specified by `storeKey`. +When used with an [API Client](ctp:api:type:ApiClient) that has the `view_published_products:{projectKey}` scope, +this endpoint only returns published (current) Product Projections. ### Example @@ -2235,7 +2235,7 @@ $request = $builder ``` ## `withProjectKey("projectKey")->inStoreKeyWithStoreKeyValue("storeKey")->productProjections()->withId("ID")->get()` -Gets the current or staged representation of a product by its ID from a specific Store. +Gets the current or staged representation of a [Product](ctp:api:type:Product) by its ID from the specified Store. ### Example ```php @@ -2251,7 +2251,7 @@ $request = $builder ``` ## `withProjectKey("projectKey")->inStoreKeyWithStoreKeyValue("storeKey")->productProjections()->withKey("key")->get()` -Gets the current or staged representation of a product by its ID from a specific Store. +Gets the current or staged representation of a [Product](ctp:api:type:Product) by its key from the specified Store. ### Example ```php