@commercetools/platform-sdk - npm Package Compare versions

Comparing version 7.14.0 to 7.15.0

dist/declarations/src/generated/client/customers/by-project-key-customers-request-builder.d.ts

@@ -62,6 +62,2 @@ /**
     search(): ByProjectKeyCustomersSearchRequestBuilder;
-    /**
-     *	This endpoint provides information on the status of a Customer search for a project
-     *
-     */
     searchIndexingStatus(): ByProjectKeyCustomersSearchIndexingStatusRequestBuilder;
@@ -68,0 +64,0 @@ get(methodArgs?: {

dist/declarations/src/generated/client/images/by-project-key-in-store-key-by-store-key-products-by-product-id-product-tailoring-images-request-builder.d.ts

@@ -1,2 +0,1 @@
-/// <reference types="node" />
 /**
@@ -32,4 +31,13 @@ * Code generated by [commercetools RMF-Codegen](https://github.com/commercetools/rmf-codegen). DO NOT EDIT.
     /**
-     *	Upload a JPEG, PNG and GIF file to a [ProductTailoringVariant](ctp:api:type:ProductTailoringVariant). The maximum file size of the image is 10MB. `variant` or `sku` is required to update a specific ProductVariant. Produces the [ProductTailoringImageAdded](/projects/messages/product-catalog-messages#product-tailoring-image-added) Message when the `Small` version of the image has been uploaded to the CDN.
+     *	Uploads a JPEG, PNG and GIF file to a [ProductVariantTailoring](ctp:api:type:ProductVariantTailoring).
+     *	The maximum file size of the image is **10MB**.
+     *	Either `variant` or `sku` is required to update a specific ProductVariant.
+     *	If neither is provided, the image is uploaded to the Master Variant of the Product.
      *
+     *	The response status code depends on the size of the original image.
+     *	If the image is small, the API responds with `200 OK`, and if the image is larger, it responds with `202 Accepted`.
+     *	The Product returned with a `202 Accepted` status code contains a `warnings` field with an [ImageProcessingOngoing](ctp:api:type:ImageProcessingOngoingWarning) Warning.
+     *
+     *	Produces the [ProductTailoringImageAdded](/projects/messages/product-catalog-messages#product-tailoring-image-added) Message.
+     *
      */
@@ -44,5 +52,5 @@ post(methodArgs: {
         };
-        body: Buffer;
-        headers: {
-            'Content-Type': 'image/jpeg' | 'image/png' | 'image/gif';
+        body: Buffer | Buffer | Buffer;
+        headers?: {
+            'Content-Type': string | string[];
             [key: string]: string | string[];
@@ -49,0 +57,0 @@ };

dist/declarations/src/generated/client/images/by-project-key-in-store-key-by-store-key-products-key-by-product-key-product-tailoring-images-request-builder.d.ts

@@ -1,2 +0,1 @@
-/// <reference types="node" />
 /**
@@ -32,4 +31,13 @@ * Code generated by [commercetools RMF-Codegen](https://github.com/commercetools/rmf-codegen). DO NOT EDIT.
     /**
-     *	Upload a JPEG, PNG and GIF file to a [ProductTailoringVariant](ctp:api:type:ProductTailoringVariant). The maximum file size of the image is 10MB. `variant` or `sku` is required to update a specific ProductVariant. Produces the [ProductTailoringImageAdded](/projects/messages/product-catalog-messages#product-tailoring-image-added) Message when the `Small` version of the image has been uploaded to the CDN.
+     *	Uploads a JPEG, PNG and GIF file to a [ProductVariantTailoring](ctp:api:type:ProductVariantTailoring).
+     *	The maximum file size of the image is **10MB**.
+     *	Either `variant` or `sku` is required to update a specific ProductVariant.
+     *	If neither is provided, the image is uploaded to the Master Variant of the Product.
      *
+     *	The response status code depends on the size of the original image.
+     *	If the image is small, the API responds with `200 OK`, and if the image is larger, it responds with `202 Accepted`.
+     *	The Product returned with a `202 Accepted` status code contains a `warnings` field with an [ImageProcessingOngoing](ctp:api:type:ImageProcessingOngoingWarning) Warning.
+     *
+     *	Produces the [ProductTailoringImageAdded](/projects/messages/product-catalog-messages#product-tailoring-image-added) Message.
+     *
      */
@@ -44,5 +52,5 @@ post(methodArgs: {
         };
-        body: Buffer;
-        headers: {
-            'Content-Type': 'image/jpeg' | 'image/png' | 'image/gif';
+        body: Buffer | Buffer | Buffer;
+        headers?: {
+            'Content-Type': string | string[];
             [key: string]: string | string[];
@@ -49,0 +57,0 @@ };

dist/declarations/src/generated/client/images/by-project-key-products-by-id-images-request-builder.d.ts

@@ -1,2 +0,1 @@
-/// <reference types="node" />
 /**
@@ -30,4 +29,13 @@ * Code generated by [commercetools RMF-Codegen](https://github.com/commercetools/rmf-codegen). DO NOT EDIT.
     /**
-     *	Upload a JPEG, PNG and GIF file to a [ProductVariant](ctp:api:type:ProductVariant). The maximum file size of the image is 10MB. `variant` or `sku` is required to update a specific ProductVariant. The image is uploaded to the Master Variant if `variant` or `sku` are not included. Produces the [ProductImageAdded](/projects/messages/product-catalog-messages#product-image-added) Message when the `Small` version of the image has been uploaded to the CDN.
+     *	Uploads a JPEG, PNG, or a GIF image file to a [ProductVariant](ctp:api:type:ProductVariant).
+     *	The maximum file size of the image is **10MB**.
+     *	Either `variant` or `sku` is required to update a specific ProductVariant.
+     *	If neither is provided, the image is uploaded to the Master Variant of the Product.
      *
+     *	The response status code depends on the size of the original image.
+     *	If the image is small, the API responds with `200 OK`, and if the image is larger, it responds with `202 Accepted`.
+     *	The Product returned with a `202 Accepted` status code contains a `warnings` field with an [ImageProcessingOngoing](ctp:api:type:ImageProcessingOngoingWarning) Warning.
+     *
+     *	Produces the [ProductImageAdded](/projects/messages/product-catalog-messages#product-image-added) Message.
+     *
      */
@@ -42,5 +50,5 @@ post(methodArgs: {
         };
-        body: Buffer;
-        headers: {
-            'Content-Type': 'image/jpeg' | 'image/png' | 'image/gif';
+        body: Buffer | Buffer | Buffer;
+        headers?: {
+            'Content-Type': string | string[];
             [key: string]: string | string[];
@@ -47,0 +55,0 @@ };

dist/declarations/src/generated/client/indexing-status/by-project-key-customers-search-indexing-status-request-builder.d.ts

@@ -26,2 +26,6 @@ /**
     });
+    /**
+     *	Returns the indexing status of the Customer Search for a Project.
+     *
+     */
     get(methodArgs?: {
@@ -28,0 +32,0 @@ headers?: {

dist/declarations/src/generated/client/search/by-project-key-customers-search-request-builder.d.ts

@@ -26,2 +26,6 @@ /**
     });
+    /**
+     *	A [SearchNotReady](ctp:api:type:SearchNotReadyError) error is returned if the indexing is in progress or the feature is deactivated. If deactivated, you can [reactivate](/../api/projects/customer-search#reactivate) it.
+     *
+     */
     post(methodArgs: {
@@ -34,4 +38,4 @@ body: CustomerSearchRequest;
     /**
-     *	Checks whether a search index for the Project's Customers exists.
-     *	Returns a `200 OK` status if the index exists or `404 Not Found` otherwise.
+     *	Checks whether a search index of Customers exists for a Project.
+     *	If an index exists, a `200 OK` is returned; otherwise, a `409 Conflict`.
      *
@@ -38,0 +42,0 @@ */

dist/declarations/src/generated/index.d.ts

@@ -313,2 +313,3 @@ /**
 export * from "./models/type.js";
+export * from "./models/warning.js";
 export * from "./models/zone.js";
@@ -315,0 +316,0 @@ export * from "./shared/utils/common-types.js";

dist/declarations/src/generated/models/extension.d.ts

@@ -194,3 +194,3 @@ /**
  */
-export type ExtensionResourceTypeId = 'business-unit' | 'cart' | 'customer' | 'order' | 'payment' | 'quote' | 'quote-request' | 'shopping-list' | 'staged-quote' | string;
+export type ExtensionResourceTypeId = 'business-unit' | 'cart' | 'customer' | 'customer-group' | 'order' | 'payment' | 'quote' | 'quote-request' | 'shopping-list' | 'staged-quote' | string;
 export interface ExtensionTrigger {
@@ -197,0 +197,0 @@ /**

dist/declarations/src/generated/models/product-tailoring.d.ts

@@ -10,2 +10,3 @@ /**
 import { FieldContainer, TypeResourceIdentifier } from "./type.js";
+import { WarningObject } from "./warning.js";
 /**
@@ -93,4 +94,39 @@ *	A single ProductTailoring representation contains the _current_ and the _staged_ representation of its product data tailored per Store.
     readonly hasStagedChanges: boolean;
+    /**
+     *	Warnings about processing of a request.
+     *	Appears in response to requests with response status code `202 Accepted`.
+     *
+     *
+     */
+    readonly warnings?: WarningObject[];
 }
 /**
+ *	The same rules for `name` and `value` apply as for [Attribute](ctp:api:type:Attribute) in Product Variants.
+ *
+ */
+export interface ProductTailoringAttribute {
+    /**
+     *	Name of the Attribute.
+     *
+     *
+     */
+    readonly name: string;
+    /**
+     *	The [AttributeType](ctp:api:type:AttributeType) determines the format of the Attribute `value` to be provided:
+     *
+     *	- For [Enum Type](ctp:api:type:AttributeEnumType) and [Localized Enum Type](ctp:api:type:AttributeLocalizedEnumType),
+     *	  use the `key` of the [Plain Enum Value](ctp:api:type:AttributePlainEnumValue) or [Localized Enum Value](ctp:api:type:AttributeLocalizedEnumValue) objects,
+     *	  or the complete objects as `value`.
+     *	- For [Localizable Text Type](ctp:api:type:AttributeLocalizableTextType), use the [LocalizedString](ctp:api:type:LocalizedString) object as `value`.
+     *	- For [Money Type](ctp:api:type:AttributeMoneyType) Attributes, use the [Money](ctp:api:type:Money) object as `value`.
+     *	- For [Set Type](ctp:api:type:AttributeSetType) Attributes, use the entire `set` object  as `value`.
+     *	- For [Reference Type](ctp:api:type:AttributeReferenceType) Attributes, use the [Reference](ctp:api:type:Reference) object as `value`.
+     *
+     *	Tailoring of [Nested Type](ctp:api:type:AttributeNestedType) Attributes is not supported.
+     *
+     *
+     */
+    readonly value: any;
+}
+/**
  *	Contains all the tailored data of a Product.
@@ -362,3 +398,3 @@ *
 }
-export type ProductTailoringUpdateAction = ProductTailoringAddAssetAction | ProductTailoringAddExternalImageAction | ProductTailoringAddVariantAction | ProductTailoringChangeAssetNameAction | ProductTailoringChangeAssetOrderAction | ProductTailoringMoveImageToPositionAction | ProductTailoringPublishAction | ProductTailoringRemoveAssetAction | ProductTailoringRemoveImageAction | ProductTailoringRemoveVariantAction | ProductTailoringSetAssetCustomFieldAction | ProductTailoringSetAssetCustomTypeAction | ProductTailoringSetAssetDescriptionAction | ProductTailoringSetAssetKeyAction | ProductTailoringSetAssetSourcesAction | ProductTailoringSetAssetTagsAction | ProductTailoringSetDescriptionAction | ProductTailoringSetExternalImagesAction | ProductTailoringSetImageLabelAction | ProductTailoringSetMetaAttributesAction | ProductTailoringSetMetaDescriptionAction | ProductTailoringSetMetaKeywordsAction | ProductTailoringSetMetaTitleAction | ProductTailoringSetNameAction | ProductTailoringSetSlugAction | ProductTailoringUnpublishAction;
+export type ProductTailoringUpdateAction = ProductTailoringAddAssetAction | ProductTailoringAddExternalImageAction | ProductTailoringAddVariantAction | ProductTailoringChangeAssetNameAction | ProductTailoringChangeAssetOrderAction | ProductTailoringMoveImageToPositionAction | ProductTailoringPublishAction | ProductTailoringRemoveAssetAction | ProductTailoringRemoveImageAction | ProductTailoringRemoveVariantAction | ProductTailoringSetAssetCustomFieldAction | ProductTailoringSetAssetCustomTypeAction | ProductTailoringSetAssetDescriptionAction | ProductTailoringSetAssetKeyAction | ProductTailoringSetAssetSourcesAction | ProductTailoringSetAssetTagsAction | ProductTailoringSetAttributeAction | ProductTailoringSetAttributeInAllVariantsAction | ProductTailoringSetDescriptionAction | ProductTailoringSetExternalImagesAction | ProductTailoringSetImageLabelAction | ProductTailoringSetMetaAttributesAction | ProductTailoringSetMetaDescriptionAction | ProductTailoringSetMetaKeywordsAction | ProductTailoringSetMetaTitleAction | ProductTailoringSetNameAction | ProductTailoringSetSlugAction | ProductTailoringUnpublishAction;
 /**
@@ -389,2 +425,12 @@ *	The tailoring of a [ProductVariant](ctp:api:type:ProductVariant).
     readonly assets?: Asset[];
+    /**
+     *	Attributes of the tailored Product Variant.
+     *	If present, these Attributes are selectively merged into the `attributes` of the corresponding [ProductVariant](ctp:api:type:ProductVariant):
+     *
+     *	- If the ProductVariant contains an Attribute with the same `name`, its `value` is overwritten,
+     *	- otherwise the Attribute and its value are added to the ProductVariant.
+     *
+     *
+     */
+    readonly attributes?: ProductTailoringAttribute[];
 }
@@ -420,2 +466,12 @@ /**
     readonly assets?: Asset[];
+    /**
+     *	Attributes of the tailored Product Variant according to the respective [AttributeDefinition](ctp:api:type:AttributeDefinition).
+     *	If provided, these Attributes are selectively merged into the `attributes` of the corresponding [ProductVariant](ctp:api:type:ProductVariant):
+     *
+     *	- If the ProductVariant contains an Attribute with the same `name`, its `value` is overwritten,
+     *	- otherwise the Attribute and its value are added to the ProductVariant.
+     *
+     *
+     */
+    readonly attributes?: ProductTailoringAttribute[];
 }
@@ -522,2 +578,8 @@ /**
     /**
+     *	Attributes for the Product Variant Tailoring.
+     *
+     *
+     */
+    readonly attributes?: ProductTailoringAttribute[];
+    /**
      *	If `true` the new Product Variant Tailoring is only staged. If `false` the new Product Variant Tailoring is both current and staged.
@@ -598,3 +660,3 @@ *
     /**
-     *	All existing Asset `id`s of the ProductTailoringVariant in the desired new order.
+     *	All existing Asset `id`s of the ProductVariantTailoring in the desired new order.
      *
@@ -1018,2 +1080,90 @@ *
 /**
+ *	Either `variantId` or `sku` is required.
+ *
+ */
+export interface ProductTailoringSetAttributeAction {
+    readonly action: 'setAttribute';
+    /**
+     *	The `id` of the ProductVariant to update.
+     *	Required if `sku` is absent.
+     *
+     *
+     */
+    readonly variantId?: number;
+    /**
+     *	The `sku` of the ProductVariant to update.
+     *	Required if `variantId` is absent.
+     *
+     *
+     */
+    readonly sku?: string;
+    /**
+     *	The name of the Attribute to set.
+     *
+     *
+     */
+    readonly name: string;
+    /**
+     *	Value to set for the Attribute. If empty, any existing value will be removed.
+     *
+     *	The [AttributeType](ctp:api:type:AttributeType) determines the format of the Attribute `value` to be provided:
+     *
+     *	- For [Enum Type](ctp:api:type:AttributeEnumType) and [Localized Enum Type](ctp:api:type:AttributeLocalizedEnumType),
+     *	  use the `key` of the [Plain Enum Value](ctp:api:type:AttributePlainEnumValue) or [Localized Enum Value](ctp:api:type:AttributeLocalizedEnumValue) objects,
+     *	  or the complete objects as `value`.
+     *	- For [Localizable Text Type](ctp:api:type:AttributeLocalizableTextType), use the [LocalizedString](ctp:api:type:LocalizedString) object as `value`.
+     *	- For [Money Type](ctp:api:type:AttributeMoneyType) Attributes, use the [Money](ctp:api:type:Money) object as `value`.
+     *	- For [Set Type](ctp:api:type:AttributeSetType) Attributes, use the entire `set` object  as `value`.
+     *	- For [Reference Type](ctp:api:type:AttributeReferenceType) Attributes, use the [Reference](ctp:api:type:Reference) object as `value`.
+     *
+     *	Tailoring of [Nested Type](ctp:api:type:AttributeNestedType) Attributes is **not supported**.
+     *
+     *
+     */
+    readonly value?: any;
+    /**
+     *	If `true`, only the staged Attribute is set. If `false`, both current and staged Attribute is set.
+     *
+     *
+     */
+    readonly staged?: boolean;
+}
+/**
+ *	Adds, removes, or changes a tailored Attribute in all Product Variants of a Product at the same time.
+ *	This action is useful for setting tailored values for Attributes with the [Constraint](ctp:api:type:AttributeConstraintEnum) `SameForAll`.
+ */
+export interface ProductTailoringSetAttributeInAllVariantsAction {
+    readonly action: 'setAttributeInAllVariants';
+    /**
+     *	The name of the Attribute to set.
+     *
+     *
+     */
+    readonly name: string;
+    /**
+     *	Value to set for the Attributes. If empty, any existing value will be removed.
+     *
+     *	The [AttributeType](ctp:api:type:AttributeType) determines the format of the Attribute `value` to be provided:
+     *
+     *	- For [Enum Type](ctp:api:type:AttributeEnumType) and [Localized Enum Type](ctp:api:type:AttributeLocalizedEnumType),
+     *	  use the `key` of the [Plain Enum Value](ctp:api:type:AttributePlainEnumValue) or [Localized Enum Value](ctp:api:type:AttributeLocalizedEnumValue) objects,
+     *	  or the complete objects as `value`.
+     *	- For [Localizable Text Type](ctp:api:type:AttributeLocalizableTextType), use the [LocalizedString](ctp:api:type:LocalizedString) object as `value`.
+     *	- For [Money Type](ctp:api:type:AttributeMoneyType) Attributes, use the [Money](ctp:api:type:Money) object as `value`.
+     *	- For [Set Type](ctp:api:type:AttributeSetType) Attributes, use the entire `set` object  as `value`.
+     *	- For [Reference Type](ctp:api:type:AttributeReferenceType) Attributes, use the [Reference](ctp:api:type:Reference) object as `value`.
+     *
+     *	Tailoring of [Nested Type](ctp:api:type:AttributeNestedType) Attributes is **not supported**.
+     *
+     *
+     */
+    readonly value?: any;
+    /**
+     *	If `true`, only the staged Attributes are set. If `false`, both the current and staged Attributes are set.
+     *
+     *
+     */
+    readonly staged?: boolean;
+}
+/**
  *	Generates the [ProductTailoringDescriptionSet](ctp:api:type:ProductTailoringDescriptionSetMessage) Message.
@@ -1020,0 +1170,0 @@ *

dist/declarations/src/generated/models/project.d.ts

@@ -79,6 +79,2 @@ /**
 export type ProductSearchIndexingMode = 'ProductProjectionsSearch' | 'ProductsSearch' | string;
-/**
- *	Specifies the status of the [Product Search](/../api/projects/product-search) index.
- */
-export type ProductSearchStatus = 'Activated' | 'Deactivated' | string;
 export interface Project {
@@ -212,2 +208,7 @@ /**
     readonly orders?: SearchIndexingConfigurationValues;
+    /**
+     *	Configuration for the [Customer Search](/../api/projects/customer-search) feature.
+     *
+     */
+    readonly customers?: SearchIndexingConfigurationValues;
 }
@@ -214,0 +215,0 @@ /**

dist/declarations/src/generated/models/subscription.d.ts

@@ -309,3 +309,3 @@ /**
 /**
- *	For supported resources and message types, see [Message Types](/../api/projects/messages#message-types). Messages will be delivered even if the Messages Query HTTP API [is not enabled](/../api/projects/messages#enable-querying-messages-via-the-api).
+ *	Messages will be delivered even if the Messages Query HTTP API [is not enabled](/../api/projects/messages#enable-querying-messages-via-the-api).
  *
@@ -334,3 +334,3 @@ *	For MessageSubscriptions, the format of the payload is [MessageDeliveryPayload](ctp:api:type:MessageDeliveryPayload).
  */
-export type MessageSubscriptionResourceTypeId = 'approval-flow' | 'approval-rule' | 'associate-role' | 'business-unit' | 'category' | 'customer' | 'customer-email-token' | 'customer-group' | 'customer-password-token' | 'inventory-entry' | 'order' | 'payment' | 'product' | 'product-selection' | 'quote' | 'quote-request' | 'review' | 'staged-quote' | 'standalone-price' | 'store' | string;
+export type MessageSubscriptionResourceTypeId = 'approval-flow' | 'approval-rule' | 'associate-role' | 'business-unit' | 'category' | 'customer' | 'customer-email-token' | 'customer-group' | 'customer-password-token' | 'inventory-entry' | 'order' | 'payment' | 'product' | 'product-selection' | 'product-tailoring' | 'quote' | 'quote-request' | 'review' | 'staged-quote' | 'standalone-price' | 'store' | string;
 export interface PayloadNotIncluded {
@@ -337,0 +337,0 @@ /**

dist/declarations/src/generated/models/type.d.ts

@@ -235,3 +235,3 @@ /**
  */
-export type ResourceTypeId = 'address' | 'approval-flow' | 'asset' | 'associate-role' | 'business-unit' | 'cart-discount' | 'category' | 'channel' | 'custom-line-item' | 'customer' | 'customer-group' | 'discount-code' | 'inventory-entry' | 'line-item' | 'order' | 'order-delivery' | 'order-edit' | 'order-parcel' | 'order-return-item' | 'payment' | 'payment-interface-interaction' | 'product-price' | 'product-selection' | 'quote' | 'review' | 'shipping' | 'shipping-method' | 'shopping-list' | 'shopping-list-text-line-item' | 'standalone-price' | 'store' | 'transaction' | string;
+export type ResourceTypeId = 'address' | 'approval-flow' | 'asset' | 'associate-role' | 'business-unit' | 'cart-discount' | 'category' | 'channel' | 'custom-line-item' | 'customer' | 'customer-group' | 'discount-code' | 'inventory-entry' | 'line-item' | 'order' | 'order-delivery' | 'order-edit' | 'order-parcel' | 'order-return-item' | 'payment' | 'payment-interface-interaction' | 'product-price' | 'product-selection' | 'product-tailoring' | 'quote' | 'review' | 'shipping' | 'shipping-method' | 'shopping-list' | 'shopping-list-text-line-item' | 'standalone-price' | 'store' | 'transaction' | string;
 export interface Type extends BaseResource {
@@ -238,0 +238,0 @@ /**

package.json

@@ -7,3 +7,3 @@ {
   "name": "@commercetools/platform-sdk",
-  "version": "7.14.0",
+  "version": "7.15.0",
   "engines": {
@@ -37,3 +37,3 @@ "node": ">=14"
   "devDependencies": {
-    "@types/uuid": "9.0.8",
+    "@types/uuid": "10.0.0",
     "organize-imports-cli": "0.10.0",
@@ -40,0 +40,0 @@ "tsconfig-replace-paths": "0.0.14",

No alert changes

Improved metrics

Total package byte prevSize

7251901

increased by0.52%

Number of package files

643

increased by0.31%

Lines of code

164479

increased by0.21%

No dependency changes