@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
@@ -7,6 +7,8 @@ import { ChannelKeyReference, CustomerGroupKeyReference, DiscountedPrice, Import
7
7
  import { Custom } from "./customfields.js";
8
8
  export interface SubRate {
9
9
  /**
10
+ * Name of the SubRate.
11
+ *
10
12
  *
11
13
  */
12
14
  readonly name: string;
@@ -48,12 +50,12 @@ export interface TaxRate {
48
50
  readonly subRates?: SubRate[];
49
51
  }
50
52
  /**
51
- * The data representation for a price to be imported that is persisted as a [Price](/../api/types#price) in the Project.
53
+ * Represents the data used to import an [Embedded Price](/../api/pricing-and-discounts-overview#embedded-prices) . Once imported, this data is persisted as a [Price](/../api/types#price) in a Product Variant.
52
54
  *
53
55
  */
54
56
  export interface PriceImport extends ImportResource {
55
57
  /**
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.
58
+ * User-defined unique identifier for the Embedded Price. If a [Price](/../api/types#price) with this `key` exists on the specified `productVariant`, it is updated with the imported data.
57
59
  *
58
60
  *
59
61
  */
@@ -83,15 +85,13 @@ export interface PriceImport extends ImportResource {
83
85
  */
84
86
  readonly validUntil?: string;
85
87
  /**
86
- * The Reference to the [CustomerGroup](ctp:api:type:CustomerGroup) with which the [Price](/../api/types#price) is associated.
87
- * 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.
88
+ * Maps to `Price.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.
88
89
  *
89
90
  *
90
91
  */
91
92
  readonly customerGroup?: CustomerGroupKeyReference;
92
93
  /**
93
- * The Reference to the [Channel](ctp:api:type:Channel) with which the [Price](/../api/types#price) is associated.
94
- * If referenced Channel does not exist, the `state` of the [ImportOperation](ctp:import:type:ImportOperation) will be set to `unresolved` until the necessary Channel is created.
94
+ * Maps to `Price.channel`. If the referenced [Channel](ctp:api:type:Channel) does not exist, the `state` of the [ImportOperation](ctp:import:type:ImportOperation) will be set to `unresolved` until the referenced Channel is created.
95
95
  *
96
96
  *
97
97
  */
@@ -102,7 +102,7 @@ export interface PriceImport extends ImportResource {
102
102
  */
103
103
  readonly discounted?: DiscountedPrice;
104
104
  /**
105
- * - Set to `false` to update both the [current and staged projections](/../api/projects/productProjections#current--staged) of the [Product](/../api/projects/products#product) with the new Price data.
105
+ * - Set to `false` to update both the [current and staged projections](/../api/projects/productProjections#current--staged) of the [Product](ctp:api:type:Product) with the new Price data.
106
106
  * - Leave empty or set to `true` to only update the staged projection.
107
107
  *
108
108
  *
@@ -114,22 +114,18 @@ export interface PriceImport extends ImportResource {
114
114
  */
115
115
  readonly tiers?: PriceTier[];
116
116
  /**
117
- * The custom fields for this price.
117
+ * Maps to `Price.custom`.
118
118
  *
119
119
  */
120
120
  readonly custom?: Custom;
121
121
  /**
122
- * The ProductVariant in which this [Embedded Price](/types#price) is contained.
123
- * The Reference to the [ProductVariant](/projects/products#productvariant) with which the [Price](/types#price) is associated.
124
- * If the referenced ProductVariant does not exist, the `state` of the [ImportOperation](/import-export/import-operation#importoperation) will be set to `unresolved` until the necessary ProductVariant is created.
122
+ * The [ProductVariant](ctp:api:type:ProductVariant) which contains this Embedded Price. If the referenced ProductVariant does not exist, the `state` of the [ImportOperation](ctp:import:type:ImportOperation) will be set to `unresolved` until the referenced ProductVariant is created.
125
123
  *
126
124
  *
127
125
  */
128
126
  readonly productVariant: ProductVariantKeyReference;
129
127
  /**
130
- * The Product in which the Product Variant containing this [Embedded Price](/types#price) is contained. Maps to `ProductVariant.product`.
131
- * The Reference to the [Product](/projects/products#product) with which the [Price](/types#price) is associated.
132
- * If referenced Product does not exist, the `state` of the [ImportOperation](/import-export/import-operation#importoperation) will be set to `unresolved` until the necessary Product is created.
128
+ * The [Product](ctp:api:type:Product) which contains the `productVariant`. If the referenced Product does not exist, the `state` of the [ImportOperation](ctp:import:type:ImportOperation) will be set to `unresolved` until the referenced Product is created.
133
129
  *
134
130
  *
135
131
  */
@@ -1 +1 @@
1
- {"version":3,"file":"prices.d.ts","sourceRoot":"../../../../../src/generated/models","sources":["prices.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EACL,mBAAmB,EACnB,yBAAyB,EACzB,eAAe,EACf,cAAc,EACd,SAAS,EACT,mBAAmB,EACnB,0BAA0B,EAC1B,UAAU,EACX,oBAAgB;AACjB,OAAO,EAAE,MAAM,EAAE,0BAAsB;AAEvC,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;CACxB;AACD,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,QAAQ,CAAC,EAAE,CAAC,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB;;OAEG;IACH,QAAQ,CAAC,eAAe,EAAE,OAAO,CAAA;IACjC;;;;OAIG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;IACxB;;OAEG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAA;IACvB;;OAEG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAA;CAC9B;AACD;;;GAGG;AACH,MAAM,WAAW,WAAY,SAAQ,cAAc;IACjD;;;;OAIG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;IACpB;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE,UAAU,CAAA;IAC1B;;;;OAIG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAA;IACzB;;;;OAIG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAA;IAC3B;;;;OAIG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAA;IAC5B;;;;;OAKG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,yBAAyB,CAAA;IAClD;;;;;OAKG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,mBAAmB,CAAA;IACtC;;;OAGG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,eAAe,CAAA;IACrC;;;;;OAKG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,CAAA;IACzB;;;OAGG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,SAAS,EAAE,CAAA;IAC5B;;;OAGG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;IACxB;;;;;;OAMG;IACH,QAAQ,CAAC,cAAc,EAAE,0BAA0B,CAAA;IACnD;;;;;;OAMG;IACH,QAAQ,CAAC,OAAO,EAAE,mBAAmB,CAAA;CACtC"}
1
+ {"version":3,"file":"prices.d.ts","sourceRoot":"../../../../../src/generated/models","sources":["prices.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EACL,mBAAmB,EACnB,yBAAyB,EACzB,eAAe,EACf,cAAc,EACd,SAAS,EACT,mBAAmB,EACnB,0BAA0B,EAC1B,UAAU,EACX,oBAAgB;AACjB,OAAO,EAAE,MAAM,EAAE,0BAAsB;AAEvC,MAAM,WAAW,OAAO;IACtB;;;;OAIG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;CACxB;AACD,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,QAAQ,CAAC,EAAE,CAAC,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB;;OAEG;IACH,QAAQ,CAAC,eAAe,EAAE,OAAO,CAAA;IACjC;;;;OAIG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;IACxB;;OAEG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAA;IACvB;;OAEG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAA;CAC9B;AACD;;;GAGG;AACH,MAAM,WAAW,WAAY,SAAQ,cAAc;IACjD;;;;OAIG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;IACpB;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE,UAAU,CAAA;IAC1B;;;;OAIG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAA;IACzB;;;;OAIG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAA;IAC3B;;;;OAIG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAA;IAC5B;;;;OAIG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,yBAAyB,CAAA;IAClD;;;;OAIG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,mBAAmB,CAAA;IACtC;;;OAGG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,eAAe,CAAA;IACrC;;;;;OAKG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,CAAA;IACzB;;;OAGG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,SAAS,EAAE,CAAA;IAC5B;;;OAGG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;IACxB;;;;OAIG;IACH,QAAQ,CAAC,cAAc,EAAE,0BAA0B,CAAA;IACnD;;;;OAIG;IACH,QAAQ,CAAC,OAAO,EAAE,mBAAmB,CAAA;CACtC"}
@@ -0,0 +1,109 @@
1
+ /**
2
+ * Code generated by [commercetools RMF-Codegen](https://github.com/commercetools/rmf-codegen). DO NOT EDIT.
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
+ * For more information about the commercetools platform APIs, visit https://docs.commercetools.com/.
5
+ */
6
+ import { ImportResource, LocalizedString, ProductKeyReference } from "./common.js";
7
+ import { Custom } from "./customfields.js";
8
+ /**
9
+ * Defines how variants are selected for the product.
10
+ *
11
+ */
12
+ export declare enum VariantSelectionTypeValues {
13
+ IncludeAllExcept = "includeAllExcept",
14
+ IncludeOnly = "includeOnly"
15
+ }
16
+ export type VariantSelectionType = 'includeAllExcept' | 'includeOnly' | (string & {});
17
+ /**
18
+ * Variant selection specifying how variants are included or excluded.
19
+ *
20
+ */
21
+ export interface VariantSelection {
22
+ /**
23
+ * Type of variant selection.
24
+ *
25
+ */
26
+ readonly type: VariantSelectionType;
27
+ /**
28
+ * List of SKUs to include or exclude.
29
+ *
30
+ *
31
+ */
32
+ readonly skus?: string[];
33
+ }
34
+ /**
35
+ * Defines which Variants of the Product will be excluded from the Product Selection. If not supplied all Variants are deemed to be excluded.
36
+ *
37
+ */
38
+ export interface VariantExclusion {
39
+ /**
40
+ * List of SKUs to be excluded.
41
+ *
42
+ *
43
+ */
44
+ readonly skus?: string[];
45
+ }
46
+ /**
47
+ * An assignment of a product and either variantSelection or variantExclusion (not both).
48
+ *
49
+ */
50
+ export interface ProductSelectionAssignment {
51
+ /**
52
+ * Reference to the Product by key.
53
+ *
54
+ */
55
+ readonly product: ProductKeyReference;
56
+ /**
57
+ * Variant selection specifying included SKUs.
58
+ *
59
+ */
60
+ readonly variantSelection?: VariantSelection;
61
+ /**
62
+ * Variant exclusion specifying excluded SKUs.
63
+ *
64
+ */
65
+ readonly variantExclusion?: VariantExclusion;
66
+ }
67
+ /**
68
+ * Product Selections can have the following modes:
69
+ * - `Individual`: Products must be explicitly assigned.
70
+ * - `IndividualExclusion`: Products are included unless explicitly excluded.
71
+ *
72
+ */
73
+ export declare enum ProductSelectionModeValues {
74
+ Individual = "Individual",
75
+ IndividualExclusion = "IndividualExclusion"
76
+ }
77
+ export type ProductSelectionMode = 'Individual' | 'IndividualExclusion' | (string & {});
78
+ /**
79
+ * Represents the data used to import a ProductSelection. Once imported, this data is persisted as a [ProductSelection](ctp:api:type:ProductSelection) in the Project.
80
+ *
81
+ */
82
+ export interface ProductSelectionImport extends ImportResource {
83
+ /**
84
+ * User-defined unique identifier. If an [ProductSelection](ctp:api:type:ProductSelection) with this `key` exists, it is updated with the imported data.
85
+ *
86
+ */
87
+ readonly key: string;
88
+ /**
89
+ * Maps to `ProductSelection.name`.
90
+ *
91
+ */
92
+ readonly name: LocalizedString;
93
+ /**
94
+ * Maps to `ProductSelection.mode`.
95
+ *
96
+ */
97
+ readonly mode?: ProductSelectionMode;
98
+ /**
99
+ * Maps to `ProductSelection.custom`.
100
+ *
101
+ */
102
+ readonly custom?: Custom;
103
+ /**
104
+ * List of product assignments.
105
+ *
106
+ */
107
+ readonly assignments?: ProductSelectionAssignment[];
108
+ }
109
+ //# sourceMappingURL=product-selections.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"product-selections.d.ts","sourceRoot":"../../../../../src/generated/models","sources":["product-selections.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,mBAAmB,EAAE,oBAAgB;AAC/E,OAAO,EAAE,MAAM,EAAE,0BAAsB;AAEvC;;;GAGG;AACH,oBAAY,0BAA0B;IACpC,gBAAgB,qBAAqB;IACrC,WAAW,gBAAgB;CAC5B;AAED,MAAM,MAAM,oBAAoB,GAC5B,kBAAkB,GAClB,aAAa,GACb,CAAC,MAAM,GAAG,EAAE,CAAC,CAAA;AACjB;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;;OAGG;IACH,QAAQ,CAAC,IAAI,EAAE,oBAAoB,CAAA;IACnC;;;;OAIG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;CACzB;AACD;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;;;OAIG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;CACzB;AACD;;;GAGG;AACH,MAAM,WAAW,0BAA0B;IACzC;;;OAGG;IACH,QAAQ,CAAC,OAAO,EAAE,mBAAmB,CAAA;IACrC;;;OAGG;IACH,QAAQ,CAAC,gBAAgB,CAAC,EAAE,gBAAgB,CAAA;IAC5C;;;OAGG;IACH,QAAQ,CAAC,gBAAgB,CAAC,EAAE,gBAAgB,CAAA;CAC7C;AACD;;;;;GAKG;AACH,oBAAY,0BAA0B;IACpC,UAAU,eAAe;IACzB,mBAAmB,wBAAwB;CAC5C;AAED,MAAM,MAAM,oBAAoB,GAC5B,YAAY,GACZ,qBAAqB,GACrB,CAAC,MAAM,GAAG,EAAE,CAAC,CAAA;AACjB;;;GAGG;AACH,MAAM,WAAW,sBAAuB,SAAQ,cAAc;IAC5D;;;OAGG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;IACpB;;;OAGG;IACH,QAAQ,CAAC,IAAI,EAAE,eAAe,CAAA;IAC9B;;;OAGG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,oBAAoB,CAAA;IACpC;;;OAGG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;IACxB;;;OAGG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,0BAA0B,EAAE,CAAA;CACpD"}
@@ -13,124 +13,86 @@ import { Attribute } from "./productvariants.js";
13
13
  */
14
14
  export interface ProductDraftImport extends ImportResource {
15
15
  /**
16
- * User-defined unique identifier. If a [Product](ctp:api:type:Product) with this `key` exists, it will be updated with the imported data.
16
+ * User-defined unique identifier. If a [Product](ctp:api:type:Product) with this `key` exists, it is updated with the imported data.
17
17
  *
18
18
  */
19
19
  readonly key: string;
20
20
  /**
21
- * The `productType` of a [Product](ctp:api:type:Product).
22
- * Maps to `Product.productType`.
23
- * The Reference to the [ProductType](ctp:api:type:ProductType) with which the ProductDraft is associated.
24
- * If referenced ProductType does not exist, the `state` of the [ImportOperation](ctp:import:type:ImportOperation) will be set to `unresolved` until the necessary ProductType is created.
21
+ * Maps to `Product.productType`. If the referenced [ProductType](ctp:api:type:ProductType) does not exist, the `state` of the [ImportOperation](ctp:import:type:ImportOperation) will be set to `unresolved` until the referenced ProductType is created.
25
22
  *
26
23
  *
27
24
  */
28
25
  readonly productType: ProductTypeKeyReference;
29
26
  /**
27
+ * Maps to `ProductData.name`.
30
28
  *
31
29
  */
32
30
  readonly name: LocalizedString;
33
31
  /**
34
- * Human-readable identifiers usually used as deep-link URL to the related product. Each slug must be unique across a project,
35
- * but a product can have the same slug for different languages. Allowed are alphabetic, numeric, underscore (_) and hyphen (-) characters.
36
- *
32
+ * Maps to `ProductData.slug`.
37
33
  *
38
34
  */
39
35
  readonly slug: LocalizedString;
40
36
  /**
41
- * Maps to `Product.description`.
37
+ * Maps to `ProductData.description`.
42
38
  *
43
39
  *
44
40
  */
45
41
  readonly description?: LocalizedString;
46
42
  /**
47
- * The Reference to the [Categories](ctp:api:type:Category) with which the ProductDraft is associated.
48
- * If referenced Categories do not exist, the `state` of the [ImportOperation](ctp:import:type:ImportOperation) will be set to `unresolved` until the necessary Categories are created.
43
+ * Maps to `ProductData.categories`. If the referenced [Categories](ctp:api:type:Category) do not exist, the `state` of the [ImportOperation](ctp:import:type:ImportOperation) will be set to `unresolved` until the referenced Categories are created.
49
44
  *
50
45
  *
51
46
  */
52
47
  readonly categories?: CategoryKeyReference[];
53
48
  /**
54
- * 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.
55
- * ```json
56
- * {
57
- * "de": "Hundefutter",
58
- * "en": "dog food"
59
- * }
60
- * ```
49
+ *
50
+ */
51
+ readonly attributes?: Attribute[];
52
+ /**
53
+ * Maps to `ProductData.metaTitle`.
61
54
  *
62
55
  *
63
56
  */
64
57
  readonly metaTitle?: LocalizedString;
65
58
  /**
66
- * 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.
67
- * ```json
68
- * {
69
- * "de": "Hundefutter",
70
- * "en": "dog food"
71
- * }
72
- * ```
59
+ * Maps to `ProductData.metaDescription`.
73
60
  *
74
61
  *
75
62
  */
76
63
  readonly metaDescription?: LocalizedString;
77
64
  /**
78
- * 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.
79
- * ```json
80
- * {
81
- * "de": "Hundefutter",
82
- * "en": "dog food"
83
- * }
84
- * ```
65
+ * Maps to `ProductData.metaKeywords`.
85
66
  *
86
67
  *
87
68
  */
88
69
  readonly metaKeywords?: LocalizedString;
89
70
  /**
90
- * The master Product variant.
91
- * Required if the `variants` array contains a Product Variant.
71
+ * The master ProductVariant.
72
+ * Required if `variants` contains at least one ProductVariant.
92
73
  *
93
74
  *
94
75
  */
95
76
  readonly masterVariant?: ProductVariantDraftImport;
96
77
  /**
97
- * An array of related Product Variants.
78
+ * An array of related ProductVariants.
98
79
  *
99
80
  */
100
81
  readonly variants?: ProductVariantDraftImport[];
101
82
  /**
102
- * The Reference to the [TaxCategory](/projects/taxCategories#taxcategory) with which the ProductDraft is associated.
103
- * If referenced TaxCategory does not exist, the `state` of the [ImportOperation](ctp:import:type:ImportOperation) will be set to `unresolved` until the necessary TaxCategory is created.
83
+ * Maps to `Product.taxCategory`. If the referenced [TaxCategory](ctp:api:type:TaxCategory) does not exist, the `state` of the [ImportOperation](ctp:import:type:ImportOperation) will be set to `unresolved` until the referenced TaxCategory is created.
104
84
  *
105
85
  *
106
86
  */
107
87
  readonly taxCategory?: TaxCategoryKeyReference;
108
88
  /**
109
- * Search keywords are primarily used by the suggester but are also considered for the full-text search. SearchKeywords is a JSON object where the keys are of [IETF language tag](https://en.wikipedia.org/wiki/IETF_language_tag). The value to a language tag key is an array of SearchKeyword for the specific language.
110
- * ```json
111
- * {
112
- * "en": [
113
- * { "text": "Multi tool" },
114
- * { "text": "Swiss Army Knife", "suggestTokenizer": { "type": "whitespace" } }
115
- * ],
116
- * "de": [
117
- * {
118
- * "text": "Schweizer Messer",
119
- * "suggestTokenizer": {
120
- * "type": "custom",
121
- * "inputs": ["schweizer messer", "offiziersmesser", "sackmesser"]
122
- * }
123
- * }
124
- * ]
125
- * }
126
- * ```
89
+ * Maps to `ProductData.searchKeywords`.
127
90
  *
128
91
  *
129
92
  */
130
93
  readonly searchKeywords?: SearchKeywords;
131
94
  /**
132
- * The Reference to the [State](/projects/states#state) with which the ProductDraft is associated.
133
- * If referenced State does not exist, the `state` of the [ImportOperation](ctp:import:type:ImportOperation) will be set to `unresolved` until the necessary State is created.
95
+ * Maps to `Product.state`. If the referenced [State](ctp:api:type:State) does not exist, the `state` of the [ImportOperation](ctp:import:type:ImportOperation) will be set to `unresolved` until the referenced State is created.
134
96
  *
135
97
  *
136
98
  */
@@ -142,7 +104,7 @@ export interface ProductDraftImport extends ImportResource {
142
104
  */
143
105
  readonly publish?: boolean;
144
106
  /**
145
- * Determines the type of Prices the API uses. If not provided, the existing `Product.priceMode` is not changed.
107
+ * Maps to `Product.priceMode`. If not provided, the existing `Product.priceMode` is not changed.
146
108
  *
147
109
  *
148
110
  */
@@ -154,26 +116,39 @@ export interface ProductDraftImport extends ImportResource {
154
116
  */
155
117
  export interface ProductVariantDraftImport {
156
118
  /**
119
+ * User-defined unique SKU of the Product Variant.
120
+ *
157
121
  *
158
122
  */
159
123
  readonly sku?: string;
160
124
  /**
125
+ * User-defined unique identifier for the ProductVariant.
126
+ *
161
127
  *
162
128
  */
163
129
  readonly key: string;
164
130
  /**
131
+ * The Embedded Prices for the Product Variant.
132
+ * Each Price must have its unique Price scope (with same currency, country, Customer Group, Channel, `validFrom` and `validUntil`).
133
+ *
165
134
  *
166
135
  */
167
136
  readonly prices?: PriceDraftImport[];
168
137
  /**
138
+ * Attributes according to the respective AttributeDefinition.
139
+ *
169
140
  *
170
141
  */
171
142
  readonly attributes?: Attribute[];
172
143
  /**
144
+ * Images for the Product Variant.
145
+ *
173
146
  *
174
147
  */
175
148
  readonly images?: Image[];
176
149
  /**
150
+ * Media assets for the Product Variant.
151
+ *
177
152
  *
178
153
  */
179
154
  readonly assets?: Asset[];
@@ -184,40 +159,42 @@ export interface ProductVariantDraftImport {
184
159
  */
185
160
  export interface PriceDraftImport {
186
161
  /**
162
+ * Money value of this Price.
187
163
  *
188
164
  */
189
165
  readonly value: TypedMoney;
190
166
  /**
191
- * A two-digit country code as per [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
192
- *
167
+ * Set this field if this Price is only valid for the specified country.
193
168
  *
194
169
  */
195
170
  readonly country?: string;
196
171
  /**
197
- * References a customer group by key.
172
+ * Set this field if this Price is only valid for the referenced [CustomerGroup](ctp:api:type:CustomerGroup). If the referenced CustomerGroup does not exist, the `state` of the [ImportOperation](ctp:import:type:ImportOperation) will be set to `unresolved` until the referenced CustomerGroup is created.
198
173
  *
199
174
  */
200
175
  readonly customerGroup?: CustomerGroupKeyReference;
201
176
  /**
202
- * References a channel by key.
177
+ * Set this field if this Price is only valid for the referenced `ProductDistribution` [Channel](ctp:api:type:Channel). If the referenced Channel does not exist, the `state` of the [ImportOperation](ctp:import:type:ImportOperation) will be set to `unresolved` until the referenced Channel is created.
203
178
  *
204
179
  */
205
180
  readonly channel?: ChannelKeyReference;
206
181
  /**
182
+ * Set this field if this Price is only valid from the specified date and time. Must be at least 1 ms earlier than `validUntil`.
207
183
  *
208
184
  */
209
185
  readonly validFrom?: string;
210
186
  /**
187
+ * Set this field if this Price is only valid until the specified date and time. Must be at least 1 ms later than `validFrom`.
211
188
  *
212
189
  */
213
190
  readonly validUntil?: string;
214
191
  /**
215
- * The custom fields for this category.
192
+ * Custom Fields for the Embedded Price.
216
193
  *
217
194
  */
218
195
  readonly custom?: Custom;
219
196
  /**
220
- * Sets a discounted price from an external service.
197
+ * Set this field to add a DiscountedPrice from an **external service**.
221
198
  *
222
199
  */
223
200
  readonly discounted?: DiscountedPrice;
@@ -1 +1 @@
1
- {"version":3,"file":"productdrafts.d.ts","sourceRoot":"../../../../../src/generated/models","sources":["productdrafts.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EACL,KAAK,EACL,oBAAoB,EACpB,mBAAmB,EACnB,yBAAyB,EACzB,eAAe,EACf,KAAK,EACL,cAAc,EACd,eAAe,EACf,SAAS,EACT,oBAAoB,EACpB,uBAAuB,EACvB,iBAAiB,EACjB,uBAAuB,EACvB,UAAU,EACX,oBAAgB;AACjB,OAAO,EAAE,MAAM,EAAE,0BAAsB;AACvC,OAAO,EAAE,cAAc,EAAE,sBAAkB;AAC3C,OAAO,EAAE,SAAS,EAAE,6BAAyB;AAE7C;;;GAGG;AACH,MAAM,WAAW,kBAAmB,SAAQ,cAAc;IACxD;;;OAGG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;IACpB;;;;;;;OAOG;IACH,QAAQ,CAAC,WAAW,EAAE,uBAAuB,CAAA;IAC7C;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,eAAe,CAAA;IAC9B;;;;;OAKG;IACH,QAAQ,CAAC,IAAI,EAAE,eAAe,CAAA;IAC9B;;;;OAIG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,eAAe,CAAA;IACtC;;;;;OAKG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,oBAAoB,EAAE,CAAA;IAC5C;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,eAAe,CAAA;IACpC;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,eAAe,CAAC,EAAE,eAAe,CAAA;IAC1C;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,eAAe,CAAA;IACvC;;;;;OAKG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,yBAAyB,CAAA;IAClD;;;OAGG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,yBAAyB,EAAE,CAAA;IAC/C;;;;;OAKG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,uBAAuB,CAAA;IAC9C;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,QAAQ,CAAC,cAAc,CAAC,EAAE,cAAc,CAAA;IACxC;;;;;OAKG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,iBAAiB,CAAA;IAClC;;;;OAIG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAA;IAC1B;;;;OAIG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,oBAAoB,CAAA;CAC1C;AACD;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAA;IACrB;;OAEG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,gBAAgB,EAAE,CAAA;IACpC;;OAEG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,SAAS,EAAE,CAAA;IACjC;;OAEG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,CAAA;IACzB;;OAEG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,CAAA;CAC1B;AACD;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,UAAU,CAAA;IAC1B;;;;OAIG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAA;IACzB;;;OAGG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,yBAAyB,CAAA;IAClD;;;OAGG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,mBAAmB,CAAA;IACtC;;OAEG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAA;IAC3B;;OAEG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAA;IAC5B;;;OAGG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;IACxB;;;OAGG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,eAAe,CAAA;IACrC;;;OAGG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,SAAS,EAAE,CAAA;IAC5B;;;;OAIG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;CACrB"}
1
+ {"version":3,"file":"productdrafts.d.ts","sourceRoot":"../../../../../src/generated/models","sources":["productdrafts.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EACL,KAAK,EACL,oBAAoB,EACpB,mBAAmB,EACnB,yBAAyB,EACzB,eAAe,EACf,KAAK,EACL,cAAc,EACd,eAAe,EACf,SAAS,EACT,oBAAoB,EACpB,uBAAuB,EACvB,iBAAiB,EACjB,uBAAuB,EACvB,UAAU,EACX,oBAAgB;AACjB,OAAO,EAAE,MAAM,EAAE,0BAAsB;AACvC,OAAO,EAAE,cAAc,EAAE,sBAAkB;AAC3C,OAAO,EAAE,SAAS,EAAE,6BAAyB;AAE7C;;;GAGG;AACH,MAAM,WAAW,kBAAmB,SAAQ,cAAc;IACxD;;;OAGG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;IACpB;;;;OAIG;IACH,QAAQ,CAAC,WAAW,EAAE,uBAAuB,CAAA;IAC7C;;;OAGG;IACH,QAAQ,CAAC,IAAI,EAAE,eAAe,CAAA;IAC9B;;;OAGG;IACH,QAAQ,CAAC,IAAI,EAAE,eAAe,CAAA;IAC9B;;;;OAIG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,eAAe,CAAA;IACtC;;;;OAIG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,oBAAoB,EAAE,CAAA;IAC5C;;OAEG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,SAAS,EAAE,CAAA;IACjC;;;;OAIG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,eAAe,CAAA;IACpC;;;;OAIG;IACH,QAAQ,CAAC,eAAe,CAAC,EAAE,eAAe,CAAA;IAC1C;;;;OAIG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,eAAe,CAAA;IACvC;;;;;OAKG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,yBAAyB,CAAA;IAClD;;;OAGG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,yBAAyB,EAAE,CAAA;IAC/C;;;;OAIG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,uBAAuB,CAAA;IAC9C;;;;OAIG;IACH,QAAQ,CAAC,cAAc,CAAC,EAAE,cAAc,CAAA;IACxC;;;;OAIG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,iBAAiB,CAAA;IAClC;;;;OAIG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAA;IAC1B;;;;OAIG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,oBAAoB,CAAA;CAC1C;AACD;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACxC;;;;OAIG;IACH,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAA;IACrB;;;;OAIG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;IACpB;;;;;OAKG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,gBAAgB,EAAE,CAAA;IACpC;;;;OAIG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,SAAS,EAAE,CAAA;IACjC;;;;OAIG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,CAAA;IACzB;;;;OAIG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,CAAA;CAC1B;AACD;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;;OAGG;IACH,QAAQ,CAAC,KAAK,EAAE,UAAU,CAAA;IAC1B;;;OAGG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAA;IACzB;;;OAGG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,yBAAyB,CAAA;IAClD;;;OAGG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,mBAAmB,CAAA;IACtC;;;OAGG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAA;IAC3B;;;OAGG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAA;IAC5B;;;OAGG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;IACxB;;;OAGG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,eAAe,CAAA;IACrC;;;OAGG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,SAAS,EAAE,CAAA;IAC5B;;;;OAIG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;CACrB"}
@@ -4,6 +4,7 @@
4
4
  * For more information about the commercetools platform APIs, visit https://docs.commercetools.com/.
5
5
  */
6
6
  import { CategoryKeyReference, ImportResource, LocalizedString, ProductPriceModeEnum, ProductTypeKeyReference, StateKeyReference, TaxCategoryKeyReference } from "./common.js";
7
+ import { Attribute } from "./productvariants.js";
7
8
  /**
8
9
  * Search keywords are primarily used by the suggester but are also considered for the full-text search. SearchKeywords is a JSON object where the keys are of [IETF language tag](https://en.wikipedia.org/wiki/IETF_language_tag). The value to a language tag key is an array of SearchKeyword for the specific language.
9
10
  * ```json
@@ -34,13 +35,13 @@ export interface SearchKeyword {
34
35
  */
35
36
  readonly text: string;
36
37
  /**
37
- * The tokenizer defines the tokens that are used to match against the [Suggest Query](/../products-suggestions#query-suggestions) input.
38
+ * The tokenizer defines the tokens that are used for [search term suggestions](/projects/search-term-suggestions).
38
39
  *
39
40
  */
40
41
  readonly suggestTokenizer?: SuggestTokenizer;
41
42
  }
42
43
  /**
43
- * The tokenizer defines the tokens that are used to match against the [Suggest Query](/../products-suggestions#query-suggestions) input.
44
+ * The tokenizer defines the tokens that are used for [search term suggestions](/projects/search-term-suggestions).
44
45
  *
45
46
  */
46
47
  export type SuggestTokenizer = CustomTokenizer | WhitespaceTokenizer;
@@ -61,122 +62,83 @@ export interface WhitespaceTokenizer extends ISuggestTokenizer {
61
62
  readonly type: 'whitespace';
62
63
  }
63
64
  /**
64
- * The data representation for a Product to be imported that is persisted as a [Product](ctp:api:type:Product) in the Project.
65
+ * Represents the data used to import a Product. Once imported, this data is persisted as a [Product](ctp:api:type:Product) in the Project.
65
66
  *
66
- * This is the minimal representation required for creating a [Product](ctp:api:type:Product) in commercetools.
67
+ * This is the minimal representation required for creating a Product in Composable Commerce.
67
68
  *
68
69
  */
69
70
  export interface ProductImport extends ImportResource {
70
71
  /**
71
- * User-defined unique identifier. If a [Product](ctp:api:type:Product) with this `key` exists, it will be updated with the imported data.
72
+ * User-defined unique identifier. If a [Product](ctp:api:type:Product) with this `key` exists, it is updated with the imported data.
72
73
  *
73
74
  */
74
75
  readonly key: string;
75
76
  /**
76
- * Maps to `Product.name`.
77
+ * Maps to `ProductData.name`.
77
78
  *
78
79
  *
79
80
  */
80
81
  readonly name: LocalizedString;
81
82
  /**
82
- * The `productType` of a [Product](ctp:api:type:Product).
83
- * Maps to `Product.productType`.
84
- * The Reference to the [ProductType](ctp:api:type:ProductType) with which the Product is associated.
85
- * If referenced ProductType does not exist, the `state` of the [ImportOperation](ctp:import:type:ImportOperation) will be set to `unresolved` until the necessary ProductType is created.
83
+ * Maps to `Product.productType`. If the referenced [ProductType](ctp:api:type:ProductType) does not exist, the `state` of the [ImportOperation](ctp:import:type:ImportOperation) will be set to `unresolved` until the referenced ProductType is created.
86
84
  *
87
85
  *
88
86
  */
89
87
  readonly productType: ProductTypeKeyReference;
90
88
  /**
91
- * Human-readable identifiers usually used as deep-link URL to the related product. Each slug must be unique across a Project,
92
- * but a product can have the same slug for different languages. Allowed are alphabetic, numeric, underscore (_) and hyphen (-) characters.
89
+ * Maps to `ProductData.slug`.
93
90
  *
94
91
  *
95
92
  */
96
93
  readonly slug: LocalizedString;
97
94
  /**
98
- * Maps to `Product.description`.
95
+ * Maps to `ProductData.description`.
99
96
  *
100
97
  *
101
98
  */
102
99
  readonly description?: LocalizedString;
103
100
  /**
104
- * Maps to `Product.categories`.
105
- * The References to the [Categories](ctp:api:type:Category) with which the Product is associated.
106
- * If referenced Categories do not exist, the `state` of the [ImportOperation](ctp:import:type:ImportOperation) will be set to `unresolved` until the necessary Categories are created.
101
+ * Maps to `ProductData.categories`. If the referenced [Categories](ctp:api:type:Category) do not exist, the `state` of the [ImportOperation](ctp:import:type:ImportOperation) will be set to `unresolved` until the referenced Categories are created.
107
102
  *
108
103
  *
109
104
  */
110
105
  readonly categories?: CategoryKeyReference[];
111
106
  /**
112
- * 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.
113
- * ```json
114
- * {
115
- * "de": "Hundefutter",
116
- * "en": "dog food"
117
- * }
118
- * ```
107
+ *
108
+ */
109
+ readonly attributes?: Attribute[];
110
+ /**
111
+ * Maps to `ProductData.metaTitle`.
119
112
  *
120
113
  *
121
114
  */
122
115
  readonly metaTitle?: LocalizedString;
123
116
  /**
124
- * 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.
125
- * ```json
126
- * {
127
- * "de": "Hundefutter",
128
- * "en": "dog food"
129
- * }
130
- * ```
117
+ * Maps to `ProductData.metaDescription`.
131
118
  *
132
119
  *
133
120
  */
134
121
  readonly metaDescription?: LocalizedString;
135
122
  /**
136
- * 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.
137
- * ```json
138
- * {
139
- * "de": "Hundefutter",
140
- * "en": "dog food"
141
- * }
142
- * ```
123
+ * Maps to `ProductData.metaKeywords`.
143
124
  *
144
125
  *
145
126
  */
146
127
  readonly metaKeywords?: LocalizedString;
147
128
  /**
148
- * The Reference to the [TaxCategory](/projects/taxCategories#taxcategory) with which the Product is associated.
149
- * If referenced TaxCategory does not exist, the `state` of the [ImportOperation](ctp:import:type:ImportOperation) will be set to `unresolved` until the necessary TaxCategory is created.
129
+ * Maps to `Product.taxCategory`. If the referenced [TaxCategory](ctp:api:type:TaxCategory) does not exist, the `state` of the [ImportOperation](ctp:import:type:ImportOperation) will be set to `unresolved` until the referenced TaxCategory is created.
150
130
  *
151
131
  *
152
132
  */
153
133
  readonly taxCategory?: TaxCategoryKeyReference;
154
134
  /**
155
- * Search keywords are primarily used by the suggester but are also considered for the full-text search. SearchKeywords is a JSON object where the keys are of [IETF language tag](https://en.wikipedia.org/wiki/IETF_language_tag). The value to a language tag key is an array of SearchKeyword for the specific language.
156
- * ```json
157
- * {
158
- * "en": [
159
- * { "text": "Multi tool" },
160
- * { "text": "Swiss Army Knife", "suggestTokenizer": { "type": "whitespace" } }
161
- * ],
162
- * "de": [
163
- * {
164
- * "text": "Schweizer Messer",
165
- * "suggestTokenizer": {
166
- * "type": "custom",
167
- * "inputs": ["schweizer messer", "offiziersmesser", "sackmesser"]
168
- * }
169
- * }
170
- * ]
171
- * }
172
- * ```
135
+ * Maps to `ProductData.searchKeywords`.
173
136
  *
174
137
  *
175
138
  */
176
139
  readonly searchKeywords?: SearchKeywords;
177
140
  /**
178
- * The Reference to the [State](/projects/states#state) with which the Product is associated.
179
- * If referenced State does not exist, the `state` of the [ImportOperation](ctp:import:type:ImportOperation) will be set to `unresolved` until the necessary State is created.
141
+ * Maps to `Product.state`. If the referenced [State](ctp:api:type:State) does not exist, the `state` of the [ImportOperation](ctp:import:type:ImportOperation) will be set to `unresolved` until the referenced State is created.
180
142
  *
181
143
  *
182
144
  */
@@ -188,7 +150,7 @@ export interface ProductImport extends ImportResource {
188
150
  */
189
151
  readonly publish?: boolean;
190
152
  /**
191
- * Determines the type of Prices the API uses. If not provided, the existing `Product.priceMode` is not changed.
153
+ * Maps to `Product.priceMode`.
192
154
  *
193
155
  *
194
156
  */
@@ -1 +1 @@
1
- {"version":3,"file":"products.d.ts","sourceRoot":"../../../../../src/generated/models","sources":["products.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EACL,oBAAoB,EACpB,cAAc,EACd,eAAe,EACf,oBAAoB,EACpB,uBAAuB,EACvB,iBAAiB,EACjB,uBAAuB,EACxB,oBAAgB;AAEjB;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,WAAW,cAAc;IAC7B,CAAC,GAAG,EAAE,MAAM,GAAG,aAAa,EAAE,CAAA;CAC/B;AACD,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB;;;OAGG;IACH,QAAQ,CAAC,gBAAgB,CAAC,EAAE,gBAAgB,CAAA;CAC7C;AACD;;;GAGG;AACH,MAAM,MAAM,gBAAgB,GAAG,eAAe,GAAG,mBAAmB,CAAA;AACpE,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;CACtB;AACD,MAAM,WAAW,eAAgB,SAAQ,iBAAiB;IACxD,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAA;IACvB;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,CAAA;CAC1B;AACD,MAAM,WAAW,mBAAoB,SAAQ,iBAAiB;IAC5D,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAA;CAC5B;AACD;;;;;GAKG;AACH,MAAM,WAAW,aAAc,SAAQ,cAAc;IACnD;;;OAGG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;IACpB;;;;OAIG;IACH,QAAQ,CAAC,IAAI,EAAE,eAAe,CAAA;IAC9B;;;;;;;OAOG;IACH,QAAQ,CAAC,WAAW,EAAE,uBAAuB,CAAA;IAC7C;;;;;OAKG;IACH,QAAQ,CAAC,IAAI,EAAE,eAAe,CAAA;IAC9B;;;;OAIG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,eAAe,CAAA;IACtC;;;;;;OAMG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,oBAAoB,EAAE,CAAA;IAC5C;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,eAAe,CAAA;IACpC;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,eAAe,CAAC,EAAE,eAAe,CAAA;IAC1C;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,eAAe,CAAA;IACvC;;;;;OAKG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,uBAAuB,CAAA;IAC9C;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,QAAQ,CAAC,cAAc,CAAC,EAAE,cAAc,CAAA;IACxC;;;;;OAKG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,iBAAiB,CAAA;IAClC;;;;OAIG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAA;IAC1B;;;;OAIG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,oBAAoB,CAAA;CAC1C"}
1
+ {"version":3,"file":"products.d.ts","sourceRoot":"../../../../../src/generated/models","sources":["products.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EACL,oBAAoB,EACpB,cAAc,EACd,eAAe,EACf,oBAAoB,EACpB,uBAAuB,EACvB,iBAAiB,EACjB,uBAAuB,EACxB,oBAAgB;AACjB,OAAO,EAAE,SAAS,EAAE,6BAAyB;AAE7C;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,WAAW,cAAc;IAC7B,CAAC,GAAG,EAAE,MAAM,GAAG,aAAa,EAAE,CAAA;CAC/B;AACD,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB;;;OAGG;IACH,QAAQ,CAAC,gBAAgB,CAAC,EAAE,gBAAgB,CAAA;CAC7C;AACD;;;GAGG;AACH,MAAM,MAAM,gBAAgB,GAAG,eAAe,GAAG,mBAAmB,CAAA;AACpE,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;CACtB;AACD,MAAM,WAAW,eAAgB,SAAQ,iBAAiB;IACxD,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAA;IACvB;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,CAAA;CAC1B;AACD,MAAM,WAAW,mBAAoB,SAAQ,iBAAiB;IAC5D,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAA;CAC5B;AACD;;;;;GAKG;AACH,MAAM,WAAW,aAAc,SAAQ,cAAc;IACnD;;;OAGG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;IACpB;;;;OAIG;IACH,QAAQ,CAAC,IAAI,EAAE,eAAe,CAAA;IAC9B;;;;OAIG;IACH,QAAQ,CAAC,WAAW,EAAE,uBAAuB,CAAA;IAC7C;;;;OAIG;IACH,QAAQ,CAAC,IAAI,EAAE,eAAe,CAAA;IAC9B;;;;OAIG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,eAAe,CAAA;IACtC;;;;OAIG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,oBAAoB,EAAE,CAAA;IAC5C;;OAEG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,SAAS,EAAE,CAAA;IACjC;;;;OAIG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,eAAe,CAAA;IACpC;;;;OAIG;IACH,QAAQ,CAAC,eAAe,CAAC,EAAE,eAAe,CAAA;IAC1C;;;;OAIG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,eAAe,CAAA;IACvC;;;;OAIG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,uBAAuB,CAAA;IAC9C;;;;OAIG;IACH,QAAQ,CAAC,cAAc,CAAC,EAAE,cAAc,CAAA;IACxC;;;;OAIG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,iBAAiB,CAAA;IAClC;;;;OAIG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAA;IAC1B;;;;OAIG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,oBAAoB,CAAA;CAC1C"}