@commercetools/importapi-sdk 6.3.0 → 6.5.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.
Files changed (77) hide show
  1. package/CHANGELOG.md +82 -0
  2. package/dist/commercetools-importapi-sdk.browser.cjs.js +256 -62
  3. package/dist/commercetools-importapi-sdk.browser.esm.js +250 -63
  4. package/dist/commercetools-importapi-sdk.cjs.dev.js +256 -62
  5. package/dist/commercetools-importapi-sdk.cjs.prod.js +256 -62
  6. package/dist/commercetools-importapi-sdk.esm.js +250 -63
  7. package/dist/declarations/src/generated/client/by-project-key-request-builder.d.ts +2 -0
  8. package/dist/declarations/src/generated/client/by-project-key-request-builder.d.ts.map +1 -1
  9. package/dist/declarations/src/generated/client/import-containers/by-project-key-categories-import-containers-by-import-container-key-request-builder.d.ts +1 -1
  10. package/dist/declarations/src/generated/client/import-containers/by-project-key-customers-import-containers-by-import-container-key-request-builder.d.ts +1 -1
  11. package/dist/declarations/src/generated/client/import-containers/by-project-key-discount-codes-import-containers-by-import-container-key-request-builder.d.ts +1 -1
  12. package/dist/declarations/src/generated/client/import-containers/by-project-key-import-containers-by-import-container-key-request-builder.d.ts +3 -3
  13. package/dist/declarations/src/generated/client/import-containers/by-project-key-import-containers-request-builder.d.ts +2 -2
  14. package/dist/declarations/src/generated/client/import-containers/by-project-key-inventories-import-containers-by-import-container-key-request-builder.d.ts +1 -1
  15. package/dist/declarations/src/generated/client/import-containers/by-project-key-order-patches-import-containers-by-import-container-key-request-builder.d.ts +1 -1
  16. package/dist/declarations/src/generated/client/import-containers/by-project-key-orders-import-containers-by-import-container-key-request-builder.d.ts +1 -1
  17. package/dist/declarations/src/generated/client/import-containers/by-project-key-prices-import-containers-by-import-container-key-request-builder.d.ts +1 -1
  18. package/dist/declarations/src/generated/client/import-containers/by-project-key-product-drafts-import-containers-by-import-container-key-request-builder.d.ts +1 -1
  19. package/dist/declarations/src/generated/client/import-containers/by-project-key-product-selections-import-containers-by-import-container-key-request-builder.d.ts +38 -0
  20. package/dist/declarations/src/generated/client/import-containers/by-project-key-product-selections-import-containers-by-import-container-key-request-builder.d.ts.map +1 -0
  21. package/dist/declarations/src/generated/client/import-containers/by-project-key-product-selections-import-containers-request-builder.d.ts +29 -0
  22. package/dist/declarations/src/generated/client/import-containers/by-project-key-product-selections-import-containers-request-builder.d.ts.map +1 -0
  23. package/dist/declarations/src/generated/client/import-containers/by-project-key-product-types-import-containers-by-import-container-key-request-builder.d.ts +1 -1
  24. package/dist/declarations/src/generated/client/import-containers/by-project-key-product-variant-patches-import-containers-by-import-container-key-request-builder.d.ts +1 -1
  25. package/dist/declarations/src/generated/client/import-containers/by-project-key-product-variants-import-containers-by-import-container-key-request-builder.d.ts +1 -1
  26. package/dist/declarations/src/generated/client/import-containers/by-project-key-products-import-containers-by-import-container-key-request-builder.d.ts +1 -1
  27. package/dist/declarations/src/generated/client/import-containers/by-project-key-standalone-prices-import-containers-by-import-container-key-request-builder.d.ts +1 -1
  28. package/dist/declarations/src/generated/client/import-containers/by-project-key-types-import-containers-by-import-container-key-request-builder.d.ts +1 -1
  29. package/dist/declarations/src/generated/client/import-operations/by-project-key-import-containers-by-import-container-key-import-operations-request-builder.d.ts +1 -1
  30. package/dist/declarations/src/generated/client/import-operations/by-project-key-import-operations-by-id-request-builder.d.ts +1 -1
  31. package/dist/declarations/src/generated/client/import-summaries/by-project-key-import-containers-by-import-container-key-import-summaries-request-builder.d.ts +1 -1
  32. package/dist/declarations/src/generated/client/product-selections/by-project-key-product-selections-request-builder.d.ts +27 -0
  33. package/dist/declarations/src/generated/client/product-selections/by-project-key-product-selections-request-builder.d.ts.map +1 -0
  34. package/dist/declarations/src/generated/index.d.ts +4 -0
  35. package/dist/declarations/src/generated/index.d.ts.map +1 -1
  36. package/dist/declarations/src/generated/models/categories.d.ts +5 -8
  37. package/dist/declarations/src/generated/models/categories.d.ts.map +1 -1
  38. package/dist/declarations/src/generated/models/common.d.ts +160 -59
  39. package/dist/declarations/src/generated/models/common.d.ts.map +1 -1
  40. package/dist/declarations/src/generated/models/customers.d.ts +12 -13
  41. package/dist/declarations/src/generated/models/customers.d.ts.map +1 -1
  42. package/dist/declarations/src/generated/models/customfields.d.ts +149 -91
  43. package/dist/declarations/src/generated/models/customfields.d.ts.map +1 -1
  44. package/dist/declarations/src/generated/models/discount-codes.d.ts +12 -14
  45. package/dist/declarations/src/generated/models/discount-codes.d.ts.map +1 -1
  46. package/dist/declarations/src/generated/models/errors.d.ts +6 -0
  47. package/dist/declarations/src/generated/models/errors.d.ts.map +1 -1
  48. package/dist/declarations/src/generated/models/importcontainers.d.ts +68 -23
  49. package/dist/declarations/src/generated/models/importcontainers.d.ts.map +1 -1
  50. package/dist/declarations/src/generated/models/importoperations.d.ts +19 -17
  51. package/dist/declarations/src/generated/models/importoperations.d.ts.map +1 -1
  52. package/dist/declarations/src/generated/models/importrequests.d.ts +31 -17
  53. package/dist/declarations/src/generated/models/importrequests.d.ts.map +1 -1
  54. package/dist/declarations/src/generated/models/importsummaries.d.ts +11 -12
  55. package/dist/declarations/src/generated/models/importsummaries.d.ts.map +1 -1
  56. package/dist/declarations/src/generated/models/inventories.d.ts +8 -8
  57. package/dist/declarations/src/generated/models/order-patches.d.ts +57 -7
  58. package/dist/declarations/src/generated/models/order-patches.d.ts.map +1 -1
  59. package/dist/declarations/src/generated/models/orders.d.ts +138 -46
  60. package/dist/declarations/src/generated/models/orders.d.ts.map +1 -1
  61. package/dist/declarations/src/generated/models/prices.d.ts +10 -14
  62. package/dist/declarations/src/generated/models/prices.d.ts.map +1 -1
  63. package/dist/declarations/src/generated/models/product-selections.d.ts +109 -0
  64. package/dist/declarations/src/generated/models/product-selections.d.ts.map +1 -0
  65. package/dist/declarations/src/generated/models/productdrafts.d.ts +41 -64
  66. package/dist/declarations/src/generated/models/productdrafts.d.ts.map +1 -1
  67. package/dist/declarations/src/generated/models/products.d.ts +22 -60
  68. package/dist/declarations/src/generated/models/products.d.ts.map +1 -1
  69. package/dist/declarations/src/generated/models/producttypes.d.ts +23 -19
  70. package/dist/declarations/src/generated/models/producttypes.d.ts.map +1 -1
  71. package/dist/declarations/src/generated/models/productvariants.d.ts +162 -89
  72. package/dist/declarations/src/generated/models/productvariants.d.ts.map +1 -1
  73. package/dist/declarations/src/generated/models/standalone-prices.d.ts +14 -15
  74. package/dist/declarations/src/generated/models/standalone-prices.d.ts.map +1 -1
  75. package/dist/declarations/src/generated/models/types.d.ts +11 -4
  76. package/dist/declarations/src/generated/models/types.d.ts.map +1 -1
  77. package/package.json +2 -2
@@ -11,13 +11,13 @@ export declare enum AuthenticationModeValues {
11
11
  }
12
12
  export type AuthenticationMode = 'ExternalAuth' | 'Password' | (string & {});
13
13
  /**
14
- * Different from [Address](/types#address) in that `key` is required and `id` is not supported.
14
+ * Different from [Address](ctp:api:type:Address) in that `key` is required and `id` is not supported.
15
15
  *
16
16
  */
17
17
  export interface CustomerAddress {
18
18
  /**
19
19
  * User-defined identifier for the address.
20
- * Must follow the pattern `[a-zA-Z0-9_\-]{2,256}` and must be unique per customer.
20
+ * Must be unique per customer.
21
21
  *
22
22
  *
23
23
  */
@@ -167,12 +167,12 @@ export interface CustomerAddress {
167
167
  readonly custom?: Custom;
168
168
  }
169
169
  /**
170
- * The data representation for a Customer to be imported that is persisted as a [Customer](ctp:api:type:Customer) in the Project.
170
+ * Represents the data used to import a Customer. Once imported, this data is persisted as a [Customer](ctp:api:type:Customer) in the Project.
171
171
  *
172
172
  */
173
173
  export interface CustomerImport extends ImportResource {
174
174
  /**
175
- * User-defined unique identifier. If a [Customer](ctp:api:type:Customer) with this `key` exists, it will be updated with the imported data.
175
+ * User-defined unique identifier. If a [Customer](ctp:api:type:Customer) with this `key` exists, it is updated with the imported data.
176
176
  *
177
177
  */
178
178
  readonly key: string;
@@ -189,13 +189,13 @@ export interface CustomerImport extends ImportResource {
189
189
  */
190
190
  readonly email: string;
191
191
  /**
192
- * Required when `authenticationMode` is set to `Password`. Maps to `Customer.password`.
192
+ * Maps to `Customer.password`. Required when `authenticationMode` is set to `Password`.
193
193
  *
194
194
  *
195
195
  */
196
196
  readonly password?: string;
197
197
  /**
198
- * The References to the Stores with which the Customer is associated. If referenced Stores do not exist, the `state` of the [ImportOperation](ctp:import:type:ImportOperation) will be set to `unresolved` until the necessary Stores are created.
198
+ * Maps to `Customer.stores`. If the referenced [Stores](ctp:api:type:Store) do not exist, the `state` of the [ImportOperation](ctp:import:type:ImportOperation) will be set to `unresolved` until the referenced Stores are created.
199
199
  *
200
200
  *
201
201
  */
@@ -261,8 +261,7 @@ export interface CustomerImport extends ImportResource {
261
261
  */
262
262
  readonly isEmailVerified?: boolean;
263
263
  /**
264
- * The Reference to the [CustomerGroup](ctp:api:type:CustomerGroup) with which the Customer is associated.
265
- * If referenced CustomerGroup does not exist, the `state` of the [ImportOperation](ctp:import:type:ImportOperation) will be set to `unresolved` until the necessary CustomerGroup is created.
264
+ * Maps to `Customer.customerGroup`. If the referenced [CustomerGroup](ctp:api:type:CustomerGroup) does not exist, the `state` of the [ImportOperation](ctp:import:type:ImportOperation) will be set to `unresolved` until the referenced CustomerGroup is created.
266
265
  *
267
266
  *
268
267
  */
@@ -274,25 +273,25 @@ export interface CustomerImport extends ImportResource {
274
273
  */
275
274
  readonly addresses?: CustomerAddress[];
276
275
  /**
277
- * The index of the address in the addresses array. The `defaultBillingAddressId` of the customer will be set to the ID of that address.
276
+ * Index of the address in the `addresses` array to use as the default billing address. The `defaultBillingAddressId` of the Customer will be set to the `id` of that address.
278
277
  *
279
278
  *
280
279
  */
281
280
  readonly defaultBillingAddress?: number;
282
281
  /**
283
- * The indices of the billing addresses in the addresses array. The `billingAddressIds` of the customer will be set to the IDs of that addresses.
282
+ * Indices of the billing addresses in the `addresses` array. The `billingAddressIds` of the Customer will be set to the `id` of these addresses.
284
283
  *
285
284
  *
286
285
  */
287
286
  readonly billingAddresses?: number[];
288
287
  /**
289
- * The index of the address in the addresses array. The `defaultShippingAddressId` of the customer will be set to the ID of that address.
288
+ * The index of the address in the `addresses` array. The `defaultShippingAddressId` of the Customer will be set to the `id` of that address.
290
289
  *
291
290
  *
292
291
  */
293
292
  readonly defaultShippingAddress?: number;
294
293
  /**
295
- * The indices of the shipping addresses in the addresses array. The `shippingAddressIds` of the customer will be set to the IDs of that addresses.
294
+ * Indices of the shipping addresses in the `addresses` array. The `shippingAddressIds` of the Customer will be set to the `id` of these addresses.
296
295
  *
297
296
  *
298
297
  */
@@ -304,7 +303,7 @@ export interface CustomerImport extends ImportResource {
304
303
  */
305
304
  readonly locale?: string;
306
305
  /**
307
- * The Custom Fields for this Customer.
306
+ * Maps to `Customer.custom`.
308
307
  *
309
308
  *
310
309
  */
@@ -1 +1 @@
1
- {"version":3,"file":"customers.d.ts","sourceRoot":"../../../../../src/generated/models","sources":["customers.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EACL,yBAAyB,EACzB,cAAc,EACd,iBAAiB,EAClB,oBAAgB;AACjB,OAAO,EAAE,MAAM,EAAE,0BAAsB;AAEvC,oBAAY,wBAAwB;IAClC,YAAY,iBAAiB;IAC7B,QAAQ,aAAa;CACtB;AAED,MAAM,MAAM,kBAAkB,GAAG,cAAc,GAAG,UAAU,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,CAAA;AAC5E;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B;;;;;OAKG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;IACpB;;;;OAIG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;IACxB;;;;OAIG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAA;IACvB;;;;OAIG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAA;IAC5B;;;;OAIG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAA;IAC3B;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;IAC1B;;;;OAIG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAA;IAC5B;;;;OAIG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAA;IAC9B;;;;OAIG;IACH,QAAQ,CAAC,oBAAoB,CAAC,EAAE,MAAM,CAAA;IACtC;;;;OAIG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAA;IAC5B;;;;OAIG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAA;IACtB;;;;OAIG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;IACxB;;;;OAIG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAA;IACvB;;;;OAIG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAA;IACzB;;;;OAIG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAA;IAC5B;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;IAC1B;;;;OAIG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAA;IAC3B;;;;OAIG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAA;IACvB;;;;OAIG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAA;IACvB;;;;OAIG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;IACxB;;;;OAIG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAA;IACvB;;;;OAIG;IACH,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAA;IACrB;;;;OAIG;IACH,QAAQ,CAAC,qBAAqB,CAAC,EAAE,MAAM,CAAA;IACvC;;;;OAIG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAA;IAC5B;;;OAGG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;CACzB;AACD;;;GAGG;AACH,MAAM,WAAW,cAAe,SAAQ,cAAc;IACpD;;;OAGG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;IACpB;;;;OAIG;IACH,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAA;IAChC;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;IACtB;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;IAC1B;;;;OAIG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,iBAAiB,EAAE,CAAA;IACrC;;;;OAIG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAA;IAC3B;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;IAC1B;;;;OAIG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAA;IAC5B;;;;OAIG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAA;IACvB;;;;OAIG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAA;IAC5B;;;;OAIG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAA;IAC5B;;;;OAIG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAA;IAC7B;;;;OAIG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAA;IAC7B;;;;OAIG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAA;IACvB;;;;OAIG;IACH,QAAQ,CAAC,eAAe,CAAC,EAAE,OAAO,CAAA;IAClC;;;;;OAKG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,yBAAyB,CAAA;IAClD;;;;OAIG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,eAAe,EAAE,CAAA;IACtC;;;;OAIG;IACH,QAAQ,CAAC,qBAAqB,CAAC,EAAE,MAAM,CAAA;IACvC;;;;OAIG;IACH,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAA;IACpC;;;;OAIG;IACH,QAAQ,CAAC,sBAAsB,CAAC,EAAE,MAAM,CAAA;IACxC;;;;OAIG;IACH,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAA;IACrC;;;;OAIG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;IACxB;;;;OAIG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;IACxB;;;;;OAKG;IACH,QAAQ,CAAC,kBAAkB,CAAC,EAAE,kBAAkB,CAAA;CACjD"}
1
+ {"version":3,"file":"customers.d.ts","sourceRoot":"../../../../../src/generated/models","sources":["customers.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EACL,yBAAyB,EACzB,cAAc,EACd,iBAAiB,EAClB,oBAAgB;AACjB,OAAO,EAAE,MAAM,EAAE,0BAAsB;AAEvC,oBAAY,wBAAwB;IAClC,YAAY,iBAAiB;IAC7B,QAAQ,aAAa;CACtB;AAED,MAAM,MAAM,kBAAkB,GAAG,cAAc,GAAG,UAAU,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,CAAA;AAC5E;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B;;;;;OAKG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;IACpB;;;;OAIG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;IACxB;;;;OAIG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAA;IACvB;;;;OAIG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAA;IAC5B;;;;OAIG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAA;IAC3B;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;IAC1B;;;;OAIG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAA;IAC5B;;;;OAIG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAA;IAC9B;;;;OAIG;IACH,QAAQ,CAAC,oBAAoB,CAAC,EAAE,MAAM,CAAA;IACtC;;;;OAIG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAA;IAC5B;;;;OAIG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAA;IACtB;;;;OAIG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;IACxB;;;;OAIG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAA;IACvB;;;;OAIG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAA;IACzB;;;;OAIG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAA;IAC5B;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;IAC1B;;;;OAIG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAA;IAC3B;;;;OAIG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAA;IACvB;;;;OAIG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAA;IACvB;;;;OAIG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;IACxB;;;;OAIG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAA;IACvB;;;;OAIG;IACH,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAA;IACrB;;;;OAIG;IACH,QAAQ,CAAC,qBAAqB,CAAC,EAAE,MAAM,CAAA;IACvC;;;;OAIG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAA;IAC5B;;;OAGG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;CACzB;AACD;;;GAGG;AACH,MAAM,WAAW,cAAe,SAAQ,cAAc;IACpD;;;OAGG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;IACpB;;;;OAIG;IACH,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAA;IAChC;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;IACtB;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;IAC1B;;;;OAIG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,iBAAiB,EAAE,CAAA;IACrC;;;;OAIG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAA;IAC3B;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;IAC1B;;;;OAIG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAA;IAC5B;;;;OAIG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAA;IACvB;;;;OAIG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAA;IAC5B;;;;OAIG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAA;IAC5B;;;;OAIG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAA;IAC7B;;;;OAIG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAA;IAC7B;;;;OAIG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAA;IACvB;;;;OAIG;IACH,QAAQ,CAAC,eAAe,CAAC,EAAE,OAAO,CAAA;IAClC;;;;OAIG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,yBAAyB,CAAA;IAClD;;;;OAIG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,eAAe,EAAE,CAAA;IACtC;;;;OAIG;IACH,QAAQ,CAAC,qBAAqB,CAAC,EAAE,MAAM,CAAA;IACvC;;;;OAIG;IACH,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAA;IACpC;;;;OAIG;IACH,QAAQ,CAAC,sBAAsB,CAAC,EAAE,MAAM,CAAA;IACxC;;;;OAIG;IACH,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAA;IACrC;;;;OAIG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;IACxB;;;;OAIG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;IACxB;;;;;OAKG;IACH,QAAQ,CAAC,kBAAkB,CAAC,EAAE,kBAAkB,CAAA;CACjD"}
@@ -3,13 +3,13 @@
3
3
  * Please don't change this file manually but run `rmf-codegen generate raml_file_path -o output_path -t typescript_client` to update it.
4
4
  * For more information about the commercetools platform APIs, visit https://docs.commercetools.com/.
5
5
  */
6
- import { KeyReference, LocalizedString, Money, TypedMoney, TypeKeyReference } from "./common.js";
6
+ import { KeyReference, LocalizedString, TypedMoney, TypeKeyReference } from "./common.js";
7
7
  /**
8
8
  * The representation to be sent to the server when creating a resource with Custom Fields.
9
9
  */
10
10
  export interface Custom {
11
11
  /**
12
- * The type that provides the field definitions for this object.
12
+ * The [Type](ctp:api:type:Type) that provides the field definitions for this object. If the referenced Type does not exist, the `state` of the [ImportOperation](ctp:import:type:ImportOperation) will be set to `unresolved` until the referenced Type is created.
13
13
  *
14
14
  */
15
15
  readonly type: TypeKeyReference;
@@ -42,168 +42,195 @@ export interface ICustomField {
42
42
  export interface BooleanField extends ICustomField {
43
43
  readonly type: 'Boolean';
44
44
  /**
45
+ * `true` or `false`
46
+ *
45
47
  *
46
48
  */
47
49
  readonly value: boolean;
48
50
  }
49
51
  /**
50
- * A field with a string value.
52
+ * A field with a boolean set value.
51
53
  */
52
- export interface StringField extends ICustomField {
53
- readonly type: 'String';
54
+ export interface BooleanSetField extends ICustomField {
55
+ readonly type: 'BooleanSet';
54
56
  /**
57
+ * JSON array of boolean values without duplicates.
58
+ * The order of items in the array is not fixed.
59
+ *
55
60
  *
56
61
  */
57
- readonly value: string;
62
+ readonly value: boolean[];
58
63
  }
59
64
  /**
60
- * A field with a localized string value.
65
+ * A field with a date value.
61
66
  */
62
- export interface LocalizedStringField extends ICustomField {
63
- readonly type: 'LocalizedString';
67
+ export interface DateField extends ICustomField {
68
+ readonly type: 'Date';
64
69
  /**
65
- * A localized string is a JSON object where the keys are of [IETF language tag](https://en.wikipedia.org/wiki/IETF_language_tag), and the values the corresponding strings used for that language.
66
- * ```json
67
- * {
68
- * "de": "Hundefutter",
69
- * "en": "dog food"
70
- * }
71
- * ```
70
+ * A date in the format `YYYY-MM-DD`.
72
71
  *
73
72
  *
74
73
  */
75
- readonly value: LocalizedString;
74
+ readonly value: string;
76
75
  }
77
76
  /**
78
- * A field with an enum value.
77
+ * A field with a date set value.
79
78
  */
80
- export interface EnumField extends ICustomField {
81
- readonly type: 'Enum';
79
+ export interface DateSetField extends ICustomField {
80
+ readonly type: 'DateSet';
82
81
  /**
82
+ * JSON array of date values in the format `YYYY-MM-DD` without duplicates.
83
+ * The order of items in the array is not fixed.
84
+ *
83
85
  *
84
86
  */
85
- readonly value: string;
87
+ readonly value: string[];
86
88
  }
87
89
  /**
88
- * A field with a localized enum value.
90
+ * A field with a date time value.
89
91
  */
90
- export interface LocalizedEnumField extends ICustomField {
91
- readonly type: 'LocalizedEnum';
92
+ export interface DateTimeField extends ICustomField {
93
+ readonly type: 'DateTime';
92
94
  /**
95
+ * A date with time in the format `YYYY-MM-DDTHH:mm:ss.SSSZ`.
96
+ * The time zone is optional and defaults to UTC if not specified.
97
+ * If the time zone is specified, it must be in the format `±HH:mm` or `Z` for UTC.
98
+ *
93
99
  *
94
100
  */
95
101
  readonly value: string;
96
102
  }
97
103
  /**
98
- * A field with a number value.
104
+ * A field with a date time set value.
99
105
  */
100
- export interface NumberField extends ICustomField {
101
- readonly type: 'Number';
106
+ export interface DateTimeSetField extends ICustomField {
107
+ readonly type: 'DateTimeSet';
102
108
  /**
109
+ * JSON array of date time values in the format `YYYY-MM-DDTHH:mm:ss.SSSZ` without duplicates.
110
+ * The time zone is optional and defaults to UTC if not specified.
111
+ * If the time zone is specified, it must be in the format `±HH:mm` or `Z` for UTC.
112
+ * The order of items in the array is not fixed.
103
113
  *
104
- */
105
- readonly value: number;
106
- }
107
- /**
108
- * A field with a money value.
109
- */
110
- export interface MoneyField extends ICustomField {
111
- readonly type: 'Money';
112
- /**
113
114
  *
114
115
  */
115
- readonly value: TypedMoney;
116
+ readonly value: string[];
116
117
  }
117
118
  /**
118
- * A field with a date value.
119
+ * A field with an enum value.
119
120
  */
120
- export interface DateField extends ICustomField {
121
- readonly type: 'Date';
121
+ export interface EnumField extends ICustomField {
122
+ readonly type: 'Enum';
122
123
  /**
124
+ * The key of the enum value.
125
+ * Must be a `key` of one of the [CustomFieldEnumValues](ctp:api:type:CustomFieldEnumValue) defined in the [CustomFieldEnumType](ctp:api:type:CustomFieldEnumType).
126
+ *
123
127
  *
124
128
  */
125
129
  readonly value: string;
126
130
  }
127
131
  /**
128
- * A field with a time value.
132
+ * A field with an enum set value.
129
133
  */
130
- export interface TimeField extends ICustomField {
131
- readonly type: 'Time';
134
+ export interface EnumSetField extends ICustomField {
135
+ readonly type: 'EnumSet';
132
136
  /**
137
+ * JSON array of enum values, each represented by its key.
138
+ * Each key must match the key of a [CustomFieldLocalizedEnumValue](ctp:api:type:CustomFieldEnumValue) in the [CustomFieldEnumType](ctp:api:type:CustomFieldEnumType).
139
+ * The order of items in the array is not fixed.
140
+ *
133
141
  *
134
142
  */
135
- readonly value: string;
143
+ readonly value: string[];
136
144
  }
137
145
  /**
138
- * A field with a date time value.
146
+ * A field with a localized enum value.
139
147
  */
140
- export interface DateTimeField extends ICustomField {
141
- readonly type: 'DateTime';
148
+ export interface LocalizedEnumField extends ICustomField {
149
+ readonly type: 'LocalizedEnum';
142
150
  /**
151
+ * The key of the localized enum value.
152
+ * Must match the key of a [CustomFieldLocalizedEnumValue](ctp:api:type:CustomFieldLocalizedEnumValue) in the [CustomFieldLocalizedEnumType](ctp:api:type:CustomFieldLocalizedEnumType).
153
+ *
143
154
  *
144
155
  */
145
156
  readonly value: string;
146
157
  }
147
158
  /**
148
- * A field with a reference value.
159
+ * A field with a localized enum set value.
149
160
  */
150
- export interface ReferenceField extends ICustomField {
151
- readonly type: 'Reference';
161
+ export interface LocalizedEnumSetField extends ICustomField {
162
+ readonly type: 'LocalizedEnumSet';
152
163
  /**
153
- * References a resource by key
164
+ * JSON array of localized enum values, each represented by its key.
165
+ * Each key must match the key of an [CustomFieldLocalizedEnumValue](ctp:api:type:CustomFieldLocalizedEnumValue) in the [CustomFieldLocalizedEnumType](ctp:api:type:CustomFieldLocalizedEnumType).
166
+ * The order of items in the array is not fixed.
167
+ *
154
168
  *
155
169
  */
156
- readonly value: KeyReference;
170
+ readonly value: string[];
157
171
  }
158
172
  /**
159
- * A field with a boolean set value.
173
+ * A field with a localized string value.
160
174
  */
161
- export interface BooleanSetField extends ICustomField {
162
- readonly type: 'BooleanSet';
175
+ export interface LocalizedStringField extends ICustomField {
176
+ readonly type: 'LocalizedString';
163
177
  /**
178
+ * A localized string.
179
+ *
164
180
  *
165
181
  */
166
- readonly value: boolean[];
182
+ readonly value: LocalizedString;
167
183
  }
168
184
  /**
169
- * A field with a string set value.
185
+ * A field with a localized string set value.
170
186
  */
171
- export interface StringSetField extends ICustomField {
172
- readonly type: 'StringSet';
187
+ export interface LocalizedStringSetField extends ICustomField {
188
+ readonly type: 'LocalizedStringSet';
173
189
  /**
190
+ * JSON array of localized strings.
191
+ * The order of items in the array is not fixed.
192
+ *
174
193
  *
175
194
  */
176
- readonly value: string[];
195
+ readonly value: LocalizedString[];
177
196
  }
178
197
  /**
179
- * A field with a localized string set value.
198
+ * A field with a money value.
180
199
  */
181
- export interface LocalizedStringSetField extends ICustomField {
182
- readonly type: 'LocalizedStringSet';
200
+ export interface MoneyField extends ICustomField {
201
+ readonly type: 'Money';
183
202
  /**
203
+ * A money value in cent precision format.
204
+ *
184
205
  *
185
206
  */
186
- readonly value: LocalizedString[];
207
+ readonly value: TypedMoney;
187
208
  }
188
209
  /**
189
- * A field with an enum set value.
210
+ * A field with a money set value.
190
211
  */
191
- export interface EnumSetField extends ICustomField {
192
- readonly type: 'EnumSet';
212
+ export interface MoneySetField extends ICustomField {
213
+ readonly type: 'MoneySet';
193
214
  /**
215
+ * JSON array of money values in cent precision format.
216
+ * The order of items in the array is not fixed.
217
+ *
194
218
  *
195
219
  */
196
- readonly value: string[];
220
+ readonly value: TypedMoney[];
197
221
  }
198
222
  /**
199
- * A field with a localized enum set value.
223
+ * A field with a number value.
200
224
  */
201
- export interface LocalizedEnumSetField extends ICustomField {
202
- readonly type: 'LocalizedEnumSet';
225
+ export interface NumberField extends ICustomField {
226
+ readonly type: 'Number';
203
227
  /**
228
+ * A number value.
229
+ * Can be an integer or a floating-point number.
230
+ *
204
231
  *
205
232
  */
206
- readonly value: string[];
233
+ readonly value: number;
207
234
  }
208
235
  /**
209
236
  * A field with a number value.
@@ -211,58 +238,89 @@ export interface LocalizedEnumSetField extends ICustomField {
211
238
  export interface NumberSetField extends ICustomField {
212
239
  readonly type: 'NumberSet';
213
240
  /**
241
+ * JSON array of integer or floating-point number values.
242
+ * The order of items in the array is not fixed.
243
+ *
214
244
  *
215
245
  */
216
246
  readonly value: number[];
217
247
  }
218
248
  /**
219
- * A field with a money set value.
249
+ * A field with a reference value.
220
250
  */
221
- export interface MoneySetField extends ICustomField {
222
- readonly type: 'MoneySet';
251
+ export interface ReferenceField extends ICustomField {
252
+ readonly type: 'Reference';
223
253
  /**
254
+ * References a resource by key
224
255
  *
225
256
  */
226
- readonly value: Money[];
257
+ readonly value: KeyReference;
227
258
  }
228
259
  /**
229
- * A field with a date set value.
260
+ * A field with a reference set value.
230
261
  */
231
- export interface DateSetField extends ICustomField {
232
- readonly type: 'DateSet';
262
+ export interface ReferenceSetField extends ICustomField {
263
+ readonly type: 'ReferenceSet';
233
264
  /**
265
+ * JSON array of references, each referencing an existing resource by key.
266
+ * The order of items in the array is not fixed.
267
+ *
234
268
  *
235
269
  */
236
- readonly value: string[];
270
+ readonly value: KeyReference[];
237
271
  }
238
272
  /**
239
- * A field with a time set value.
273
+ * A field with a string value.
240
274
  */
241
- export interface TimeSetField extends ICustomField {
242
- readonly type: 'TimeSet';
275
+ export interface StringField extends ICustomField {
276
+ readonly type: 'String';
243
277
  /**
278
+ * A text value.
279
+ *
244
280
  *
245
281
  */
246
- readonly value: string[];
282
+ readonly value: string;
247
283
  }
248
284
  /**
249
- * A field with a date time set value.
285
+ * A field with a string set value.
250
286
  */
251
- export interface DateTimeSetField extends ICustomField {
252
- readonly type: 'DateTimeSet';
287
+ export interface StringSetField extends ICustomField {
288
+ readonly type: 'StringSet';
253
289
  /**
290
+ * JSON array of strings.
291
+ * The order of items in the array is not fixed.
292
+ *
254
293
  *
255
294
  */
256
295
  readonly value: string[];
257
296
  }
258
297
  /**
259
- * A field with a reference set value.
298
+ * A field with a time value.
260
299
  */
261
- export interface ReferenceSetField extends ICustomField {
262
- readonly type: 'ReferenceSet';
300
+ export interface TimeField extends ICustomField {
301
+ readonly type: 'Time';
263
302
  /**
303
+ * A time value in the format `HH:mm:ss.SSS`.
304
+ * The time zone is optional and defaults to UTC if not specified.
305
+ * If the time zone is specified, it must be in the format `±HH:mm` or `Z` for UTC.
306
+ *
264
307
  *
265
308
  */
266
- readonly value: KeyReference[];
309
+ readonly value: string;
310
+ }
311
+ /**
312
+ * A field with a time set value.
313
+ */
314
+ export interface TimeSetField extends ICustomField {
315
+ readonly type: 'TimeSet';
316
+ /**
317
+ * JSON array of time values in the format `HH:mm:ss.SSS`.
318
+ * The time zone is optional and defaults to UTC if not specified.
319
+ * If the time zone is specified, it must be in the format `±HH:mm` or `Z` for UTC.
320
+ * The order of items in the array is not fixed.
321
+ *
322
+ *
323
+ */
324
+ readonly value: string[];
267
325
  }
268
326
  //# sourceMappingURL=customfields.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"customfields.d.ts","sourceRoot":"../../../../../src/generated/models","sources":["customfields.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EACL,YAAY,EACZ,eAAe,EACf,KAAK,EACL,UAAU,EACV,gBAAgB,EACjB,oBAAgB;AAEjB;;GAEG;AACH,MAAM,WAAW,MAAM;IACrB;;;OAGG;IACH,QAAQ,CAAC,IAAI,EAAE,gBAAgB,CAAA;IAC/B;;;OAGG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,cAAc,CAAA;CACjC;AACD;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,CAAC,GAAG,EAAE,MAAM,GAAG,WAAW,CAAA;CAC3B;AACD;;GAEG;AACH,MAAM,MAAM,WAAW,GACnB,YAAY,GACZ,eAAe,GACf,SAAS,GACT,YAAY,GACZ,aAAa,GACb,gBAAgB,GAChB,SAAS,GACT,YAAY,GACZ,kBAAkB,GAClB,qBAAqB,GACrB,oBAAoB,GACpB,uBAAuB,GACvB,UAAU,GACV,aAAa,GACb,WAAW,GACX,cAAc,GACd,cAAc,GACd,iBAAiB,GACjB,WAAW,GACX,cAAc,GACd,SAAS,GACT,YAAY,CAAA;AAChB,MAAM,WAAW,YAAY;IAC3B;;;OAGG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;CACtB;AACD;;GAEG;AACH,MAAM,WAAW,YAAa,SAAQ,YAAY;IAChD,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAA;IACxB;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAA;CACxB;AACD;;GAEG;AACH,MAAM,WAAW,WAAY,SAAQ,YAAY;IAC/C,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAA;IACvB;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;CACvB;AACD;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,YAAY;IACxD,QAAQ,CAAC,IAAI,EAAE,iBAAiB,CAAA;IAChC;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,KAAK,EAAE,eAAe,CAAA;CAChC;AACD;;GAEG;AACH,MAAM,WAAW,SAAU,SAAQ,YAAY;IAC7C,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;CACvB;AACD;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,YAAY;IACtD,QAAQ,CAAC,IAAI,EAAE,eAAe,CAAA;IAC9B;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;CACvB;AACD;;GAEG;AACH,MAAM,WAAW,WAAY,SAAQ,YAAY;IAC/C,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAA;IACvB;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;CACvB;AACD;;GAEG;AACH,MAAM,WAAW,UAAW,SAAQ,YAAY;IAC9C,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAA;IACtB;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,UAAU,CAAA;CAC3B;AACD;;GAEG;AACH,MAAM,WAAW,SAAU,SAAQ,YAAY;IAC7C,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;CACvB;AACD;;GAEG;AACH,MAAM,WAAW,SAAU,SAAQ,YAAY;IAC7C,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;CACvB;AACD;;GAEG;AACH,MAAM,WAAW,aAAc,SAAQ,YAAY;IACjD,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAA;IACzB;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;CACvB;AACD;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,YAAY;IAClD,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAA;IAC1B;;;OAGG;IACH,QAAQ,CAAC,KAAK,EAAE,YAAY,CAAA;CAC7B;AACD;;GAEG;AACH,MAAM,WAAW,eAAgB,SAAQ,YAAY;IACnD,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAA;IAC3B;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,OAAO,EAAE,CAAA;CAC1B;AACD;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,YAAY;IAClD,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAA;IAC1B;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,CAAA;CACzB;AACD;;GAEG;AACH,MAAM,WAAW,uBAAwB,SAAQ,YAAY;IAC3D,QAAQ,CAAC,IAAI,EAAE,oBAAoB,CAAA;IACnC;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,eAAe,EAAE,CAAA;CAClC;AACD;;GAEG;AACH,MAAM,WAAW,YAAa,SAAQ,YAAY;IAChD,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAA;IACxB;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,CAAA;CACzB;AACD;;GAEG;AACH,MAAM,WAAW,qBAAsB,SAAQ,YAAY;IACzD,QAAQ,CAAC,IAAI,EAAE,kBAAkB,CAAA;IACjC;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,CAAA;CACzB;AACD;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,YAAY;IAClD,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAA;IAC1B;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,CAAA;CACzB;AACD;;GAEG;AACH,MAAM,WAAW,aAAc,SAAQ,YAAY;IACjD,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAA;IACzB;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,KAAK,EAAE,CAAA;CACxB;AACD;;GAEG;AACH,MAAM,WAAW,YAAa,SAAQ,YAAY;IAChD,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAA;IACxB;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,CAAA;CACzB;AACD;;GAEG;AACH,MAAM,WAAW,YAAa,SAAQ,YAAY;IAChD,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAA;IACxB;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,CAAA;CACzB;AACD;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,YAAY;IACpD,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAA;IAC5B;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,CAAA;CACzB;AACD;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,YAAY;IACrD,QAAQ,CAAC,IAAI,EAAE,cAAc,CAAA;IAC7B;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,YAAY,EAAE,CAAA;CAC/B"}
1
+ {"version":3,"file":"customfields.d.ts","sourceRoot":"../../../../../src/generated/models","sources":["customfields.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EACL,YAAY,EACZ,eAAe,EACf,UAAU,EACV,gBAAgB,EACjB,oBAAgB;AAEjB;;GAEG;AACH,MAAM,WAAW,MAAM;IACrB;;;OAGG;IACH,QAAQ,CAAC,IAAI,EAAE,gBAAgB,CAAA;IAC/B;;;OAGG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,cAAc,CAAA;CACjC;AACD;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,CAAC,GAAG,EAAE,MAAM,GAAG,WAAW,CAAA;CAC3B;AACD;;GAEG;AACH,MAAM,MAAM,WAAW,GACnB,YAAY,GACZ,eAAe,GACf,SAAS,GACT,YAAY,GACZ,aAAa,GACb,gBAAgB,GAChB,SAAS,GACT,YAAY,GACZ,kBAAkB,GAClB,qBAAqB,GACrB,oBAAoB,GACpB,uBAAuB,GACvB,UAAU,GACV,aAAa,GACb,WAAW,GACX,cAAc,GACd,cAAc,GACd,iBAAiB,GACjB,WAAW,GACX,cAAc,GACd,SAAS,GACT,YAAY,CAAA;AAChB,MAAM,WAAW,YAAY;IAC3B;;;OAGG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;CACtB;AACD;;GAEG;AACH,MAAM,WAAW,YAAa,SAAQ,YAAY;IAChD,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAA;IACxB;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAA;CACxB;AACD;;GAEG;AACH,MAAM,WAAW,eAAgB,SAAQ,YAAY;IACnD,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAA;IAC3B;;;;;OAKG;IACH,QAAQ,CAAC,KAAK,EAAE,OAAO,EAAE,CAAA;CAC1B;AACD;;GAEG;AACH,MAAM,WAAW,SAAU,SAAQ,YAAY;IAC7C,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;CACvB;AACD;;GAEG;AACH,MAAM,WAAW,YAAa,SAAQ,YAAY;IAChD,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAA;IACxB;;;;;OAKG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,CAAA;CACzB;AACD;;GAEG;AACH,MAAM,WAAW,aAAc,SAAQ,YAAY;IACjD,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAA;IACzB;;;;;;OAMG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;CACvB;AACD;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,YAAY;IACpD,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAA;IAC5B;;;;;;;OAOG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,CAAA;CACzB;AACD;;GAEG;AACH,MAAM,WAAW,SAAU,SAAQ,YAAY;IAC7C,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB;;;;;OAKG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;CACvB;AACD;;GAEG;AACH,MAAM,WAAW,YAAa,SAAQ,YAAY;IAChD,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAA;IACxB;;;;;;OAMG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,CAAA;CACzB;AACD;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,YAAY;IACtD,QAAQ,CAAC,IAAI,EAAE,eAAe,CAAA;IAC9B;;;;;OAKG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;CACvB;AACD;;GAEG;AACH,MAAM,WAAW,qBAAsB,SAAQ,YAAY;IACzD,QAAQ,CAAC,IAAI,EAAE,kBAAkB,CAAA;IACjC;;;;;;OAMG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,CAAA;CACzB;AACD;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,YAAY;IACxD,QAAQ,CAAC,IAAI,EAAE,iBAAiB,CAAA;IAChC;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE,eAAe,CAAA;CAChC;AACD;;GAEG;AACH,MAAM,WAAW,uBAAwB,SAAQ,YAAY;IAC3D,QAAQ,CAAC,IAAI,EAAE,oBAAoB,CAAA;IACnC;;;;;OAKG;IACH,QAAQ,CAAC,KAAK,EAAE,eAAe,EAAE,CAAA;CAClC;AACD;;GAEG;AACH,MAAM,WAAW,UAAW,SAAQ,YAAY;IAC9C,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAA;IACtB;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE,UAAU,CAAA;CAC3B;AACD;;GAEG;AACH,MAAM,WAAW,aAAc,SAAQ,YAAY;IACjD,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAA;IACzB;;;;;OAKG;IACH,QAAQ,CAAC,KAAK,EAAE,UAAU,EAAE,CAAA;CAC7B;AACD;;GAEG;AACH,MAAM,WAAW,WAAY,SAAQ,YAAY;IAC/C,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAA;IACvB;;;;;OAKG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;CACvB;AACD;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,YAAY;IAClD,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAA;IAC1B;;;;;OAKG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,CAAA;CACzB;AACD;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,YAAY;IAClD,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAA;IAC1B;;;OAGG;IACH,QAAQ,CAAC,KAAK,EAAE,YAAY,CAAA;CAC7B;AACD;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,YAAY;IACrD,QAAQ,CAAC,IAAI,EAAE,cAAc,CAAA;IAC7B;;;;;OAKG;IACH,QAAQ,CAAC,KAAK,EAAE,YAAY,EAAE,CAAA;CAC/B;AACD;;GAEG;AACH,MAAM,WAAW,WAAY,SAAQ,YAAY;IAC/C,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAA;IACvB;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;CACvB;AACD;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,YAAY;IAClD,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAA;IAC1B;;;;;OAKG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,CAAA;CACzB;AACD;;GAEG;AACH,MAAM,WAAW,SAAU,SAAQ,YAAY;IAC7C,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB;;;;;;OAMG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;CACvB;AACD;;GAEG;AACH,MAAM,WAAW,YAAa,SAAQ,YAAY;IAChD,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAA;IACxB;;;;;;;OAOG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,CAAA;CACzB"}
@@ -6,12 +6,12 @@
6
6
  import { CartDiscountKeyReference, ImportResource, LocalizedString } from "./common.js";
7
7
  import { Custom } from "./customfields.js";
8
8
  /**
9
- * The data representation for a Discount Code to be imported that is persisted as a [Discount Code](/../api/projects/discountCodes#discountcode) in the Project.
9
+ * Represents the data used to import a DiscountCode. Once imported, this data is persisted as a [DiscountCode](ctp:api:type:DiscountCode) in the Project.
10
10
  *
11
11
  */
12
12
  export interface DiscountCodeImport extends ImportResource {
13
13
  /**
14
- * User-defined unique identifier. If a [Discount Code](/../api/projects/discountCodes#discountcode) with this `key` exists, it will be updated with the imported data.
14
+ * User-defined unique identifier. If a [DiscountCode](ctp:api:type:DiscountCode) with this `key` exists, it is updated with the imported data.
15
15
  *
16
16
  *
17
17
  */
@@ -29,63 +29,61 @@ export interface DiscountCodeImport extends ImportResource {
29
29
  */
30
30
  readonly description?: LocalizedString;
31
31
  /**
32
- * User-defined unique identifier of the DiscountCode that is used by the customer to apply the discount.
33
- *
34
- * The value cannot be updated. Attempting to update the value will result in an [InvalidFieldsUpdate](/import-export/error#invalidfieldsupdateerror) error.
32
+ * Maps to `DiscountCode.code`. This value cannot be updated. Attempting to update this value will result in an [InvalidFieldsUpdate](/import-export/error#invalidfieldsupdateerror) error.
35
33
  *
36
34
  *
37
35
  */
38
36
  readonly code: string;
39
37
  /**
40
- * Reference to CartDiscounts that can be applied to the Cart once the DiscountCode is applied.
38
+ * Maps to `DiscountCode.cartDiscounts`. If the referenced [CartDiscounts](ctp:api:type:CartDiscount) do not exist, the `state` of the [ImportOperation](ctp:import:type:ImportOperation) will be set to `unresolved` until the referenced CartDiscounts are created.
41
39
  *
42
40
  *
43
41
  */
44
42
  readonly cartDiscounts: CartDiscountKeyReference[];
45
43
  /**
46
- * DiscountCode can only be applied to Carts that match this predicate.
44
+ * Maps to `DiscountCode.cartPredicate`.
47
45
  *
48
46
  *
49
47
  */
50
48
  readonly cartPredicate?: string;
51
49
  /**
52
- * Indicates if the DiscountCode is active and can be applied to the Cart.
50
+ * Maps to `DiscountCode.isActive`.
53
51
  *
54
52
  *
55
53
  */
56
54
  readonly isActive: boolean;
57
55
  /**
58
- * Number of times the DiscountCode can be applied. DiscountCode application is counted at the time of Order creation or update. However, Order cancellation or deletion does not decrement the count.
56
+ * Maps to `DiscountCode.maxApplications`.
59
57
  *
60
58
  *
61
59
  */
62
60
  readonly maxApplications?: number;
63
61
  /**
64
- * Number of times the DiscountCode can be applied per Customer (anonymous Carts are not supported). DiscountCode application is counted at the time of Order creation or update. However, Order cancellation or deletion does not decrement the count.
62
+ * Maps to `DiscountCode.maxApplicationsPerCustomer`.
65
63
  *
66
64
  *
67
65
  */
68
66
  readonly maxApplicationsPerCustomer?: number;
69
67
  /**
70
- * Groups to which the DiscountCode belongs.
68
+ * Maps to `DiscountCode.groups`.
71
69
  *
72
70
  *
73
71
  */
74
72
  readonly groups?: string[];
75
73
  /**
76
- * Date and time (UTC) from which the DiscountCode is effective.
74
+ * Maps to `DiscountCode.validFrom`.
77
75
  *
78
76
  *
79
77
  */
80
78
  readonly validFrom?: string;
81
79
  /**
82
- * Date and time (UTC) until which the DiscountCode is effective.
80
+ * Maps to `DiscountCode.validUntil`.
83
81
  *
84
82
  *
85
83
  */
86
84
  readonly validUntil?: string;
87
85
  /**
88
- * Custom Fields of the DiscountCode.
86
+ * Maps to `DiscountCode.custom`.
89
87
  *
90
88
  *
91
89
  */
@@ -1 +1 @@
1
- {"version":3,"file":"discount-codes.d.ts","sourceRoot":"../../../../../src/generated/models","sources":["discount-codes.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EACL,wBAAwB,EACxB,cAAc,EACd,eAAe,EAChB,oBAAgB;AACjB,OAAO,EAAE,MAAM,EAAE,0BAAsB;AAEvC;;;GAGG;AACH,MAAM,WAAW,kBAAmB,SAAQ,cAAc;IACxD;;;;OAIG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;IACpB;;;;OAIG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,eAAe,CAAA;IAC/B;;;;OAIG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,eAAe,CAAA;IACtC;;;;;;OAMG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB;;;;OAIG;IACH,QAAQ,CAAC,aAAa,EAAE,wBAAwB,EAAE,CAAA;IAClD;;;;OAIG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAA;IAC/B;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAA;IAC1B;;;;OAIG;IACH,QAAQ,CAAC,eAAe,CAAC,EAAE,MAAM,CAAA;IACjC;;;;OAIG;IACH,QAAQ,CAAC,0BAA0B,CAAC,EAAE,MAAM,CAAA;IAC5C;;;;OAIG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;IAC1B;;;;OAIG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAA;IAC3B;;;;OAIG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAA;IAC5B;;;;OAIG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;CACzB"}
1
+ {"version":3,"file":"discount-codes.d.ts","sourceRoot":"../../../../../src/generated/models","sources":["discount-codes.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EACL,wBAAwB,EACxB,cAAc,EACd,eAAe,EAChB,oBAAgB;AACjB,OAAO,EAAE,MAAM,EAAE,0BAAsB;AAEvC;;;GAGG;AACH,MAAM,WAAW,kBAAmB,SAAQ,cAAc;IACxD;;;;OAIG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;IACpB;;;;OAIG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,eAAe,CAAA;IAC/B;;;;OAIG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,eAAe,CAAA;IACtC;;;;OAIG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB;;;;OAIG;IACH,QAAQ,CAAC,aAAa,EAAE,wBAAwB,EAAE,CAAA;IAClD;;;;OAIG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAA;IAC/B;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAA;IAC1B;;;;OAIG;IACH,QAAQ,CAAC,eAAe,CAAC,EAAE,MAAM,CAAA;IACjC;;;;OAIG;IACH,QAAQ,CAAC,0BAA0B,CAAC,EAAE,MAAM,CAAA;IAC5C;;;;OAIG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;IAC1B;;;;OAIG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAA;IAC3B;;;;OAIG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAA;IAC5B;;;;OAIG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;CACzB"}