@commercetools/importapi-sdk 1.20.0 → 2.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (111) hide show
  1. package/CHANGELOG.md +33 -0
  2. package/README.md +100 -18
  3. package/dist/commercetools-importapi-sdk.browser.cjs.js +1964 -2190
  4. package/dist/commercetools-importapi-sdk.browser.esm.js +1964 -2190
  5. package/dist/commercetools-importapi-sdk.cjs.dev.js +1964 -2190
  6. package/dist/commercetools-importapi-sdk.cjs.prod.js +1964 -2190
  7. package/dist/commercetools-importapi-sdk.esm.js +1964 -2190
  8. package/dist/declarations/src/ctp/ctp-client.d.ts +2 -2
  9. package/dist/declarations/src/generated/client/api-root.d.ts +18 -18
  10. package/dist/declarations/src/generated/client/by-project-key-request-builder.d.ts +50 -52
  11. package/dist/declarations/src/generated/client/categories/by-project-key-categories-import-sink-key-by-import-sink-key-request-builder.d.ts +37 -37
  12. package/dist/declarations/src/generated/client/categories/by-project-key-categories-request-builder.d.ts +28 -28
  13. package/dist/declarations/src/generated/client/customers/by-project-key-customers-import-sink-key-by-import-sink-key-request-builder.d.ts +37 -37
  14. package/dist/declarations/src/generated/client/customers/by-project-key-customers-request-builder.d.ts +28 -28
  15. package/dist/declarations/src/generated/client/import-containers/by-project-key-categories-import-containers-by-import-container-key-request-builder.d.ts +35 -35
  16. package/dist/declarations/src/generated/client/import-containers/by-project-key-categories-import-containers-request-builder.d.ts +26 -26
  17. package/dist/declarations/src/generated/client/import-containers/by-project-key-customers-import-containers-by-import-container-key-request-builder.d.ts +35 -35
  18. package/dist/declarations/src/generated/client/import-containers/by-project-key-customers-import-containers-request-builder.d.ts +26 -26
  19. package/dist/declarations/src/generated/client/import-containers/by-project-key-import-containers-by-import-container-key-request-builder.d.ts +55 -55
  20. package/dist/declarations/src/generated/client/import-containers/by-project-key-import-containers-request-builder.d.ts +51 -51
  21. package/dist/declarations/src/generated/client/import-containers/by-project-key-order-patches-import-containers-by-import-container-key-request-builder.d.ts +35 -35
  22. package/dist/declarations/src/generated/client/import-containers/by-project-key-order-patches-import-containers-request-builder.d.ts +26 -26
  23. package/dist/declarations/src/generated/client/import-containers/by-project-key-orders-import-containers-by-import-container-key-request-builder.d.ts +35 -35
  24. package/dist/declarations/src/generated/client/import-containers/by-project-key-orders-import-containers-request-builder.d.ts +26 -26
  25. package/dist/declarations/src/generated/client/import-containers/by-project-key-prices-import-containers-by-import-container-key-request-builder.d.ts +35 -35
  26. package/dist/declarations/src/generated/client/import-containers/by-project-key-prices-import-containers-request-builder.d.ts +26 -26
  27. package/dist/declarations/src/generated/client/import-containers/by-project-key-product-drafts-import-containers-by-import-container-key-request-builder.d.ts +36 -36
  28. package/dist/declarations/src/generated/client/import-containers/by-project-key-product-drafts-import-containers-request-builder.d.ts +26 -26
  29. package/dist/declarations/src/generated/client/import-containers/by-project-key-product-types-import-containers-by-import-container-key-request-builder.d.ts +35 -35
  30. package/dist/declarations/src/generated/client/import-containers/by-project-key-product-types-import-containers-request-builder.d.ts +26 -26
  31. package/dist/declarations/src/generated/client/import-containers/by-project-key-product-variant-patches-import-containers-by-import-container-key-request-builder.d.ts +35 -35
  32. package/dist/declarations/src/generated/client/import-containers/by-project-key-product-variant-patches-import-containers-request-builder.d.ts +26 -26
  33. package/dist/declarations/src/generated/client/import-containers/by-project-key-product-variants-import-containers-by-import-container-key-request-builder.d.ts +35 -35
  34. package/dist/declarations/src/generated/client/import-containers/by-project-key-product-variants-import-containers-request-builder.d.ts +26 -26
  35. package/dist/declarations/src/generated/client/import-containers/by-project-key-products-import-containers-by-import-container-key-request-builder.d.ts +35 -35
  36. package/dist/declarations/src/generated/client/import-containers/by-project-key-products-import-containers-request-builder.d.ts +26 -26
  37. package/dist/declarations/src/generated/client/import-operations/by-project-key-categories-import-sink-key-by-import-sink-key-import-operations-by-id-request-builder.d.ts +37 -37
  38. package/dist/declarations/src/generated/client/import-operations/by-project-key-categories-import-sink-key-by-import-sink-key-import-operations-request-builder.d.ts +49 -49
  39. package/dist/declarations/src/generated/client/import-operations/by-project-key-customers-import-sink-key-by-import-sink-key-import-operations-by-id-request-builder.d.ts +37 -37
  40. package/dist/declarations/src/generated/client/import-operations/by-project-key-customers-import-sink-key-by-import-sink-key-import-operations-request-builder.d.ts +48 -48
  41. package/dist/declarations/src/generated/client/import-operations/by-project-key-import-containers-by-import-container-key-import-operations-request-builder.d.ts +45 -45
  42. package/dist/declarations/src/generated/client/import-operations/by-project-key-import-operations-by-id-request-builder.d.ts +35 -35
  43. package/dist/declarations/src/generated/client/import-operations/by-project-key-import-operations-request-builder.d.ts +26 -26
  44. package/dist/declarations/src/generated/client/import-operations/by-project-key-order-patches-import-sink-key-by-import-sink-key-import-operations-by-id-request-builder.d.ts +37 -37
  45. package/dist/declarations/src/generated/client/import-operations/by-project-key-order-patches-import-sink-key-by-import-sink-key-import-operations-request-builder.d.ts +48 -48
  46. package/dist/declarations/src/generated/client/import-operations/by-project-key-orders-import-sink-key-by-import-sink-key-import-operations-by-id-request-builder.d.ts +37 -37
  47. package/dist/declarations/src/generated/client/import-operations/by-project-key-orders-import-sink-key-by-import-sink-key-import-operations-request-builder.d.ts +48 -48
  48. package/dist/declarations/src/generated/client/import-operations/by-project-key-prices-import-sink-key-by-import-sink-key-import-operations-by-id-request-builder.d.ts +37 -37
  49. package/dist/declarations/src/generated/client/import-operations/by-project-key-prices-import-sink-key-by-import-sink-key-import-operations-request-builder.d.ts +48 -48
  50. package/dist/declarations/src/generated/client/import-operations/by-project-key-product-drafts-import-sink-key-by-import-sink-key-import-operations-by-id-request-builder.d.ts +37 -37
  51. package/dist/declarations/src/generated/client/import-operations/by-project-key-product-drafts-import-sink-key-by-import-sink-key-import-operations-request-builder.d.ts +48 -48
  52. package/dist/declarations/src/generated/client/import-operations/by-project-key-product-types-import-sink-key-by-import-sink-key-import-operations-by-id-request-builder.d.ts +37 -37
  53. package/dist/declarations/src/generated/client/import-operations/by-project-key-product-types-import-sink-key-by-import-sink-key-import-operations-request-builder.d.ts +48 -48
  54. package/dist/declarations/src/generated/client/import-operations/by-project-key-product-variant-patches-import-sink-key-by-import-sink-key-import-operations-by-id-request-builder.d.ts +37 -37
  55. package/dist/declarations/src/generated/client/import-operations/by-project-key-product-variant-patches-import-sink-key-by-import-sink-key-import-operations-request-builder.d.ts +48 -48
  56. package/dist/declarations/src/generated/client/import-operations/by-project-key-product-variants-import-sink-key-by-import-sink-key-import-operations-by-id-request-builder.d.ts +37 -37
  57. package/dist/declarations/src/generated/client/import-operations/by-project-key-product-variants-import-sink-key-by-import-sink-key-import-operations-request-builder.d.ts +48 -48
  58. package/dist/declarations/src/generated/client/import-operations/by-project-key-products-import-sink-key-by-import-sink-key-import-operations-by-id-request-builder.d.ts +37 -37
  59. package/dist/declarations/src/generated/client/import-operations/by-project-key-products-import-sink-key-by-import-sink-key-import-operations-request-builder.d.ts +48 -48
  60. package/dist/declarations/src/generated/client/import-sinks/by-project-key-import-sinks-by-import-sink-key-request-builder.d.ts +51 -51
  61. package/dist/declarations/src/generated/client/import-sinks/by-project-key-import-sinks-request-builder.d.ts +51 -51
  62. package/dist/declarations/src/generated/client/import-summaries/by-project-key-import-containers-by-import-container-key-import-summaries-request-builder.d.ts +35 -35
  63. package/dist/declarations/src/generated/client/import-summaries/by-project-key-import-summaries-import-sink-key-by-import-sink-key-request-builder.d.ts +37 -37
  64. package/dist/declarations/src/generated/client/import-summaries/by-project-key-import-summaries-request-builder.d.ts +26 -26
  65. package/dist/declarations/src/generated/client/order-patches/by-project-key-order-patches-import-sink-key-by-import-sink-key-request-builder.d.ts +37 -37
  66. package/dist/declarations/src/generated/client/order-patches/by-project-key-order-patches-request-builder.d.ts +28 -28
  67. package/dist/declarations/src/generated/client/orders/by-project-key-orders-import-sink-key-by-import-sink-key-request-builder.d.ts +37 -37
  68. package/dist/declarations/src/generated/client/orders/by-project-key-orders-request-builder.d.ts +28 -28
  69. package/dist/declarations/src/generated/client/prices/by-project-key-prices-import-sink-key-by-import-sink-key-request-builder.d.ts +37 -37
  70. package/dist/declarations/src/generated/client/prices/by-project-key-prices-request-builder.d.ts +28 -28
  71. package/dist/declarations/src/generated/client/product-drafts/by-project-key-product-drafts-import-sink-key-by-import-sink-key-request-builder.d.ts +38 -38
  72. package/dist/declarations/src/generated/client/product-drafts/by-project-key-product-drafts-request-builder.d.ts +28 -28
  73. package/dist/declarations/src/generated/client/product-types/by-project-key-product-types-import-sink-key-by-import-sink-key-request-builder.d.ts +37 -37
  74. package/dist/declarations/src/generated/client/product-types/by-project-key-product-types-request-builder.d.ts +28 -28
  75. package/dist/declarations/src/generated/client/product-variant-patches/by-project-key-product-variant-patches-import-sink-key-by-import-sink-key-request-builder.d.ts +37 -37
  76. package/dist/declarations/src/generated/client/product-variant-patches/by-project-key-product-variant-patches-request-builder.d.ts +28 -28
  77. package/dist/declarations/src/generated/client/product-variants/by-project-key-product-variants-import-sink-key-by-import-sink-key-request-builder.d.ts +37 -37
  78. package/dist/declarations/src/generated/client/product-variants/by-project-key-product-variants-request-builder.d.ts +28 -28
  79. package/dist/declarations/src/generated/client/products/by-project-key-products-import-sink-key-by-import-sink-key-request-builder.d.ts +37 -37
  80. package/dist/declarations/src/generated/client/products/by-project-key-products-request-builder.d.ts +28 -28
  81. package/dist/declarations/src/generated/index.d.ts +25 -26
  82. package/dist/declarations/src/generated/models/categories.d.ts +79 -79
  83. package/dist/declarations/src/generated/models/common.d.ts +570 -570
  84. package/dist/declarations/src/generated/models/customers.d.ts +252 -252
  85. package/dist/declarations/src/generated/models/customfields.d.ts +260 -260
  86. package/dist/declarations/src/generated/models/errors.d.ts +356 -352
  87. package/dist/declarations/src/generated/models/importcontainers.d.ts +114 -114
  88. package/dist/declarations/src/generated/models/importoperations.d.ts +128 -128
  89. package/dist/declarations/src/generated/models/importrequests.d.ts +161 -175
  90. package/dist/declarations/src/generated/models/importsinks.d.ts +113 -113
  91. package/dist/declarations/src/generated/models/importsummaries.d.ts +55 -55
  92. package/dist/declarations/src/generated/models/order-patches.d.ts +227 -227
  93. package/dist/declarations/src/generated/models/orders.d.ts +778 -778
  94. package/dist/declarations/src/generated/models/prices.d.ts +130 -130
  95. package/dist/declarations/src/generated/models/productdrafts.d.ts +226 -224
  96. package/dist/declarations/src/generated/models/products.d.ts +181 -179
  97. package/dist/declarations/src/generated/models/producttypes.d.ts +173 -173
  98. package/dist/declarations/src/generated/models/productvariants.d.ts +529 -527
  99. package/dist/declarations/src/generated/shared/utils/common-types.d.ts +26 -26
  100. package/dist/declarations/src/generated/shared/utils/middleware.d.ts +8 -8
  101. package/dist/declarations/src/generated/shared/utils/requests-utils.d.ts +13 -13
  102. package/dist/declarations/src/generated/shared/utils/uri-utils.d.ts +7 -7
  103. package/dist/declarations/src/index.d.ts +2 -2
  104. package/package.json +5 -6
  105. package/dist/declarations/src/generated/client/import-containers/by-project-key-inventories-import-containers-by-import-container-key-request-builder.d.ts +0 -35
  106. package/dist/declarations/src/generated/client/import-containers/by-project-key-inventories-import-containers-request-builder.d.ts +0 -26
  107. package/dist/declarations/src/generated/client/import-operations/by-project-key-inventories-import-sink-key-by-import-sink-key-import-operations-by-id-request-builder.d.ts +0 -37
  108. package/dist/declarations/src/generated/client/import-operations/by-project-key-inventories-import-sink-key-by-import-sink-key-import-operations-request-builder.d.ts +0 -48
  109. package/dist/declarations/src/generated/client/inventories/by-project-key-inventories-import-sink-key-by-import-sink-key-request-builder.d.ts +0 -37
  110. package/dist/declarations/src/generated/client/inventories/by-project-key-inventories-request-builder.d.ts +0 -28
  111. package/dist/declarations/src/generated/models/inventories.d.ts +0 -44
@@ -1,570 +1,570 @@
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 { Custom } from './customfields';
7
- export interface Asset {
8
- /**
9
- * User-defined identifier for the asset.
10
- * Asset keys are unique inside their container (a product variant or a category).
11
- *
12
- *
13
- */
14
- readonly key: string;
15
- /**
16
- *
17
- */
18
- readonly sources: AssetSource[];
19
- /**
20
- * 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.
21
- * ```json
22
- * {
23
- * "de": "Hundefutter",
24
- * "en": "dog food"
25
- * }
26
- * ```
27
- *
28
- *
29
- */
30
- readonly name: LocalizedString;
31
- /**
32
- * 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.
33
- * ```json
34
- * {
35
- * "de": "Hundefutter",
36
- * "en": "dog food"
37
- * }
38
- * ```
39
- *
40
- *
41
- */
42
- readonly description?: LocalizedString;
43
- /**
44
- *
45
- */
46
- readonly tags?: string[];
47
- /**
48
- * The representation to be sent to the server when creating a resource with custom fields.
49
- *
50
- */
51
- readonly custom?: Custom;
52
- }
53
- /**
54
- * The width and height of the Asset Source.
55
- */
56
- export interface AssetDimensions {
57
- /**
58
- * The width of the asset source.
59
- *
60
- */
61
- readonly w: number;
62
- /**
63
- * The height of the asset source.
64
- *
65
- */
66
- readonly h: number;
67
- }
68
- /**
69
- * An AssetSource is a representation of an Asset in a specific format, for example, a video in a certain encoding or an image in a certain resolution.
70
- */
71
- export interface AssetSource {
72
- /**
73
- *
74
- */
75
- readonly uri: string;
76
- /**
77
- *
78
- */
79
- readonly key?: string;
80
- /**
81
- * The width and height of the Asset Source.
82
- *
83
- */
84
- readonly dimensions?: AssetDimensions;
85
- /**
86
- *
87
- */
88
- readonly contentType?: string;
89
- }
90
- /**
91
- * An Image uploaded to the commercetools platform is stored in a Content Delivery Network and it's available in several pre-defined sizes. If you already have an image stored on an external service, you can save the URL when creating a new product or adding a variant, or you can add it later.
92
- */
93
- export interface Image {
94
- /**
95
- * URL of the image in its original size. The URL must be unique within a single variant. It can be used to obtain the image in different sizes.
96
- *
97
- */
98
- readonly url: string;
99
- /**
100
- * Dimensions of the original image. This can be used by your application, for example, to determine whether the image is large enough to display a zoom view.
101
- *
102
- */
103
- readonly dimensions: AssetDimensions;
104
- /**
105
- * Custom label that can be used, for example, as an image description.
106
- *
107
- */
108
- readonly label?: string;
109
- }
110
- export interface EnumValue {
111
- /**
112
- *
113
- */
114
- readonly key: string;
115
- /**
116
- *
117
- */
118
- readonly label: string;
119
- }
120
- export interface LocalizedEnumValue {
121
- /**
122
- *
123
- */
124
- readonly key: string;
125
- /**
126
- * 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.
127
- * ```json
128
- * {
129
- * "de": "Hundefutter",
130
- * "en": "dog food"
131
- * }
132
- * ```
133
- *
134
- *
135
- */
136
- readonly label: LocalizedString;
137
- }
138
- /**
139
- * 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.
140
- * ```json
141
- * {
142
- * "de": "Hundefutter",
143
- * "en": "dog food"
144
- * }
145
- * ```
146
- *
147
- */
148
- export interface LocalizedString {
149
- [key: string]: string;
150
- }
151
- /**
152
- * A representation of the resource to import.
153
- * Import resources are similar to commercetools draft types, but they only support key references.
154
- * In general, import resources are more granular then the normal commercetools resource.
155
- * They are optimized for incremental updates and therefore have a slightly different structure.
156
- *
157
- */
158
- export interface ImportResource {
159
- /**
160
- *
161
- */
162
- readonly key: string;
163
- }
164
- /**
165
- * References a resource by its key.
166
- */
167
- export declare type KeyReference = CartDiscountKeyReference | CartKeyReference | CategoryKeyReference | ChannelKeyReference | CustomObjectKeyReference | CustomerGroupKeyReference | CustomerKeyReference | DiscountCodeKeyReference | OrderKeyReference | PaymentKeyReference | PriceKeyReference | ProductDiscountKeyReference | ProductKeyReference | ProductTypeKeyReference | ProductVariantKeyReference | ShippingMethodKeyReference | StateKeyReference | StoreKeyReference | TaxCategoryKeyReference | TypeKeyReference;
168
- /**
169
- * References a cart by its key.
170
- */
171
- export interface CartKeyReference {
172
- readonly typeId: 'cart';
173
- /**
174
- *
175
- */
176
- readonly key: string;
177
- }
178
- /**
179
- * References a cart discount by its key.
180
- */
181
- export interface CartDiscountKeyReference {
182
- readonly typeId: 'cart-discount';
183
- /**
184
- *
185
- */
186
- readonly key: string;
187
- }
188
- /**
189
- * References a category by its key.
190
- */
191
- export interface CategoryKeyReference {
192
- readonly typeId: 'category';
193
- /**
194
- *
195
- */
196
- readonly key: string;
197
- }
198
- /**
199
- * References a channel by its key.
200
- */
201
- export interface ChannelKeyReference {
202
- readonly typeId: 'channel';
203
- /**
204
- *
205
- */
206
- readonly key: string;
207
- }
208
- /**
209
- * References a customer by its key.
210
- */
211
- export interface CustomerKeyReference {
212
- readonly typeId: 'customer';
213
- /**
214
- *
215
- */
216
- readonly key: string;
217
- }
218
- /**
219
- * References a customer group by its key.
220
- */
221
- export interface CustomerGroupKeyReference {
222
- readonly typeId: 'customer-group';
223
- /**
224
- *
225
- */
226
- readonly key: string;
227
- }
228
- /**
229
- * References a discount code by its key.
230
- */
231
- export interface DiscountCodeKeyReference {
232
- readonly typeId: 'discount-code';
233
- /**
234
- *
235
- */
236
- readonly key: string;
237
- }
238
- /**
239
- * References an order by its key.
240
- */
241
- export interface OrderKeyReference {
242
- readonly typeId: 'order';
243
- /**
244
- *
245
- */
246
- readonly key: string;
247
- }
248
- /**
249
- * References a payment by its key.
250
- */
251
- export interface PaymentKeyReference {
252
- readonly typeId: 'payment';
253
- /**
254
- *
255
- */
256
- readonly key: string;
257
- }
258
- /**
259
- * References a price by its key.
260
- */
261
- export interface PriceKeyReference {
262
- readonly typeId: 'price';
263
- /**
264
- *
265
- */
266
- readonly key: string;
267
- }
268
- /**
269
- * References a product by its key.
270
- */
271
- export interface ProductKeyReference {
272
- readonly typeId: 'product';
273
- /**
274
- *
275
- */
276
- readonly key: string;
277
- }
278
- /**
279
- * References a product discount by its key.
280
- */
281
- export interface ProductDiscountKeyReference {
282
- readonly typeId: 'product-discount';
283
- /**
284
- *
285
- */
286
- readonly key: string;
287
- }
288
- /**
289
- * References a product type by its key.
290
- */
291
- export interface ProductTypeKeyReference {
292
- readonly typeId: 'product-type';
293
- /**
294
- *
295
- */
296
- readonly key: string;
297
- }
298
- /**
299
- * References a product variant by its key.
300
- */
301
- export interface ProductVariantKeyReference {
302
- readonly typeId: 'product-variant';
303
- /**
304
- *
305
- */
306
- readonly key: string;
307
- }
308
- /**
309
- * References a shipping method by its key.
310
- */
311
- export interface ShippingMethodKeyReference {
312
- readonly typeId: 'shipping-method';
313
- /**
314
- *
315
- */
316
- readonly key: string;
317
- }
318
- /**
319
- * References a state by its key.
320
- */
321
- export interface StateKeyReference {
322
- readonly typeId: 'state';
323
- /**
324
- *
325
- */
326
- readonly key: string;
327
- }
328
- /**
329
- * References a store by its key.
330
- */
331
- export interface StoreKeyReference {
332
- readonly typeId: 'store';
333
- /**
334
- *
335
- */
336
- readonly key: string;
337
- }
338
- /**
339
- * References a tax category by its key.
340
- */
341
- export interface TaxCategoryKeyReference {
342
- readonly typeId: 'tax-category';
343
- /**
344
- *
345
- */
346
- readonly key: string;
347
- }
348
- /**
349
- * References a type by its key.
350
- */
351
- export interface TypeKeyReference {
352
- readonly typeId: 'type';
353
- /**
354
- *
355
- */
356
- readonly key: string;
357
- }
358
- /**
359
- * References a key value document by its key.
360
- */
361
- export interface CustomObjectKeyReference {
362
- readonly typeId: 'key-value-document';
363
- /**
364
- *
365
- */
366
- readonly key: string;
367
- /**
368
- *
369
- */
370
- readonly container: string;
371
- }
372
- export interface UnresolvedReferences {
373
- /**
374
- *
375
- */
376
- readonly key: string;
377
- /**
378
- * The type of the referenced resource.
379
- *
380
- *
381
- */
382
- readonly typeId: ReferenceType;
383
- }
384
- export declare type MoneyType = 'centPrecision' | 'highPrecision';
385
- export declare type TypedMoney = HighPrecisionMoney | Money;
386
- export interface HighPrecisionMoney {
387
- readonly type: 'highPrecision';
388
- /**
389
- *
390
- */
391
- readonly fractionDigits?: number;
392
- /**
393
- *
394
- */
395
- readonly centAmount: number;
396
- /**
397
- * The currency code compliant to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).
398
- *
399
- *
400
- */
401
- readonly currencyCode: string;
402
- /**
403
- *
404
- */
405
- readonly preciseAmount: number;
406
- }
407
- export interface Money {
408
- readonly type: 'centPrecision';
409
- /**
410
- *
411
- */
412
- readonly fractionDigits?: number;
413
- /**
414
- *
415
- */
416
- readonly centAmount: number;
417
- /**
418
- * The currency code compliant to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).
419
- *
420
- *
421
- */
422
- readonly currencyCode: string;
423
- }
424
- export interface DiscountedPrice {
425
- /**
426
- *
427
- */
428
- readonly value: TypedMoney;
429
- /**
430
- * Reference to a ProductDiscount.
431
- *
432
- */
433
- readonly discount: ProductDiscountKeyReference;
434
- }
435
- /**
436
- * A price tier is selected instead of the default price when a certain quantity of the ProductVariant is added to a cart and ordered.
437
- *
438
- */
439
- export interface PriceTier {
440
- /**
441
- * The minimum quantity this price tier is valid for.
442
- *
443
- *
444
- */
445
- readonly minimumQuantity: number;
446
- /**
447
- * The currency of a price tier is always the same as the currency of the base Price.
448
- *
449
- */
450
- readonly value: TypedMoney;
451
- }
452
- /**
453
- * The type of the import resource.
454
- *
455
- */
456
- export declare type ImportResourceType = 'category' | 'customer' | 'inventory' | 'order' | 'order-patch' | 'price' | 'product' | 'product-draft' | 'product-type' | 'product-variant' | 'product-variant-patch';
457
- /**
458
- * The type of the referenced resource.
459
- *
460
- */
461
- export declare type ReferenceType = 'cart' | 'cart-discount' | 'category' | 'channel' | 'customer' | 'customer-group' | 'discount-code' | 'key-value-document' | 'order' | 'payment' | 'price' | 'product' | 'product-discount' | 'product-type' | 'product-variant' | 'shipping-method' | 'state' | 'store' | 'tax-category' | 'type';
462
- /**
463
- * Every [Import Operation](/import-operation) is assigned with one of the following states.
464
- *
465
- */
466
- export declare type ProcessingState = 'imported' | 'processing' | 'rejected' | 'unresolved' | 'validationFailed' | 'waitForMasterVariant';
467
- export interface Address {
468
- /**
469
- *
470
- */
471
- readonly id?: string;
472
- /**
473
- *
474
- */
475
- readonly key?: string;
476
- /**
477
- *
478
- */
479
- readonly title?: string;
480
- /**
481
- *
482
- */
483
- readonly salutation?: string;
484
- /**
485
- *
486
- */
487
- readonly firstName?: string;
488
- /**
489
- *
490
- */
491
- readonly lastName?: string;
492
- /**
493
- *
494
- */
495
- readonly streetName?: string;
496
- /**
497
- *
498
- */
499
- readonly streetNumber?: string;
500
- /**
501
- *
502
- */
503
- readonly additionalStreetInfo?: string;
504
- /**
505
- *
506
- */
507
- readonly postalCode?: string;
508
- /**
509
- *
510
- */
511
- readonly city?: string;
512
- /**
513
- *
514
- */
515
- readonly region?: string;
516
- /**
517
- *
518
- */
519
- readonly state?: string;
520
- /**
521
- * A two-digit country code as per [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
522
- *
523
- *
524
- */
525
- readonly country: string;
526
- /**
527
- *
528
- */
529
- readonly company?: string;
530
- /**
531
- *
532
- */
533
- readonly department?: string;
534
- /**
535
- *
536
- */
537
- readonly building?: string;
538
- /**
539
- *
540
- */
541
- readonly apartment?: string;
542
- /**
543
- *
544
- */
545
- readonly pOBox?: string;
546
- /**
547
- *
548
- */
549
- readonly phone?: string;
550
- /**
551
- *
552
- */
553
- readonly mobile?: string;
554
- /**
555
- *
556
- */
557
- readonly email?: string;
558
- /**
559
- *
560
- */
561
- readonly fax?: string;
562
- /**
563
- *
564
- */
565
- readonly additionalAddressInfo?: string;
566
- /**
567
- *
568
- */
569
- readonly externalId?: string;
570
- }
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 { Custom } from './customfields';
7
+ export interface Asset {
8
+ /**
9
+ * User-defined identifier for the asset.
10
+ * Asset keys are unique inside their container (a product variant or a category).
11
+ *
12
+ *
13
+ */
14
+ readonly key: string;
15
+ /**
16
+ *
17
+ */
18
+ readonly sources: AssetSource[];
19
+ /**
20
+ * 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.
21
+ * ```json
22
+ * {
23
+ * "de": "Hundefutter",
24
+ * "en": "dog food"
25
+ * }
26
+ * ```
27
+ *
28
+ *
29
+ */
30
+ readonly name: LocalizedString;
31
+ /**
32
+ * 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.
33
+ * ```json
34
+ * {
35
+ * "de": "Hundefutter",
36
+ * "en": "dog food"
37
+ * }
38
+ * ```
39
+ *
40
+ *
41
+ */
42
+ readonly description?: LocalizedString;
43
+ /**
44
+ *
45
+ */
46
+ readonly tags?: string[];
47
+ /**
48
+ * The representation to be sent to the server when creating a resource with custom fields.
49
+ *
50
+ */
51
+ readonly custom?: Custom;
52
+ }
53
+ /**
54
+ * The width and height of the Asset Source.
55
+ */
56
+ export interface AssetDimensions {
57
+ /**
58
+ * The width of the asset source.
59
+ *
60
+ */
61
+ readonly w: number;
62
+ /**
63
+ * The height of the asset source.
64
+ *
65
+ */
66
+ readonly h: number;
67
+ }
68
+ /**
69
+ * An AssetSource is a representation of an Asset in a specific format, for example, a video in a certain encoding or an image in a certain resolution.
70
+ */
71
+ export interface AssetSource {
72
+ /**
73
+ *
74
+ */
75
+ readonly uri: string;
76
+ /**
77
+ *
78
+ */
79
+ readonly key?: string;
80
+ /**
81
+ * The width and height of the Asset Source.
82
+ *
83
+ */
84
+ readonly dimensions?: AssetDimensions;
85
+ /**
86
+ *
87
+ */
88
+ readonly contentType?: string;
89
+ }
90
+ /**
91
+ * An Image uploaded to the commercetools platform is stored in a Content Delivery Network and it's available in several pre-defined sizes. If you already have an image stored on an external service, you can save the URL when creating a new product or adding a variant, or you can add it later.
92
+ */
93
+ export interface Image {
94
+ /**
95
+ * URL of the image in its original size. The URL must be unique within a single variant. It can be used to obtain the image in different sizes.
96
+ *
97
+ */
98
+ readonly url: string;
99
+ /**
100
+ * Dimensions of the original image. This can be used by your application, for example, to determine whether the image is large enough to display a zoom view.
101
+ *
102
+ */
103
+ readonly dimensions: AssetDimensions;
104
+ /**
105
+ * Custom label that can be used, for example, as an image description.
106
+ *
107
+ */
108
+ readonly label?: string;
109
+ }
110
+ export interface EnumValue {
111
+ /**
112
+ *
113
+ */
114
+ readonly key: string;
115
+ /**
116
+ *
117
+ */
118
+ readonly label: string;
119
+ }
120
+ export interface LocalizedEnumValue {
121
+ /**
122
+ *
123
+ */
124
+ readonly key: string;
125
+ /**
126
+ * 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.
127
+ * ```json
128
+ * {
129
+ * "de": "Hundefutter",
130
+ * "en": "dog food"
131
+ * }
132
+ * ```
133
+ *
134
+ *
135
+ */
136
+ readonly label: LocalizedString;
137
+ }
138
+ /**
139
+ * 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.
140
+ * ```json
141
+ * {
142
+ * "de": "Hundefutter",
143
+ * "en": "dog food"
144
+ * }
145
+ * ```
146
+ *
147
+ */
148
+ export interface LocalizedString {
149
+ [key: string]: string;
150
+ }
151
+ /**
152
+ * A representation of the resource to import.
153
+ * Import resources are similar to commercetools draft types, but they only support key references.
154
+ * In general, import resources are more granular then the normal commercetools resource.
155
+ * They are optimized for incremental updates and therefore have a slightly different structure.
156
+ *
157
+ */
158
+ export interface ImportResource {
159
+ /**
160
+ *
161
+ */
162
+ readonly key: string;
163
+ }
164
+ /**
165
+ * References a resource by key.
166
+ */
167
+ export declare type KeyReference = CartDiscountKeyReference | CartKeyReference | CategoryKeyReference | ChannelKeyReference | CustomObjectKeyReference | CustomerGroupKeyReference | CustomerKeyReference | DiscountCodeKeyReference | OrderKeyReference | PaymentKeyReference | PriceKeyReference | ProductDiscountKeyReference | ProductKeyReference | ProductTypeKeyReference | ProductVariantKeyReference | ShippingMethodKeyReference | StateKeyReference | StoreKeyReference | TaxCategoryKeyReference | TypeKeyReference;
168
+ /**
169
+ * References a cart by key.
170
+ */
171
+ export interface CartKeyReference {
172
+ readonly typeId: 'cart';
173
+ /**
174
+ *
175
+ */
176
+ readonly key: string;
177
+ }
178
+ /**
179
+ * References a cart discount by key.
180
+ */
181
+ export interface CartDiscountKeyReference {
182
+ readonly typeId: 'cart-discount';
183
+ /**
184
+ *
185
+ */
186
+ readonly key: string;
187
+ }
188
+ /**
189
+ * References a category by key.
190
+ */
191
+ export interface CategoryKeyReference {
192
+ readonly typeId: 'category';
193
+ /**
194
+ *
195
+ */
196
+ readonly key: string;
197
+ }
198
+ /**
199
+ * References a channel by key.
200
+ */
201
+ export interface ChannelKeyReference {
202
+ readonly typeId: 'channel';
203
+ /**
204
+ *
205
+ */
206
+ readonly key: string;
207
+ }
208
+ /**
209
+ * References a customer by key.
210
+ */
211
+ export interface CustomerKeyReference {
212
+ readonly typeId: 'customer';
213
+ /**
214
+ *
215
+ */
216
+ readonly key: string;
217
+ }
218
+ /**
219
+ * References a customer group by key.
220
+ */
221
+ export interface CustomerGroupKeyReference {
222
+ readonly typeId: 'customer-group';
223
+ /**
224
+ *
225
+ */
226
+ readonly key: string;
227
+ }
228
+ /**
229
+ * References a discount code by key.
230
+ */
231
+ export interface DiscountCodeKeyReference {
232
+ readonly typeId: 'discount-code';
233
+ /**
234
+ *
235
+ */
236
+ readonly key: string;
237
+ }
238
+ /**
239
+ * References an order by key.
240
+ */
241
+ export interface OrderKeyReference {
242
+ readonly typeId: 'order';
243
+ /**
244
+ *
245
+ */
246
+ readonly key: string;
247
+ }
248
+ /**
249
+ * References a payment by key.
250
+ */
251
+ export interface PaymentKeyReference {
252
+ readonly typeId: 'payment';
253
+ /**
254
+ *
255
+ */
256
+ readonly key: string;
257
+ }
258
+ /**
259
+ * References a price by key.
260
+ */
261
+ export interface PriceKeyReference {
262
+ readonly typeId: 'price';
263
+ /**
264
+ *
265
+ */
266
+ readonly key: string;
267
+ }
268
+ /**
269
+ * References a product by key.
270
+ */
271
+ export interface ProductKeyReference {
272
+ readonly typeId: 'product';
273
+ /**
274
+ *
275
+ */
276
+ readonly key: string;
277
+ }
278
+ /**
279
+ * References a product discount by key.
280
+ */
281
+ export interface ProductDiscountKeyReference {
282
+ readonly typeId: 'product-discount';
283
+ /**
284
+ *
285
+ */
286
+ readonly key: string;
287
+ }
288
+ /**
289
+ * References a product type by key.
290
+ */
291
+ export interface ProductTypeKeyReference {
292
+ readonly typeId: 'product-type';
293
+ /**
294
+ *
295
+ */
296
+ readonly key: string;
297
+ }
298
+ /**
299
+ * References a product variant by key.
300
+ */
301
+ export interface ProductVariantKeyReference {
302
+ readonly typeId: 'product-variant';
303
+ /**
304
+ *
305
+ */
306
+ readonly key: string;
307
+ }
308
+ /**
309
+ * References a shipping method by key.
310
+ */
311
+ export interface ShippingMethodKeyReference {
312
+ readonly typeId: 'shipping-method';
313
+ /**
314
+ *
315
+ */
316
+ readonly key: string;
317
+ }
318
+ /**
319
+ * References a state by key.
320
+ */
321
+ export interface StateKeyReference {
322
+ readonly typeId: 'state';
323
+ /**
324
+ *
325
+ */
326
+ readonly key: string;
327
+ }
328
+ /**
329
+ * References a store by key.
330
+ */
331
+ export interface StoreKeyReference {
332
+ readonly typeId: 'store';
333
+ /**
334
+ *
335
+ */
336
+ readonly key: string;
337
+ }
338
+ /**
339
+ * References a tax category by key.
340
+ */
341
+ export interface TaxCategoryKeyReference {
342
+ readonly typeId: 'tax-category';
343
+ /**
344
+ *
345
+ */
346
+ readonly key: string;
347
+ }
348
+ /**
349
+ * References a type by key.
350
+ */
351
+ export interface TypeKeyReference {
352
+ readonly typeId: 'type';
353
+ /**
354
+ *
355
+ */
356
+ readonly key: string;
357
+ }
358
+ /**
359
+ * References a key value document by key.
360
+ */
361
+ export interface CustomObjectKeyReference {
362
+ readonly typeId: 'key-value-document';
363
+ /**
364
+ *
365
+ */
366
+ readonly key: string;
367
+ /**
368
+ *
369
+ */
370
+ readonly container: string;
371
+ }
372
+ export interface UnresolvedReferences {
373
+ /**
374
+ *
375
+ */
376
+ readonly key: string;
377
+ /**
378
+ * The type of the referenced resource.
379
+ *
380
+ *
381
+ */
382
+ readonly typeId: ReferenceType;
383
+ }
384
+ export declare type MoneyType = 'centPrecision' | 'highPrecision';
385
+ export declare type TypedMoney = HighPrecisionMoney | Money;
386
+ export interface HighPrecisionMoney {
387
+ readonly type: 'highPrecision';
388
+ /**
389
+ *
390
+ */
391
+ readonly fractionDigits?: number;
392
+ /**
393
+ *
394
+ */
395
+ readonly centAmount: number;
396
+ /**
397
+ * The currency code compliant to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).
398
+ *
399
+ *
400
+ */
401
+ readonly currencyCode: string;
402
+ /**
403
+ *
404
+ */
405
+ readonly preciseAmount: number;
406
+ }
407
+ export interface Money {
408
+ readonly type: 'centPrecision';
409
+ /**
410
+ *
411
+ */
412
+ readonly fractionDigits?: number;
413
+ /**
414
+ *
415
+ */
416
+ readonly centAmount: number;
417
+ /**
418
+ * The currency code compliant to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).
419
+ *
420
+ *
421
+ */
422
+ readonly currencyCode: string;
423
+ }
424
+ export interface DiscountedPrice {
425
+ /**
426
+ *
427
+ */
428
+ readonly value: TypedMoney;
429
+ /**
430
+ * Reference to a ProductDiscount.
431
+ *
432
+ */
433
+ readonly discount: ProductDiscountKeyReference;
434
+ }
435
+ /**
436
+ * A price tier is selected instead of the default price when a certain quantity of the ProductVariant is added to a cart and ordered.
437
+ *
438
+ */
439
+ export interface PriceTier {
440
+ /**
441
+ * The minimum quantity this price tier is valid for.
442
+ *
443
+ *
444
+ */
445
+ readonly minimumQuantity: number;
446
+ /**
447
+ * The currency of a price tier is always the same as the currency of the base Price.
448
+ *
449
+ */
450
+ readonly value: TypedMoney;
451
+ }
452
+ /**
453
+ * The type of the import resource.
454
+ *
455
+ */
456
+ export declare type ImportResourceType = 'category' | 'customer' | 'order' | 'order-patch' | 'price' | 'product' | 'product-draft' | 'product-type' | 'product-variant' | 'product-variant-patch';
457
+ /**
458
+ * The type of the referenced resource.
459
+ *
460
+ */
461
+ export declare type ReferenceType = 'cart' | 'cart-discount' | 'category' | 'channel' | 'customer' | 'customer-group' | 'discount-code' | 'key-value-document' | 'order' | 'payment' | 'price' | 'product' | 'product-discount' | 'product-type' | 'product-variant' | 'shipping-method' | 'state' | 'store' | 'tax-category' | 'type';
462
+ /**
463
+ * Every [Import Operation](/import-operation) is assigned with one of the following states.
464
+ *
465
+ */
466
+ export declare type ProcessingState = 'imported' | 'processing' | 'rejected' | 'unresolved' | 'validationFailed' | 'waitForMasterVariant';
467
+ export interface Address {
468
+ /**
469
+ *
470
+ */
471
+ readonly id?: string;
472
+ /**
473
+ *
474
+ */
475
+ readonly key?: string;
476
+ /**
477
+ *
478
+ */
479
+ readonly title?: string;
480
+ /**
481
+ *
482
+ */
483
+ readonly salutation?: string;
484
+ /**
485
+ *
486
+ */
487
+ readonly firstName?: string;
488
+ /**
489
+ *
490
+ */
491
+ readonly lastName?: string;
492
+ /**
493
+ *
494
+ */
495
+ readonly streetName?: string;
496
+ /**
497
+ *
498
+ */
499
+ readonly streetNumber?: string;
500
+ /**
501
+ *
502
+ */
503
+ readonly additionalStreetInfo?: string;
504
+ /**
505
+ *
506
+ */
507
+ readonly postalCode?: string;
508
+ /**
509
+ *
510
+ */
511
+ readonly city?: string;
512
+ /**
513
+ *
514
+ */
515
+ readonly region?: string;
516
+ /**
517
+ *
518
+ */
519
+ readonly state?: string;
520
+ /**
521
+ * A two-digit country code as per [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
522
+ *
523
+ *
524
+ */
525
+ readonly country: string;
526
+ /**
527
+ *
528
+ */
529
+ readonly company?: string;
530
+ /**
531
+ *
532
+ */
533
+ readonly department?: string;
534
+ /**
535
+ *
536
+ */
537
+ readonly building?: string;
538
+ /**
539
+ *
540
+ */
541
+ readonly apartment?: string;
542
+ /**
543
+ *
544
+ */
545
+ readonly pOBox?: string;
546
+ /**
547
+ *
548
+ */
549
+ readonly phone?: string;
550
+ /**
551
+ *
552
+ */
553
+ readonly mobile?: string;
554
+ /**
555
+ *
556
+ */
557
+ readonly email?: string;
558
+ /**
559
+ *
560
+ */
561
+ readonly fax?: string;
562
+ /**
563
+ *
564
+ */
565
+ readonly additionalAddressInfo?: string;
566
+ /**
567
+ *
568
+ */
569
+ readonly externalId?: string;
570
+ }