New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More →
@commercetools/platform-sdk
Advanced tools
@commercetools/platform-sdk - npm Package Compare versions
Comparing version 4.6.0 to 4.7.0
136
CHANGELOG.md
| # @commercetools/platform-sdk | ||
| ## 4.7.0 | ||
| ### Minor Changes | ||
| - [`dad68dc`](https://github.com/commercetools/commercetools-sdk-typescript/commit/dad68dcabc0d8995b1c628b6cf431c14e9504888) Thanks [@jenschude](https://github.com/jenschude)! - **Api changes** | ||
| <details> | ||
| <summary>MarkDeprecated Type(s)</summary> | ||
| - marked type `ProductVariantSelectionExclusion` as deprecated | ||
| - marked type `ProductVariantSelectionInclusion` as deprecated | ||
| </details> | ||
| <details> | ||
| <summary>Added Type(s)</summary> | ||
| - added type `GraphQLAnonymousIdAlreadyInUseError` | ||
| - added type `GraphQLAttributeDefinitionAlreadyExistsError` | ||
| - added type `GraphQLAttributeDefinitionTypeConflictError` | ||
| - added type `GraphQLAttributeNameDoesNotExistError` | ||
| - added type `GraphQLBadGatewayError` | ||
| - added type `GraphQLConcurrentModificationError` | ||
| - added type `GraphQLCountryNotConfiguredInStoreError` | ||
| - added type `GraphQLDiscountCodeNonApplicableError` | ||
| - added type `GraphQLDuplicateAttributeValueError` | ||
| - added type `GraphQLDuplicateAttributeValuesError` | ||
| - added type `GraphQLDuplicateEnumValuesError` | ||
| - added type `GraphQLDuplicateFieldError` | ||
| - added type `GraphQLDuplicateFieldWithConflictingResourceError` | ||
| - added type `GraphQLDuplicatePriceKeyError` | ||
| - added type `GraphQLDuplicatePriceScopeError` | ||
| - added type `GraphQLDuplicateStandalonePriceScopeError` | ||
| - added type `GraphQLDuplicateVariantValuesError` | ||
| - added type `GraphQLEditPreviewFailedError` | ||
| - added type `GraphQLEnumKeyAlreadyExistsError` | ||
| - added type `GraphQLEnumKeyDoesNotExistError` | ||
| - added type `GraphQLEnumValueIsUsedError` | ||
| - added type `GraphQLEnumValuesMustMatchError` | ||
| - added type `GraphQLErrorObject` | ||
| - added type `GraphQLExtensionBadResponseError` | ||
| - added type `GraphQLExtensionNoResponseError` | ||
| - added type `GraphQLExtensionPredicateEvaluationFailedError` | ||
| - added type `GraphQLExtensionUpdateActionsFailedError` | ||
| - added type `GraphQLExternalOAuthFailedError` | ||
| - added type `GraphQLFeatureRemovedError` | ||
| - added type `GraphQLGeneralError` | ||
| - added type `GraphQLInsufficientScopeError` | ||
| - added type `GraphQLInternalConstraintViolatedError` | ||
| - added type `GraphQLInvalidCredentialsError` | ||
| - added type `GraphQLInvalidCurrentPasswordError` | ||
| - added type `GraphQLInvalidFieldError` | ||
| - added type `GraphQLInvalidInputError` | ||
| - added type `GraphQLInvalidItemShippingDetailsError` | ||
| - added type `GraphQLInvalidJsonInputError` | ||
| - added type `GraphQLInvalidOperationError` | ||
| - added type `GraphQLInvalidSubjectError` | ||
| - added type `GraphQLInvalidTokenError` | ||
| - added type `GraphQLLanguageUsedInStoresError` | ||
| - added type `GraphQLMatchingPriceNotFoundError` | ||
| - added type `GraphQLMaxResourceLimitExceededError` | ||
| - added type `GraphQLMissingRoleOnChannelError` | ||
| - added type `GraphQLMissingTaxRateForCountryError` | ||
| - added type `GraphQLNoMatchingProductDiscountFoundError` | ||
| - added type `GraphQLNotEnabledError` | ||
| - added type `GraphQLObjectNotFoundError` | ||
| - added type `GraphQLOutOfStockError` | ||
| - added type `GraphQLOverCapacityError` | ||
| - added type `GraphQLOverlappingStandalonePriceValidityError` | ||
| - added type `GraphQLPendingOperationError` | ||
| - added type `GraphQLPriceChangedError` | ||
| - added type `GraphQLProductAssignmentMissingError` | ||
| - added type `GraphQLProductPresentWithDifferentVariantSelectionError` | ||
| - added type `GraphQLProjectNotConfiguredForLanguagesError` | ||
| - added type `GraphQLQueryComplexityLimitExceededError` | ||
| - added type `GraphQLQueryTimedOutError` | ||
| - added type `GraphQLReferenceExistsError` | ||
| - added type `GraphQLReferencedResourceNotFoundError` | ||
| - added type `GraphQLRequiredFieldError` | ||
| - added type `GraphQLResourceNotFoundError` | ||
| - added type `GraphQLResourceSizeLimitExceededError` | ||
| - added type `GraphQLSearchDeactivatedError` | ||
| - added type `GraphQLSearchExecutionFailureError` | ||
| - added type `GraphQLSearchFacetPathNotFoundError` | ||
| - added type `GraphQLSearchIndexingInProgressError` | ||
| - added type `GraphQLSemanticErrorError` | ||
| - added type `GraphQLShippingMethodDoesNotMatchCartError` | ||
| - added type `GraphQLSyntaxErrorError` | ||
| - added type `ProductSelectionProductExcludedMessage` | ||
| - added type `ProductSelectionVariantExclusionChangedMessage` | ||
| - added type `ProductSelectionProductExcludedMessagePayload` | ||
| - added type `ProductSelectionVariantExclusionChangedMessagePayload` | ||
| - added type `IndividualExclusionProductSelectionType` | ||
| - added type `ProductVariantExclusion` | ||
| - added type `ProductVariantSelectionIncludeAllExcept` | ||
| - added type `ProductVariantSelectionIncludeOnly` | ||
| - added type `ProductSelectionExcludeProductAction` | ||
| - added type `ProductSelectionSetVariantExclusionAction` | ||
| </details> | ||
| <details> | ||
| <summary>Added Enum(s)</summary> | ||
| - added enum `individualExclusion` to type `ProductSelectionTypeEnum` | ||
| - added enum `includeOnly` to type `ProductVariantSelectionTypeEnum` | ||
| - added enum `includeAllExcept` to type `ProductVariantSelectionTypeEnum` | ||
| </details> | ||
| <details> | ||
| <summary>Changed Property(s)</summary> | ||
| - :warning: changed property `productSelection` of type `ProductSelectionCreatedMessage` from type `IndividualProductSelectionType` to `ProductSelectionType` | ||
| - :warning: changed property `productSelection` of type `ProductSelectionCreatedMessagePayload` from type `IndividualProductSelectionType` to `ProductSelectionType` | ||
| </details> | ||
| <details> | ||
| <summary>Added Property(s)</summary> | ||
| - added property `extensions` to type `GraphQLError` | ||
| - added property `variantExclusion` to type `AssignedProductReference` | ||
| - added property `variantExclusion` to type `AssignedProductSelection` | ||
| - added property `variantExclusion` to type `ProductSelectionAssignment` | ||
| - added property `type` to type `ProductSelectionDraft` | ||
| </details> | ||
| <details> | ||
| <summary>Required Property(s)</summary> | ||
| - changed property `roles` of type `AssociateDraft` to be optional | ||
| - changed property `path` of type `GraphQLError` to be optional | ||
| </details> | ||
| ### Patch Changes | ||
| - Updated dependencies [[`057e260`](https://github.com/commercetools/commercetools-sdk-typescript/commit/057e260b3330b7ab8df33171bb2d4aa2de0444d9)]: | ||
| - @commercetools/sdk-client-v2@2.1.5 | ||
| ## 4.6.0 | ||
@@ -4,0 +140,0 @@ |
@@ -30,3 +30,3 @@ /** | ||
| */ | ||
| readonly roles: AssociateRole[]; | ||
| readonly roles?: AssociateRole[]; | ||
| /** | ||
@@ -232,8 +232,9 @@ * The [Customer](ctp:api:type:Customer) to be part of the Business Unit. | ||
| /** | ||
| * References to [Stores](ctp:api:type:Store) the Business Unit is associated with. | ||
| * If empty, the Business Unit can only create [Carts](ctp:api:type:Cart), [Orders](ctp:api:type:Order), or [Quotes](/../api/quotes-overview) that have no `store` value. | ||
| * If not empty, the Business Unit can only be linked to [Carts](ctp:api:type:Cart) and [Orders](ctp:api:type:Order) of a referenced Store. | ||
| * Only present when `storeMode` is `Explicit`. | ||
| * References to [Stores](ctp:api:type:Store) the Business Unit is associated with. Only present when `storeMode` is `Explicit`. | ||
| * | ||
| * If the Business Unit has Stores defined, then all of its [Carts](ctp:api:type:Cart), [Orders](ctp:api:type:Order), [Quotes](ctp:api:type:Quote), or [Quote Requests](ctp:api:type:QuoteRequest) must belong to one of the Business Unit's Stores. | ||
| * | ||
| * If the Business Unit has no Stores, then all of its [Carts](ctp:api:type:Cart), [Orders](ctp:api:type:Order), [Quotes](ctp:api:type:Quote), or [Quote Requests](ctp:api:type:QuoteRequest) must not belong to any Store. | ||
| * | ||
| * | ||
| */ | ||
@@ -334,12 +335,14 @@ readonly stores?: StoreKeyReference[]; | ||
| * Sets the [Stores](ctp:api:type:Store) the Business Unit is associated with. Can only be set when `storeMode` is `Explicit`. | ||
| * If not empty, the Business Unit can only be linked to [Carts](ctp:api:type:Cart) and [Orders](ctp:api:type:Order) of a referenced Store. | ||
| * If empty, the Business Unit can only create [Carts](ctp:api:type:Cart), [Orders](ctp:api:type:Order), or [Quotes](/../api/quotes-overview) that have no `store` value. | ||
| * Defaults to empty for [Companies](ctp:api:type:BusinessUnitType) and not set for [Divisions](ctp:api:type:BusinessUnitType). | ||
| * | ||
| * If the Business Unit has Stores defined, then all of its [Carts](ctp:api:type:Cart), [Orders](ctp:api:type:Order), [Quotes](ctp:api:type:Quote), or [Quote Requests](ctp:api:type:QuoteRequest) must belong to one of the Business Unit's Stores. | ||
| * | ||
| * If the Business Unit has no Stores, then all of its [Carts](ctp:api:type:Cart), [Orders](ctp:api:type:Order), [Quotes](ctp:api:type:Quote), or [Quote Requests](ctp:api:type:QuoteRequest) must not belong to any Store. | ||
| * | ||
| * | ||
| */ | ||
| readonly stores?: StoreResourceIdentifier[]; | ||
| /** | ||
| * Defines whether the Stores of the Business Unit are set on the Business Unit or are inherited from a parent. | ||
| * Defaults to `Explicit` for [Companies](ctp:api:type:BusinessUnitType) and to `FromParent` for [Divisions](ctp:api:type:BusinessUnitType). | ||
| * Defines whether the Stores of the Business Unit are set directly on the Business Unit or are inherited from a parent. | ||
| * `storeMode` is always `Explicit` for [Companies](ctp:api:type:BusinessUnitType) and defaults to `FromParent` for [Divisions](ctp:api:type:BusinessUnitType). | ||
| * | ||
@@ -462,8 +465,9 @@ * | ||
| /** | ||
| * References to [Stores](ctp:api:type:Store) the Business Unit is associated with. | ||
| * If empty, the Business Unit can only create [Carts](ctp:api:type:Cart), [Orders](ctp:api:type:Order), or [Quotes](/../api/quotes-overview) that have no `store` value. | ||
| * If not empty, the Business Unit can only be linked to [Carts](ctp:api:type:Cart) and [Orders](ctp:api:type:Order) of a referenced Store. | ||
| * Only present when `storeMode` is `Explicit`. | ||
| * References to [Stores](ctp:api:type:Store) the Business Unit is associated with. Only present when `storeMode` is `Explicit`. | ||
| * | ||
| * If the Business Unit has Stores defined, then all of its [Carts](ctp:api:type:Cart), [Orders](ctp:api:type:Order), [Quotes](ctp:api:type:Quote), or [Quote Requests](ctp:api:type:QuoteRequest) must belong to one of the Business Unit's Stores. | ||
| * | ||
| * If the Business Unit has no Stores, then all of its [Carts](ctp:api:type:Cart), [Orders](ctp:api:type:Order), [Quotes](ctp:api:type:Quote), or [Quote Requests](ctp:api:type:QuoteRequest) must not belong to any Store. | ||
| * | ||
| * | ||
| */ | ||
@@ -565,7 +569,9 @@ readonly stores?: StoreKeyReference[]; | ||
| * Sets the [Stores](ctp:api:type:Store) the Business Unit is associated with. Can only be set when `storeMode` is `Explicit`. | ||
| * If not empty, the Business Unit can only be linked to [Carts](ctp:api:type:Cart) and [Orders](ctp:api:type:Order) of a referenced Store. | ||
| * If empty, the Business Unit can only create [Carts](ctp:api:type:Cart), [Orders](ctp:api:type:Order), or [Quotes](/../api/quotes-overview) that have no `store` value. | ||
| * Defaults to empty for [Companies](ctp:api:type:BusinessUnitType) and not set for [Divisions](ctp:api:type:BusinessUnitType). | ||
| * | ||
| * If the Business Unit has Stores defined, then all of its [Carts](ctp:api:type:Cart), [Orders](ctp:api:type:Order), [Quotes](ctp:api:type:Quote), or [Quote Requests](ctp:api:type:QuoteRequest) must belong to one of the Business Unit's Stores. | ||
| * | ||
| * If the Business Unit has no Stores, then all of its [Carts](ctp:api:type:Cart), [Orders](ctp:api:type:Order), [Quotes](ctp:api:type:Quote), or [Quote Requests](ctp:api:type:QuoteRequest) must not belong to any Store. | ||
| * | ||
| * | ||
| */ | ||
@@ -572,0 +578,0 @@ readonly stores?: StoreResourceIdentifier[]; |
@@ -156,3 +156,3 @@ /** | ||
| * Effect of the CartDiscount. | ||
| * For a target, relative or absolute discount values, or a fixed item price value can be specified. If no target is specified, a gift line item can be added to the cart. | ||
| * For a [target](ctp:api:type:CartDiscountTarget), relative or absolute Discount values or a fixed item Price value can be specified. If no target is specified, a [Gift Line Item](/../api/projects/cartDiscounts#gift-line-item) can be added to the Cart. | ||
| * | ||
@@ -159,0 +159,0 @@ * |
@@ -422,3 +422,3 @@ /** | ||
| } | ||
| export type _BaseResource = BaseResource | CustomObject | CustomerGroup | Customer | DiscountCode | Extension | InventoryEntry | Message | OrderEdit | Order | Payment | ProductDiscount | ProductSelection | ProductType | Product | ProductProjection | QuoteRequest | Quote | Review | ShippingMethod | ShoppingList | StagedQuote | StandalonePrice | State | Store | Subscription | TaxCategory | Type | Zone | Cart | AttributeGroup | Channel | Category | BusinessUnit | CartDiscount; | ||
| export type _BaseResource = BaseResource | CustomObject | CustomerGroup | Customer | DiscountCode | Extension | InventoryEntry | Message | OrderEdit | Order | Payment | ProductDiscount | ProductSelection | ProductType | Product | ProductProjection | QuoteRequest | Quote | Review | ShippingMethod | ShoppingList | StagedQuote | StandalonePrice | State | Store | Subscription | TaxCategory | Type | Zone | Cart | Channel | AttributeGroup | BusinessUnit | CartDiscount | Category; | ||
| /** | ||
@@ -675,3 +675,3 @@ * These objects represent information about which [API Client](/../api/projects/api-clients) created or modified a resource. For more information, see [Client Logging](/client-logging). | ||
| /** | ||
| * Date and time until this Price is valid. | ||
| * Date and time until this Price is valid. Prices that are no longer valid are not automatically removed, but they can be [removed](ctp:api:type:ProductRemovePriceAction) if necessary. | ||
| * | ||
@@ -743,3 +743,3 @@ * | ||
| /** | ||
| * Set this field if this Price is only valid until the specified date and time. Must be at least 1 ms later than `validFrom`. | ||
| * Set this field if this Price is only valid until the specified date and time. Must be at least 1 ms later than `validFrom`. Prices that are no longer valid are not automatically removed, but they can be [removed](ctp:api:type:ProductRemovePriceAction) if necessary. | ||
| * | ||
@@ -746,0 +746,0 @@ * |
@@ -6,2 +6,3 @@ /** | ||
| */ | ||
| import { GraphQLErrorObject } from './error'; | ||
| export interface GraphQLError { | ||
@@ -19,3 +20,8 @@ /** | ||
| */ | ||
| readonly path: any[]; | ||
| readonly path?: any[]; | ||
| /** | ||
| * Represents a single error. | ||
| * | ||
| */ | ||
| readonly extensions: GraphQLErrorObject; | ||
| } | ||
@@ -22,0 +28,0 @@ export interface GraphQLErrorLocation { |
@@ -346,3 +346,3 @@ /** | ||
| /** | ||
| * [Reference](ctp:api:type:Reference) to a [State](ctp:api:type:State). | ||
| * [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [State](ctp:api:type:State). | ||
| * | ||
@@ -724,3 +724,3 @@ * | ||
| /** | ||
| * [Reference](ctp:api:type:Reference) to a [State](ctp:api:type:State). | ||
| * [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [State](ctp:api:type:State). | ||
| * | ||
@@ -727,0 +727,0 @@ * |
@@ -16,3 +16,5 @@ /** | ||
| /** | ||
| * The Variants of the Product that are included, or excluded, from the Product Selection. | ||
| * The Variants of the Product that are included from the Product Selection. | ||
| * | ||
| * This field may exist only for the [IndividualProductSelectionType](ctp:api:type:IndividualProductSelectionType). | ||
| * In absence of this field, all Variants are deemed to be included. | ||
@@ -23,2 +25,11 @@ * | ||
| readonly variantSelection?: ProductVariantSelection; | ||
| /** | ||
| * The Variants of the Product that are excluded from the Product Selection. | ||
| * | ||
| * This field may exist only for the [IndividualExclusionProductSelectionType](ctp:api:type:IndividualExclusionProductSelectionType). | ||
| * In absence of this field, all Variants are deemed to be excluded. | ||
| * | ||
| * | ||
| */ | ||
| readonly variantExclusion?: ProductVariantExclusion; | ||
| } | ||
@@ -32,7 +43,18 @@ export interface AssignedProductSelection { | ||
| /** | ||
| * Selects which Variants of the newly added Product will be included, or excluded, from the Product Selection. | ||
| * Defines which Variants of the Product will be included from the Product Selection. | ||
| * | ||
| * This field is only available for Assignments to a Product Selection of type [Individual](ctp:api:type:IndividualProductSelectionType). | ||
| * | ||
| * | ||
| */ | ||
| readonly variantSelection?: ProductVariantSelection; | ||
| /** | ||
| * Defines which Variants of the Product will be excluded from the Product Selection. | ||
| * | ||
| * This field is only available for Assignments to a Product Selection of type [Individual Exclusion](ctp:api:type:IndividualExclusionProductSelectionType). | ||
| * | ||
| * | ||
| */ | ||
| readonly variantExclusion?: ProductVariantExclusion; | ||
| /** | ||
| * Date and time (UTC) this assignment was initially created. | ||
@@ -131,3 +153,4 @@ * | ||
| /** | ||
| * Specifies in which way the Products are assigned to the ProductSelection. Currently, the only way of doing this is to specify each Product individually. Hence, the type is fixed to `individual` for now, but we have plans to add other types in the future. | ||
| * Specifies in which way the Products are assigned to the ProductSelection. | ||
| * Currently, the only way of doing this is to specify each Product individually, either by [including](ctp:api:type:IndividualProductSelectionType) or [excluding](ctp:api:type:IndividualExclusionProductSelectionType) them explicitly. | ||
| * | ||
@@ -137,3 +160,3 @@ */ | ||
| /** | ||
| * Custom Fields of this ProductSelection. | ||
| * Custom Fields of the ProductSelection. | ||
| * | ||
@@ -143,2 +166,9 @@ */ | ||
| } | ||
| /** | ||
| * | ||
| * Given the type of Product Selection this Assignment refers to, it may contain: | ||
| * | ||
| * - `variantSelection` field if the Product Selection is of type [Individual](ctp:api:type:IndividualProductSelectionType). | ||
| * - `variantExclusion` field if the Product Selection is of type [Individual Exclusion](ctp:api:type:IndividualExclusionProductSelectionType). | ||
| */ | ||
| export interface ProductSelectionAssignment { | ||
@@ -156,3 +186,5 @@ /** | ||
| /** | ||
| * Selects which Variants of the newly added Product will be included, or excluded, from the Product Selection. | ||
| * Define which Variants of the added Product will be included from the Product Selection. | ||
| * | ||
| * This field is only available for Assignments to a Product Selection of type [Individual](ctp:api:type:IndividualProductSelectionType). | ||
| * The list of SKUs will be updated automatically on any change of those performed on the respective Product itself. | ||
@@ -163,2 +195,11 @@ * | ||
| readonly variantSelection?: ProductVariantSelection; | ||
| /** | ||
| * Defines which Variants of the Product will be excluded from the Product Selection. | ||
| * | ||
| * This field is only available for Assignments to a Product Selection of type [Individual Exclusion](ctp:api:type:IndividualExclusionProductSelectionType). | ||
| * The list of SKUs will be updated automatically on any change of those performed on the respective Product itself. | ||
| * | ||
| * | ||
| */ | ||
| readonly variantExclusion?: ProductVariantExclusion; | ||
| } | ||
@@ -181,2 +222,7 @@ export interface ProductSelectionDraft { | ||
| readonly custom?: CustomFieldsDraft; | ||
| /** | ||
| * Type of the Product Selection. | ||
| * | ||
| */ | ||
| readonly type?: ProductSelectionTypeEnum; | ||
| } | ||
@@ -300,3 +346,11 @@ /** | ||
| } | ||
| export type ProductSelectionType = IndividualProductSelectionType; | ||
| export type ProductSelectionType = IndividualExclusionProductSelectionType | IndividualProductSelectionType; | ||
| export interface IndividualExclusionProductSelectionType { | ||
| readonly type: 'individualExclusion'; | ||
| /** | ||
| * The name of the ProductSelection which is recommended to be unique. | ||
| * | ||
| */ | ||
| readonly name: LocalizedString; | ||
| } | ||
| export interface IndividualProductSelectionType { | ||
@@ -311,6 +365,6 @@ readonly type: 'individual'; | ||
| /** | ||
| * The following type of Product Selections is supported: | ||
| * The following types of Product Selections are supported: | ||
| * | ||
| */ | ||
| export type ProductSelectionTypeEnum = 'individual' | string; | ||
| export type ProductSelectionTypeEnum = 'individual' | 'individualExclusion' | string; | ||
| export interface ProductSelectionUpdate { | ||
@@ -326,8 +380,20 @@ /** | ||
| } | ||
| export type ProductSelectionUpdateAction = ProductSelectionAddProductAction | ProductSelectionChangeNameAction | ProductSelectionRemoveProductAction | ProductSelectionSetCustomFieldAction | ProductSelectionSetCustomTypeAction | ProductSelectionSetKeyAction | ProductSelectionSetVariantSelectionAction; | ||
| export type ProductSelectionUpdateAction = ProductSelectionAddProductAction | ProductSelectionChangeNameAction | ProductSelectionExcludeProductAction | ProductSelectionRemoveProductAction | ProductSelectionSetCustomFieldAction | ProductSelectionSetCustomTypeAction | ProductSelectionSetKeyAction | ProductSelectionSetVariantExclusionAction | ProductSelectionSetVariantSelectionAction; | ||
| /** | ||
| * Only Product Variants with the explicitly listed SKUs are part of the Product Selection of type [Individual Exclusion](ctp:api:type:IndividualExclusionProductSelectionType). | ||
| * | ||
| */ | ||
| export interface ProductVariantExclusion { | ||
| /** | ||
| * Non-empty array of SKUs representing Product Variants to be included in the Product Selection of type [Individual Exclusion](ctp:api:type:IndividualExclusionProductSelectionType). | ||
| * | ||
| * | ||
| */ | ||
| readonly skus: string[]; | ||
| } | ||
| /** | ||
| * Polymorphic base type for Product Variant Selections. The actual type is determined by the `type` field. | ||
| * | ||
| */ | ||
| export type ProductVariantSelection = ProductVariantSelectionExclusion | ProductVariantSelectionInclusion; | ||
| export type ProductVariantSelection = ProductVariantSelectionExclusion | ProductVariantSelectionIncludeAllExcept | ProductVariantSelectionIncludeOnly | ProductVariantSelectionInclusion; | ||
| /** | ||
@@ -347,5 +413,31 @@ * All Product Variants except the explicitly stated SKUs are part of the Product Selection. | ||
| /** | ||
| * All Product Variants except the explicitly stated SKUs are part of the Product Selection. | ||
| * | ||
| */ | ||
| export interface ProductVariantSelectionIncludeAllExcept { | ||
| readonly type: 'includeAllExcept'; | ||
| /** | ||
| * Non-empty array of SKUs representing Product Variants to be excluded from the Product Selection. | ||
| * | ||
| * | ||
| */ | ||
| readonly skus: string[]; | ||
| } | ||
| /** | ||
| * Only Product Variants with explicitly stated SKUs are part of the Product Selection. | ||
| * | ||
| */ | ||
| export interface ProductVariantSelectionIncludeOnly { | ||
| readonly type: 'includeOnly'; | ||
| /** | ||
| * Non-empty array of SKUs representing Product Variants to be included into the Product Selection. | ||
| * | ||
| * | ||
| */ | ||
| readonly skus: string[]; | ||
| } | ||
| /** | ||
| * Only Product Variants with explicitly stated SKUs are part of the Product Selection. | ||
| * | ||
| */ | ||
| export interface ProductVariantSelectionInclusion { | ||
@@ -360,3 +452,3 @@ readonly type: 'inclusion'; | ||
| } | ||
| export type ProductVariantSelectionTypeEnum = 'exclusion' | 'inclusion' | string; | ||
| export type ProductVariantSelectionTypeEnum = 'exclusion' | 'includeAllExcept' | 'includeOnly' | 'inclusion' | string; | ||
| /** | ||
@@ -415,3 +507,3 @@ * [PagedQueryResult](/general-concepts#pagedqueryresult) containing an array of [ProductSelectionAssignment](ctp:api:type:ProductSelectionAssignment). | ||
| /** | ||
| * Selects which Variants of the newly added Product will be included, or excluded, from the Product Selection. | ||
| * Defines which Variants of the Product will be included from the Product Selection. | ||
| * If not supplied all Variants are deemed to be included. | ||
@@ -431,2 +523,23 @@ * | ||
| } | ||
| /** | ||
| * Excludes a Product from the Product Selection of type [Individual Exclusion](ctp:api:type:IndividualExclusionProductSelectionType). | ||
| * | ||
| * If the specified Product is already assigned to the Product Selection, but the existing Product Selection has a different Product Variant Exclusion, a [ProductPresentWithDifferentVariantSelection](ctp:api:type:ProductPresentWithDifferentVariantSelectionError) error is returned. | ||
| * | ||
| */ | ||
| export interface ProductSelectionExcludeProductAction { | ||
| readonly action: 'excludeProduct'; | ||
| /** | ||
| * ResourceIdentifier of the Product | ||
| * | ||
| */ | ||
| readonly product: ProductResourceIdentifier; | ||
| /** | ||
| * Defines which Variants of the Product will be excluded from the Product Selection. | ||
| * If not supplied all Variants are deemed to be excluded. | ||
| * | ||
| * | ||
| */ | ||
| readonly variantExclusion?: ProductVariantExclusion; | ||
| } | ||
| export interface ProductSelectionRemoveProductAction { | ||
@@ -482,4 +595,26 @@ readonly action: 'removeProduct'; | ||
| /** | ||
| * Updates the Product Variant Exclusion of an existing [Product Selection Assignment](ctp:api:type:ProductSelectionAssignment). | ||
| * A [ProductVariantExclusion](ctp:api:type:ProductVariantExclusion) can only be set if the [Product](/projects/products) has already been excluded from the [Product Selection of type Individual Exclusion](/projects/product-selections). | ||
| * | ||
| * If the specified Product is not assigned to the Product Selection, a [ProductAssignmentMissing](ctp:api:type:ProductAssignmentMissingError) error is returned. | ||
| * | ||
| */ | ||
| export interface ProductSelectionSetVariantExclusionAction { | ||
| readonly action: 'setVariantExclusion'; | ||
| /** | ||
| * ResourceIdentifier of the Product | ||
| * | ||
| */ | ||
| readonly product: ProductResourceIdentifier; | ||
| /** | ||
| * Determines which Variants of the previously excluded Product are to be included in the Product Selection of type Individual Exclusion. | ||
| * Leave it empty to unset an existing Variant Exclusion. | ||
| * | ||
| * | ||
| */ | ||
| readonly variantExclusion?: ProductVariantExclusion; | ||
| } | ||
| /** | ||
| * Updates the Product Variant Selection of an existing [Product Selection Assignment](ctp:api:type:ProductSelectionAssignment). | ||
| * A [ProductVariantSelection](ctp:api:type:ProductVariantSelection) can only be set if a [Product](/projects/products) has been added to the [Product Selection](/projects/product-selections). | ||
| * A [ProductVariantSelection](ctp:api:type:ProductVariantSelection) can only be set if the [Product](ctp:api:type:Product) has already been included to the [Product Selection of type Individual](ctp:api:type:IndividualProductSelectionType). | ||
| * | ||
@@ -486,0 +621,0 @@ * If the specified Product is not assigned to the Product Selection, a [ProductAssignmentMissing](ctp:api:type:ProductAssignmentMissingError) error is returned. |
@@ -106,3 +106,3 @@ /** | ||
| /** | ||
| * Date until the Price is valid. | ||
| * Date until the Price is valid. Standalone Prices that are no longer valid are not automatically deleted, but they can be [deleted](/../api/projects/standalone-prices#delete-standaloneprice) if necessary. | ||
| * | ||
@@ -193,3 +193,3 @@ * | ||
| /** | ||
| * Sets the date until the Price is valid. Must be at least 1 ms later than `validFrom`. | ||
| * Sets the date until the Price is valid. Must be at least 1 ms later than `validFrom`. Standalone Prices that are no longer valid are not automatically deleted, but they can be [deleted](/../api/projects/standalone-prices#delete-standaloneprice) if necessary. | ||
| * | ||
@@ -196,0 +196,0 @@ * |
@@ -110,6 +110,8 @@ /** | ||
| /** | ||
| * Controls availability of Products for this Store via active Product Selections. | ||
| * Controls availability of Products for this Store via Product Selections: | ||
| * | ||
| * - If empty all Products in the [Project](ctp:api:type:Project) are available in this Store. | ||
| * - If provided, Products from `active` Product Selections are available in this Store. | ||
| * - Leave empty if all Products in the [Project](ctp:api:type:Project) should be available in this Store. | ||
| * - If only `inactive` Product Selections of type [Individual Exclusion](ctp:api:type:IndividualExclusionProductSelectionType) are provided, all the Products are availlable in this Store. | ||
| * - If all the Product Selections provided are `inactive` and there's at least a Product Selection of type `individual`, no Product is availlable in this Store. | ||
| * - If at least an `active` Product Selection is provided, only `active` Product Selections are considered to compute the availlability in this Store. | ||
| * | ||
@@ -164,6 +166,8 @@ */ | ||
| /** | ||
| * Controls availability of Products for this Store via active Product Selections. | ||
| * Controls availability of Products for this Store via active/inactive Product Selections: | ||
| * | ||
| * - Leave empty if all Products in the [Project](ctp:api:type:Project) should be available in this Store. | ||
| * - If provided, Products from `active` Product Selections are available in this Store. | ||
| * - If only `inactive` Product Selections of type [Individual Exclusion](ctp:api:type:IndividualExclusionProductSelectionType) are provided, all the Products are availlable in this Store. | ||
| * - If all the Product Selections provided are `inactive` and there's at least a Product Selection of type `individual`, no Product is availlable in this Store. | ||
| * - If at least an `active` Product Selection is provided, only `active` Product Selections are considered to compute the availlability in this Store. | ||
| * | ||
@@ -170,0 +174,0 @@ * |
@@ -106,5 +106,3 @@ /** | ||
| /** | ||
| * Supported versions: "1.0". | ||
| * | ||
| * | ||
| */ | ||
@@ -111,0 +109,0 @@ readonly cloudEventsVersion: string; |
@@ -117,6 +117,6 @@ /** | ||
| /** | ||
| * Must be either `SingleLine` or `MultiLine`. | ||
| * Defines the visual representation of the field in user interfaces like the Merchant Center. | ||
| * It is only relevant for string-based [FieldTypes](ctp:api:type:FieldType) like [CustomFieldStringType](ctp:api:type:CustomFieldStringType) and [CustomFieldLocalizedStringType](ctp:api:type:CustomFieldLocalizedStringType). | ||
| * | ||
| * | ||
| */ | ||
@@ -123,0 +123,0 @@ readonly inputHint?: TypeTextInputHint; |
@@ -7,3 +7,3 @@ { | ||
| "name": "@commercetools/platform-sdk", | ||
| "version": "4.6.0", | ||
| "version": "4.7.0", | ||
| "engines": { | ||
@@ -30,3 +30,3 @@ "node": ">=14" | ||
| "dependencies": { | ||
| "@commercetools/sdk-client-v2": "^2.1.4", | ||
| "@commercetools/sdk-client-v2": "^2.1.5", | ||
| "@commercetools/sdk-middleware-auth": "^7.0.0", | ||
@@ -38,5 +38,5 @@ "@commercetools/sdk-middleware-http": "^7.0.0", | ||
| "devDependencies": { | ||
| "@types/uuid": "9.0.0", | ||
| "@types/uuid": "9.0.1", | ||
| "organize-imports-cli": "0.10.0", | ||
| "tsconfig-replace-paths": "0.0.11", | ||
| "tsconfig-replace-paths": "0.0.14", | ||
| "uuid": "9.0.0" | ||
@@ -43,0 +43,0 @@ }, |
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
No alert changes
Improved metrics
- Total package byte prevSize
- increased by1.6%
4174102
- Lines of code
- increased by1.45%
111432