@commercetools/importapi-sdk 5.0.0 → 5.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,30 @@
1
1
  # @commercetools/importapi-sdk
2
2
 
3
+ ## 5.1.0
4
+
5
+ ### Minor Changes
6
+
7
+ - [#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**
8
+
9
+ <details>
10
+ <summary>Added QueryParameter(s)</summary>
11
+
12
+ - added query parameter `expand` to method `get /{projectKey}/in-store/key={storeKey}/cart-discounts`
13
+ - added query parameter `sort` to method `get /{projectKey}/in-store/key={storeKey}/cart-discounts`
14
+ - added query parameter `limit` to method `get /{projectKey}/in-store/key={storeKey}/cart-discounts`
15
+ - added query parameter `offset` to method `get /{projectKey}/in-store/key={storeKey}/cart-discounts`
16
+ - added query parameter `withTotal` to method `get /{projectKey}/in-store/key={storeKey}/cart-discounts`
17
+ - added query parameter `where` to method `get /{projectKey}/in-store/key={storeKey}/cart-discounts`
18
+ - added query parameter `/^var[.][a-zA-Z0-9]+$/` to method `get /{projectKey}/in-store/key={storeKey}/cart-discounts`
19
+ - added query parameter `expand` to method `post /{projectKey}/in-store/key={storeKey}/cart-discounts`
20
+ </details>
21
+
22
+ <details>
23
+ <summary>Changed MethodResponseBody(s)</summary>
24
+
25
+ - :warning: changed response body for `200: application/json` of method `get /{projectKey}/in-store/key={storeKey}/cart-discounts` from type `CartDiscount` to `CartDiscountPagedQueryResponse`
26
+ </details>
27
+
3
28
  ## 5.0.0
4
29
 
5
30
  ### Major Changes
@@ -10,6 +10,11 @@ import { Custom } from "./customfields.js";
10
10
  *
11
11
  */
12
12
  export interface CategoryImport extends ImportResource {
13
+ /**
14
+ * User-defined unique identifier. If a [Category](/../api/projects/categories#category) with this `key` exists, it will be updated with the imported data.
15
+ *
16
+ */
17
+ readonly key: string;
13
18
  /**
14
19
  * Maps to `Category.name`.
15
20
  *
@@ -123,6 +123,11 @@ export interface CustomerAddress {
123
123
  *
124
124
  */
125
125
  export interface CustomerImport extends ImportResource {
126
+ /**
127
+ * User-defined unique identifier. If a [Customer](/../api/projects/customers#customer) with this `key` exists, it will be updated with the imported data.
128
+ *
129
+ */
130
+ readonly key: string;
126
131
  /**
127
132
  * Maps to `Customer.customerNumber`.
128
133
  *
@@ -10,6 +10,11 @@ import { Custom } from "./customfields.js";
10
10
  *
11
11
  */
12
12
  export interface InventoryImport extends ImportResource {
13
+ /**
14
+ * User-defined unique identifier. If an [InventoryEntry](/../api/projects/inventory#inventoryentry) with this `key` exists, it will be updated with the imported data.
15
+ *
16
+ */
17
+ readonly key: string;
13
18
  /**
14
19
  * Maps to `Inventory.sku`
15
20
  *
@@ -53,7 +53,7 @@ export interface TaxRate {
53
53
  */
54
54
  export interface PriceImport extends ImportResource {
55
55
  /**
56
- * User-defined unique identifier for the Embedded Price.
56
+ * 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.
57
57
  *
58
58
  *
59
59
  */
@@ -12,6 +12,11 @@ import { Attribute } from "./productvariants.js";
12
12
  *
13
13
  */
14
14
  export interface ProductDraftImport extends ImportResource {
15
+ /**
16
+ * User-defined unique identifier. If a [Product](/../api/projects/products#product) with this `key` exists, it will be updated with the imported data.
17
+ *
18
+ */
19
+ readonly key: string;
15
20
  /**
16
21
  * The `productType` of a [Product](/../api/projects/products#product).
17
22
  * Maps to `Product.productType`.
@@ -61,6 +61,11 @@ export interface WhitespaceTokenizer {
61
61
  *
62
62
  */
63
63
  export interface ProductImport extends ImportResource {
64
+ /**
65
+ * User-defined unique identifier. If a [Product](/../api/projects/products#product) with this `key` exists, it will be updated with the imported data.
66
+ *
67
+ */
68
+ readonly key: string;
64
69
  /**
65
70
  * Maps to `Product.name`.
66
71
  *
@@ -152,6 +152,11 @@ export type TextInputHint = 'MultiLine' | 'SingleLine' | string;
152
152
  *
153
153
  */
154
154
  export interface ProductTypeImport extends ImportResource {
155
+ /**
156
+ * User-defined unique identifier. If a [ProductType](/../api/projects/productTypes#producttype) with this `key` exists, it will be updated with the imported data.
157
+ *
158
+ */
159
+ readonly key: string;
155
160
  /**
156
161
  * Maps to `ProductType.name`.
157
162
  *
@@ -446,6 +446,11 @@ export interface TimeSetAttribute {
446
446
  *
447
447
  */
448
448
  export interface ProductVariantImport extends ImportResource {
449
+ /**
450
+ * 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.
451
+ *
452
+ */
453
+ readonly key: string;
449
454
  /**
450
455
  * Maps to `ProductVariant.sku`.
451
456
  *
@@ -11,7 +11,7 @@ import { Custom } from "./customfields.js";
11
11
  */
12
12
  export interface StandalonePriceImport extends ImportResource {
13
13
  /**
14
- * User-defined unique identifier for the Standalone Price.
14
+ * 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.
15
15
  *
16
16
  *
17
17
  */
@@ -180,7 +180,7 @@ export interface FieldDefinition {
180
180
  */
181
181
  export interface TypeImport extends ImportResource {
182
182
  /**
183
- * User-defined unique identifier for the Type.
183
+ * 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.
184
184
  *
185
185
  *
186
186
  */
package/package.json CHANGED
@@ -4,7 +4,7 @@
4
4
  "access": "public"
5
5
  },
6
6
  "name": "@commercetools/importapi-sdk",
7
- "version": "5.0.0",
7
+ "version": "5.1.0",
8
8
  "engines": {
9
9
  "node": ">=14"
10
10
  },