@commercetools/importapi-sdk 4.7.0 → 5.1.0

package/CHANGELOG.md

@@ -1,5 +1,53 @@
 # @commercetools/importapi-sdk
 
+## 5.1.0
+
+### Minor Changes
+
+- [#553](https://github.com/commercetools/commercetools-sdk-typescript/pull/553) [`8e0a312`](https://github.com/commercetools/commercetools-sdk-typescript/commit/8e0a312404020c2f14cb15786a262c78476b5152) Thanks [@github-actions](https://github.com/apps/github-actions)! - **Api changes**
+
+  <details>
+  <summary>Added QueryParameter(s)</summary>
+
+  - added query parameter `expand` to method `get /{projectKey}/in-store/key={storeKey}/cart-discounts`
+  - added query parameter `sort` to method `get /{projectKey}/in-store/key={storeKey}/cart-discounts`
+  - added query parameter `limit` to method `get /{projectKey}/in-store/key={storeKey}/cart-discounts`
+  - added query parameter `offset` to method `get /{projectKey}/in-store/key={storeKey}/cart-discounts`
+  - added query parameter `withTotal` to method `get /{projectKey}/in-store/key={storeKey}/cart-discounts`
+  - added query parameter `where` to method `get /{projectKey}/in-store/key={storeKey}/cart-discounts`
+  - added query parameter `/^var[.][a-zA-Z0-9]+$/` to method `get /{projectKey}/in-store/key={storeKey}/cart-discounts`
+  - added query parameter `expand` to method `post /{projectKey}/in-store/key={storeKey}/cart-discounts`
+  </details>
+
+  <details>
+  <summary>Changed MethodResponseBody(s)</summary>
+
+  - :warning: changed response body for `200: application/json` of method `get /{projectKey}/in-store/key={storeKey}/cart-discounts` from type `CartDiscount` to `CartDiscountPagedQueryResponse`
+  </details>
+
+## 5.0.0
+
+### Major Changes
+
+- [#551](https://github.com/commercetools/commercetools-sdk-typescript/pull/551) [`9e7939a`](https://github.com/commercetools/commercetools-sdk-typescript/commit/9e7939a1df234fd1f4f77c60f4ff75b31d7fc3fd) Thanks [@github-actions](https://github.com/apps/github-actions)! - BREAKING CHANGE:
+
+  - fix URI parameters to be URI encoded
+
+### Minor Changes
+
+- [#527](https://github.com/commercetools/commercetools-sdk-typescript/pull/527) [`00c6176`](https://github.com/commercetools/commercetools-sdk-typescript/commit/00c617692543f9a8d0ac64e81d583f89e002e81b) Thanks [@github-actions](https://github.com/apps/github-actions)! - **Import changes**
+
+  <details>
+  <summary>Added Property(s)</summary>
+
+  - added property `product` to type `ProductVariantPatch`
+  </details>
+
+### Patch Changes
+
+- Updated dependencies [[`a6d0df2`](https://github.com/commercetools/commercetools-sdk-typescript/commit/a6d0df2034b72504db2aa2d13a8d3726d97cc881)]:
+  - @commercetools/sdk-client-v2@2.2.2
+
 ## 4.7.0
 
 ### Minor Changes

package/dist/commercetools-importapi-sdk.browser.cjs.js

@@ -86,7 +86,8 @@ function buildRelativeUri(commonRequest) {
   const pathMap = commonRequest.pathVariables;
   var uri = commonRequest.uriTemplate;
   for (const param in pathMap) {
-    uri = uri.replace(`{${param}}`, `${pathMap[param]}`);
+    const value = encodeURIComponent(`${pathMap[param]}`);
+    uri = uri.replace(`{${param}}`, `${value}`);
   }
   const resQuery = formatQueryString(commonRequest.queryParams || {});
   return `${uri}${resQuery}`;

package/dist/commercetools-importapi-sdk.browser.esm.js

@@ -82,7 +82,8 @@ function buildRelativeUri(commonRequest) {
   const pathMap = commonRequest.pathVariables;
   var uri = commonRequest.uriTemplate;
   for (const param in pathMap) {
-    uri = uri.replace(`{${param}}`, `${pathMap[param]}`);
+    const value = encodeURIComponent(`${pathMap[param]}`);
+    uri = uri.replace(`{${param}}`, `${value}`);
   }
   const resQuery = formatQueryString(commonRequest.queryParams || {});
   return `${uri}${resQuery}`;

package/dist/commercetools-importapi-sdk.cjs.dev.js

@@ -86,7 +86,8 @@ function buildRelativeUri(commonRequest) {
   const pathMap = commonRequest.pathVariables;
   var uri = commonRequest.uriTemplate;
   for (const param in pathMap) {
-    uri = uri.replace(`{${param}}`, `${pathMap[param]}`);
+    const value = encodeURIComponent(`${pathMap[param]}`);
+    uri = uri.replace(`{${param}}`, `${value}`);
   }
   const resQuery = formatQueryString(commonRequest.queryParams || {});
   return `${uri}${resQuery}`;

package/dist/commercetools-importapi-sdk.cjs.prod.js

@@ -86,7 +86,8 @@ function buildRelativeUri(commonRequest) {
   const pathMap = commonRequest.pathVariables;
   var uri = commonRequest.uriTemplate;
   for (const param in pathMap) {
-    uri = uri.replace(`{${param}}`, `${pathMap[param]}`);
+    const value = encodeURIComponent(`${pathMap[param]}`);
+    uri = uri.replace(`{${param}}`, `${value}`);
   }
   const resQuery = formatQueryString(commonRequest.queryParams || {});
   return `${uri}${resQuery}`;

package/dist/commercetools-importapi-sdk.esm.js

@@ -82,7 +82,8 @@ function buildRelativeUri(commonRequest) {
   const pathMap = commonRequest.pathVariables;
   var uri = commonRequest.uriTemplate;
   for (const param in pathMap) {
-    uri = uri.replace(`{${param}}`, `${pathMap[param]}`);
+    const value = encodeURIComponent(`${pathMap[param]}`);
+    uri = uri.replace(`{${param}}`, `${value}`);
   }
   const resQuery = formatQueryString(commonRequest.queryParams || {});
   return `${uri}${resQuery}`;

package/dist/declarations/src/generated/models/categories.d.ts

@@ -10,6 +10,11 @@ import { Custom } from "./customfields.js";
  *
  */
 export interface CategoryImport extends ImportResource {
+    /**
+     *	User-defined unique identifier. If a [Category](/../api/projects/categories#category) with this `key` exists, it will be updated with the imported data.
+     *
+     */
+    readonly key: string;
     /**
      *	Maps to `Category.name`.
      *

package/dist/declarations/src/generated/models/customers.d.ts

@@ -123,6 +123,11 @@ export interface CustomerAddress {
  *
  */
 export interface CustomerImport extends ImportResource {
+    /**
+     *	User-defined unique identifier. If a [Customer](/../api/projects/customers#customer) with this `key` exists, it will be updated with the imported data.
+     *
+     */
+    readonly key: string;
     /**
      *	Maps to `Customer.customerNumber`.
      *

package/dist/declarations/src/generated/models/customfields.d.ts

@@ -5,7 +5,7 @@
  */
 import { KeyReference, LocalizedString, Money, TypedMoney, TypeKeyReference } from "./common.js";
 /**
- *	The representation to be sent to the server when creating a resource with custom fields.
+ *	The representation to be sent to the server when creating a resource with Custom Fields.
  */
 export interface Custom {
     /**
@@ -14,19 +14,19 @@ export interface Custom {
      */
     readonly type: TypeKeyReference;
     /**
-     *	The custom fields of this object.
+     *	The Custom Fields of this object.
      *
      */
     readonly fields?: FieldContainer;
 }
 /**
- *	Maps the custom field names to the actual values.
+ *	Maps the Custom Field names to actual values.
  */
 export interface FieldContainer {
     [key: string]: CustomField;
 }
 /**
- *	Provides the value for a custom field of a specific type.
+ *	Provides the value for a Custom Field of a specific type.
  */
 export type CustomField = BooleanField | BooleanSetField | DateField | DateSetField | DateTimeField | DateTimeSetField | EnumField | EnumSetField | LocalizedEnumField | LocalizedEnumSetField | LocalizedStringField | LocalizedStringSetField | MoneyField | MoneySetField | NumberField | NumberSetField | ReferenceField | ReferenceSetField | StringField | StringSetField | TimeField | TimeSetField;
 /**

package/dist/declarations/src/generated/models/inventories.d.ts

@@ -10,6 +10,11 @@ import { Custom } from "./customfields.js";
  *
  */
 export interface InventoryImport extends ImportResource {
+    /**
+     *	User-defined unique identifier. If an [InventoryEntry](/../api/projects/inventory#inventoryentry) with this `key` exists, it will be updated with the imported data.
+     *
+     */
+    readonly key: string;
     /**
      *	Maps to `Inventory.sku`
      *

package/dist/declarations/src/generated/models/orders.d.ts

@@ -318,7 +318,7 @@ export interface Parcel {
      */
     readonly items?: DeliveryItem[];
     /**
-     *	The representation to be sent to the server when creating a resource with custom fields.
+     *	The representation to be sent to the server when creating a resource with Custom Fields.
      *
      */
     readonly custom?: Custom;

package/dist/declarations/src/generated/models/prices.d.ts

@@ -53,7 +53,7 @@ export interface TaxRate {
  */
 export interface PriceImport extends ImportResource {
     /**
-     *	User-defined unique identifier for the Embedded Price.
+     *	User-defined unique identifier for the Embedded Price. If a [Price](/../api/types#price) with this `key` exists on the specified `productVariant`, it will be updated with the imported data.
      *
      *
      */

package/dist/declarations/src/generated/models/productdrafts.d.ts

@@ -12,6 +12,11 @@ import { Attribute } from "./productvariants.js";
  *
  */
 export interface ProductDraftImport extends ImportResource {
+    /**
+     *	User-defined unique identifier. If a [Product](/../api/projects/products#product) with this `key` exists, it will be updated with the imported data.
+     *
+     */
+    readonly key: string;
     /**
      *	The `productType` of a [Product](/../api/projects/products#product).
      *	Maps to `Product.productType`.

package/dist/declarations/src/generated/models/products.d.ts

@@ -61,6 +61,11 @@ export interface WhitespaceTokenizer {
  *
  */
 export interface ProductImport extends ImportResource {
+    /**
+     *	User-defined unique identifier. If a [Product](/../api/projects/products#product) with this `key` exists, it will be updated with the imported data.
+     *
+     */
+    readonly key: string;
     /**
      *	Maps to `Product.name`.
      *

package/dist/declarations/src/generated/models/producttypes.d.ts

@@ -152,6 +152,11 @@ export type TextInputHint = 'MultiLine' | 'SingleLine' | string;
  *
  */
 export interface ProductTypeImport extends ImportResource {
+    /**
+     *	User-defined unique identifier. If a [ProductType](/../api/projects/productTypes#producttype) with this `key` exists, it will be updated with the imported data.
+     *
+     */
+    readonly key: string;
     /**
      *	Maps to `ProductType.name`.
      *

package/dist/declarations/src/generated/models/productvariants.d.ts

@@ -446,6 +446,11 @@ export interface TimeSetAttribute {
  *
  */
 export interface ProductVariantImport extends ImportResource {
+    /**
+     *	User-defined unique identifier. If a [ProductVariant](/../api/projects/products#productvariant) with this `key` exists on the specified `product`, it will be updated with the imported data.
+     *
+     */
+    readonly key: string;
     /**
      *	Maps to `ProductVariant.sku`.
      *
@@ -501,9 +506,8 @@ export interface ProductVariantImport extends ImportResource {
  */
 export interface ProductVariantPatch {
     /**
-     *	The [ProductVariant](/../api/projects/products#productvariant) to which this patch is applied.
-     *	The Reference to the [ProductVariant](/../api/projects/products#productvariant) with which the ProductVariantPatch is associated.
-     *	If referenced ProductVariant does not exist, the `state` of the [ImportOperation](/import-operation#importoperation) will be set to `unresolved` until the necessary ProductVariant is created.
+     *	Reference to the [ProductVariant](/../api/projects/products#productvariant) to update.
+     *	If the referenced ProductVariant does not exist, the `state` of the [ImportOperation](/import-operation#importoperation) will be set to `unresolved` until the necessary ProductVariant is created.
      *
      *
      */
@@ -524,6 +528,12 @@ export interface ProductVariantPatch {
      *
      */
     readonly staged?: boolean;
+    /**
+     *	Reference to the [Product](/../api/projects/products#product) which contains the ProductVariant. Setting a value will batch process the import operations to minimize concurrency errors. If set, this field is required for every ProductVariantPatch in the [ProductVariantPatchRequest](ctp:import:type:ProductVariantPatchRequest).
+     *
+     *
+     */
+    readonly product?: ProductKeyReference;
 }
 export interface Attributes {
     [key: string]: Attribute | null;

package/dist/declarations/src/generated/models/standalone-prices.d.ts

@@ -11,7 +11,7 @@ import { Custom } from "./customfields.js";
  */
 export interface StandalonePriceImport extends ImportResource {
     /**
-     *	User-defined unique identifier for the Standalone Price.
+     *	User-defined unique identifier for the Standalone Price. If a [StandalonePrice](/../api/projects/standalone-prices#standaloneprice) with this `key` exists, it will be updated with the imported data.
      *
      *
      */

package/dist/declarations/src/generated/models/types.d.ts

@@ -180,7 +180,7 @@ export interface FieldDefinition {
  */
 export interface TypeImport extends ImportResource {
     /**
-     *	User-defined unique identifier for the Type.
+     *	User-defined unique identifier for the Type. If a [Type](/../api/projects/types#type) with this `key` exists, it will be updated with the imported data.
      *
      *
      */

package/package.json

@@ -4,7 +4,7 @@
     "access": "public"
   },
   "name": "@commercetools/importapi-sdk",
-  "version": "4.7.0",
+  "version": "5.1.0",
   "engines": {
     "node": ">=14"
   },
@@ -32,7 +32,7 @@
     "./dist/commercetools-importapi-sdk.esm.js": "./dist/commercetools-importapi-sdk.browser.esm.js"
   },
   "dependencies": {
-    "@commercetools/sdk-client-v2": "^2.1.6",
+    "@commercetools/sdk-client-v2": "^2.2.2",
     "@commercetools/sdk-middleware-auth": "^7.0.0",
     "@commercetools/sdk-middleware-http": "^7.0.0",
     "@commercetools/sdk-middleware-logger": "^3.0.0"