@aurigma/axios-storefront-api-client 2.59.1 → 2.62.12

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.
@@ -85,6 +85,92 @@ export declare class ProcessingPipelinesApiClient extends ApiClientBase implemen
85
85
  get(id: number, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProcessingPipelineDto>;
86
86
  protected processGet(response: AxiosResponse): Promise<ProcessingPipelineDto>;
87
87
  }
88
+ export interface IProductBundlesApiClient {
89
+ /**
90
+ * Returns all product bundles, relevant to the specified query parameters.
91
+ * @param skip (optional) Defines page start offset from beginning of sorted result list.
92
+ * @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
93
+ * @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC".
94
+ * @param search (optional) Search string for partial match.
95
+ * @param customFields (optional) Serialized custom fields dictionary filter. For example: {"public":"true","name":"my item"}
96
+ * @param tenantId (optional) Tenant identifier.
97
+ * @return Success
98
+ */
99
+ getAllProductBundles(skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, customFields?: string | null | undefined, tenantId?: number | null | undefined): Promise<PagedOfProductBundleDto>;
100
+ /**
101
+ * Returns a product bundle by its identifier.
102
+ * @param id Product identifier.
103
+ * @param productBundleVersionId (optional) Product bundle version identifier. Optional
104
+ * @param tenantId (optional) Tenant identifier.
105
+ * @return Success
106
+ */
107
+ getProductBundle(id: number, productBundleVersionId?: number | null | undefined, tenantId?: number | null | undefined): Promise<ProductBundleDto>;
108
+ /**
109
+ * Returns a product bundle summary by product bundle identifier.
110
+ * @param id Product bundle identifier.
111
+ * @param productBundleVersionId (optional) Product bundle version identifier.
112
+ * @param productVariantId (optional) Product variant identifier.
113
+ * @param sku (optional) Product variant SKU.
114
+ * @param tenantId (optional) Tenant identifier.
115
+ * @return Success
116
+ */
117
+ getProductSummary(id: number, productBundleVersionId?: number | null | undefined, productVariantId?: number | null | undefined, sku?: string | null | undefined, tenantId?: number | null | undefined): Promise<ProductSummaryDto>;
118
+ /**
119
+ * Returns a product bundle personalization workflow description by product bundle identifier.
120
+ * @param id Product bundle identifier.
121
+ * @param productBundleVersionId (optional) Product bundle version identifier.
122
+ * @param tenantId (optional) Tenant identifier.
123
+ * @return Success
124
+ */
125
+ getPersonalizationWorkflow(id: number, productBundleVersionId?: number | null | undefined, tenantId?: number | null | undefined): Promise<PersonalizationWorkflowDto>;
126
+ }
127
+ export declare class ProductBundlesApiClient extends ApiClientBase implements IProductBundlesApiClient {
128
+ private instance;
129
+ private baseUrl;
130
+ protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
131
+ constructor(configuration: ApiClientConfiguration, baseUrl?: string, instance?: AxiosInstance);
132
+ /**
133
+ * Returns all product bundles, relevant to the specified query parameters.
134
+ * @param skip (optional) Defines page start offset from beginning of sorted result list.
135
+ * @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
136
+ * @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC".
137
+ * @param search (optional) Search string for partial match.
138
+ * @param customFields (optional) Serialized custom fields dictionary filter. For example: {"public":"true","name":"my item"}
139
+ * @param tenantId (optional) Tenant identifier.
140
+ * @return Success
141
+ */
142
+ getAllProductBundles(skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, customFields?: string | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfProductBundleDto>;
143
+ protected processGetAllProductBundles(response: AxiosResponse): Promise<PagedOfProductBundleDto>;
144
+ /**
145
+ * Returns a product bundle by its identifier.
146
+ * @param id Product identifier.
147
+ * @param productBundleVersionId (optional) Product bundle version identifier. Optional
148
+ * @param tenantId (optional) Tenant identifier.
149
+ * @return Success
150
+ */
151
+ getProductBundle(id: number, productBundleVersionId?: number | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProductBundleDto>;
152
+ protected processGetProductBundle(response: AxiosResponse): Promise<ProductBundleDto>;
153
+ /**
154
+ * Returns a product bundle summary by product bundle identifier.
155
+ * @param id Product bundle identifier.
156
+ * @param productBundleVersionId (optional) Product bundle version identifier.
157
+ * @param productVariantId (optional) Product variant identifier.
158
+ * @param sku (optional) Product variant SKU.
159
+ * @param tenantId (optional) Tenant identifier.
160
+ * @return Success
161
+ */
162
+ getProductSummary(id: number, productBundleVersionId?: number | null | undefined, productVariantId?: number | null | undefined, sku?: string | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProductSummaryDto>;
163
+ protected processGetProductSummary(response: AxiosResponse): Promise<ProductSummaryDto>;
164
+ /**
165
+ * Returns a product bundle personalization workflow description by product bundle identifier.
166
+ * @param id Product bundle identifier.
167
+ * @param productBundleVersionId (optional) Product bundle version identifier.
168
+ * @param tenantId (optional) Tenant identifier.
169
+ * @return Success
170
+ */
171
+ getPersonalizationWorkflow(id: number, productBundleVersionId?: number | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PersonalizationWorkflowDto>;
172
+ protected processGetPersonalizationWorkflow(response: AxiosResponse): Promise<PersonalizationWorkflowDto>;
173
+ }
88
174
  export interface IProductLinksApiClient {
89
175
  /**
90
176
  * Returns all product links, relevant to the specified query parameters.
@@ -186,6 +272,7 @@ export interface IProductReferencesApiClient {
186
272
  * @param productSpecificationId (optional) Customer's Canvas product specification filter.
187
273
  * @param productId (optional) Customer's Canvas product filter.
188
274
  * @param productLinkId (optional) Customer's Canvas product link filter.
275
+ * @param productBundleId (optional) Customer's Canvas product bundle filter.
189
276
  * @param skip (optional) Defines page start offset from beginning of sorted result list.
190
277
  * @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
191
278
  * @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC".
@@ -196,7 +283,7 @@ export interface IProductReferencesApiClient {
196
283
  * @param tenantId (optional) Tenant identifier.
197
284
  * @return Success
198
285
  */
199
- getAll(storefrontId: number, productReference?: string | null | undefined, productSpecificationId?: number | null | undefined, productId?: number | null | undefined, productLinkId?: number | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, sku?: string | null | undefined, tags?: string[] | null | undefined, customFields?: string | null | undefined, tenantId?: number | null | undefined): Promise<PagedOfProductReferenceDto>;
286
+ getAll(storefrontId: number, productReference?: string | null | undefined, productSpecificationId?: number | null | undefined, productId?: number | null | undefined, productLinkId?: number | null | undefined, productBundleId?: number | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, sku?: string | null | undefined, tags?: string[] | null | undefined, customFields?: string | null | undefined, tenantId?: number | null | undefined): Promise<PagedOfProductReferenceDto>;
200
287
  /**
201
288
  * Returns a list of product specifications associated with storefront product references relevant to the specified query parameters.
202
289
  * @param storefrontId Storefront identifier.
@@ -205,6 +292,7 @@ export interface IProductReferencesApiClient {
205
292
  * @param productSpecificationId (optional) Customer's Canvas product specification filter.
206
293
  * @param productId (optional) Customer's Canvas product filter.
207
294
  * @param productLinkId (optional) Customer's Canvas product link filter.
295
+ * @param productBundleId (optional) Customer's Canvas product bundle filter.
208
296
  * @param skip (optional) Defines page start offset from beginning of sorted result list.
209
297
  * @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
210
298
  * @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC".
@@ -215,7 +303,7 @@ export interface IProductReferencesApiClient {
215
303
  * @param tenantId (optional) Tenant identifier.
216
304
  * @return Success
217
305
  */
218
- getAllProductSpecifications(storefrontId: number, productReference?: string | null | undefined, productSpecificationId?: number | null | undefined, productId?: number | null | undefined, productLinkId?: number | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, sku?: string | null | undefined, tags?: string[] | null | undefined, customFields?: string | null | undefined, tenantId?: number | null | undefined): Promise<PagedOfProductSpecificationDto>;
306
+ getAllProductSpecifications(storefrontId: number, productReference?: string | null | undefined, productSpecificationId?: number | null | undefined, productId?: number | null | undefined, productLinkId?: number | null | undefined, productBundleId?: number | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, sku?: string | null | undefined, tags?: string[] | null | undefined, customFields?: string | null | undefined, tenantId?: number | null | undefined): Promise<PagedOfProductSpecificationDto>;
219
307
  /**
220
308
  * Returns a list of products associated with storefront product references relevant to the specified query parameters.
221
309
  * @param storefrontId Storefront identifier.
@@ -224,6 +312,7 @@ export interface IProductReferencesApiClient {
224
312
  * @param productSpecificationId (optional) Customer's Canvas product specification filter.
225
313
  * @param productId (optional) Customer's Canvas product filter.
226
314
  * @param productLinkId (optional) Customer's Canvas product link filter.
315
+ * @param productBundleId (optional) Customer's Canvas product bundle filter.
227
316
  * @param skip (optional) Defines page start offset from beginning of sorted result list.
228
317
  * @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
229
318
  * @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC".
@@ -234,7 +323,7 @@ export interface IProductReferencesApiClient {
234
323
  * @param tenantId (optional) Tenant identifier.
235
324
  * @return Success
236
325
  */
237
- getAllProducts(storefrontId: number, productReference?: string | null | undefined, productSpecificationId?: number | null | undefined, productId?: number | null | undefined, productLinkId?: number | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, sku?: string | null | undefined, tags?: string[] | null | undefined, customFields?: string | null | undefined, tenantId?: number | null | undefined): Promise<PagedOfProductDto>;
326
+ getAllProducts(storefrontId: number, productReference?: string | null | undefined, productSpecificationId?: number | null | undefined, productId?: number | null | undefined, productLinkId?: number | null | undefined, productBundleId?: number | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, sku?: string | null | undefined, tags?: string[] | null | undefined, customFields?: string | null | undefined, tenantId?: number | null | undefined): Promise<PagedOfProductDto>;
238
327
  /**
239
328
  * Returns a list of product links associated with storefront product references relevant to the specified query parameters.
240
329
  * @param storefrontId Storefront identifier.
@@ -243,6 +332,7 @@ export interface IProductReferencesApiClient {
243
332
  * @param productSpecificationId (optional) Customer's Canvas product specification filter.
244
333
  * @param productId (optional) Customer's Canvas product filter.
245
334
  * @param productLinkId (optional) Customer's Canvas product link filter.
335
+ * @param productBundleId (optional) Customer's Canvas product bundle filter.
246
336
  * @param skip (optional) Defines page start offset from beginning of sorted result list.
247
337
  * @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
248
338
  * @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC".
@@ -253,7 +343,27 @@ export interface IProductReferencesApiClient {
253
343
  * @param tenantId (optional) Tenant identifier.
254
344
  * @return Success
255
345
  */
256
- getAllProductLinks(storefrontId: number, productReference?: string | null | undefined, productSpecificationId?: number | null | undefined, productId?: number | null | undefined, productLinkId?: number | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, sku?: string | null | undefined, tags?: string[] | null | undefined, customFields?: string | null | undefined, tenantId?: number | null | undefined): Promise<PagedOfProductLinkDto>;
346
+ getAllProductLinks(storefrontId: number, productReference?: string | null | undefined, productSpecificationId?: number | null | undefined, productId?: number | null | undefined, productLinkId?: number | null | undefined, productBundleId?: number | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, sku?: string | null | undefined, tags?: string[] | null | undefined, customFields?: string | null | undefined, tenantId?: number | null | undefined): Promise<PagedOfProductLinkDto>;
347
+ /**
348
+ * Returns a list of product bundles associated with storefront product references relevant to the specified query parameters.
349
+ * @param storefrontId Storefront identifier.
350
+ * @param productReference (optional) Product reference filter.
351
+ Product reference is an external reference to Customer's Canvas product, e.g online store product identifier.
352
+ * @param productSpecificationId (optional) Customer's Canvas product specification filter.
353
+ * @param productId (optional) Customer's Canvas product filter.
354
+ * @param productLinkId (optional) Customer's Canvas product link filter.
355
+ * @param productBundleId (optional) Customer's Canvas product bundle filter.
356
+ * @param skip (optional) Defines page start offset from beginning of sorted result list.
357
+ * @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
358
+ * @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC".
359
+ * @param search (optional) Search string for partial match.
360
+ * @param sku (optional) SKU filter.
361
+ * @param tags (optional) List of tags that product should have.
362
+ * @param customFields (optional) Serialized custom fields dictionary filter. For example: {"public":"true","name":"my item"}.
363
+ * @param tenantId (optional) Tenant identifier.
364
+ * @return Success
365
+ */
366
+ getAllProductBundles(storefrontId: number, productReference?: string | null | undefined, productSpecificationId?: number | null | undefined, productId?: number | null | undefined, productLinkId?: number | null | undefined, productBundleId?: number | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, sku?: string | null | undefined, tags?: string[] | null | undefined, customFields?: string | null | undefined, tenantId?: number | null | undefined): Promise<PagedOfProductBundleDto>;
257
367
  /**
258
368
  * Returns a storefront product reference.
259
369
  * @param reference An external reference to Customer's Canvas product, e.g online store product identifier.
@@ -296,6 +406,14 @@ export interface IProductReferencesApiClient {
296
406
  * @return Success
297
407
  */
298
408
  getProductLink(reference: string | null, storefrontId: number, tenantId?: number | null | undefined): Promise<ProductLinkDto>;
409
+ /**
410
+ * Returns a product bundle by storefront product reference.
411
+ * @param reference An external reference to Customer's Canvas product, e.g online store product identifier.
412
+ * @param storefrontId Storefront identifier.
413
+ * @param tenantId (optional) Tenant identifier.
414
+ * @return Success
415
+ */
416
+ getProductBundle(reference: string | null, storefrontId: number, tenantId?: number | null | undefined): Promise<ProductBundleDto>;
299
417
  /**
300
418
  * Returns a product cost details from ecommerce system.
301
419
  * @param reference An external reference to Customer's Canvas product, e.g online store product identifier.
@@ -330,6 +448,7 @@ export declare class ProductReferencesApiClient extends ApiClientBase implements
330
448
  * @param productSpecificationId (optional) Customer's Canvas product specification filter.
331
449
  * @param productId (optional) Customer's Canvas product filter.
332
450
  * @param productLinkId (optional) Customer's Canvas product link filter.
451
+ * @param productBundleId (optional) Customer's Canvas product bundle filter.
333
452
  * @param skip (optional) Defines page start offset from beginning of sorted result list.
334
453
  * @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
335
454
  * @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC".
@@ -340,7 +459,7 @@ export declare class ProductReferencesApiClient extends ApiClientBase implements
340
459
  * @param tenantId (optional) Tenant identifier.
341
460
  * @return Success
342
461
  */
343
- getAll(storefrontId: number, productReference?: string | null | undefined, productSpecificationId?: number | null | undefined, productId?: number | null | undefined, productLinkId?: number | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, sku?: string | null | undefined, tags?: string[] | null | undefined, customFields?: string | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfProductReferenceDto>;
462
+ getAll(storefrontId: number, productReference?: string | null | undefined, productSpecificationId?: number | null | undefined, productId?: number | null | undefined, productLinkId?: number | null | undefined, productBundleId?: number | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, sku?: string | null | undefined, tags?: string[] | null | undefined, customFields?: string | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfProductReferenceDto>;
344
463
  protected processGetAll(response: AxiosResponse): Promise<PagedOfProductReferenceDto>;
345
464
  /**
346
465
  * Returns a list of product specifications associated with storefront product references relevant to the specified query parameters.
@@ -350,6 +469,7 @@ export declare class ProductReferencesApiClient extends ApiClientBase implements
350
469
  * @param productSpecificationId (optional) Customer's Canvas product specification filter.
351
470
  * @param productId (optional) Customer's Canvas product filter.
352
471
  * @param productLinkId (optional) Customer's Canvas product link filter.
472
+ * @param productBundleId (optional) Customer's Canvas product bundle filter.
353
473
  * @param skip (optional) Defines page start offset from beginning of sorted result list.
354
474
  * @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
355
475
  * @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC".
@@ -360,7 +480,7 @@ export declare class ProductReferencesApiClient extends ApiClientBase implements
360
480
  * @param tenantId (optional) Tenant identifier.
361
481
  * @return Success
362
482
  */
363
- getAllProductSpecifications(storefrontId: number, productReference?: string | null | undefined, productSpecificationId?: number | null | undefined, productId?: number | null | undefined, productLinkId?: number | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, sku?: string | null | undefined, tags?: string[] | null | undefined, customFields?: string | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfProductSpecificationDto>;
483
+ getAllProductSpecifications(storefrontId: number, productReference?: string | null | undefined, productSpecificationId?: number | null | undefined, productId?: number | null | undefined, productLinkId?: number | null | undefined, productBundleId?: number | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, sku?: string | null | undefined, tags?: string[] | null | undefined, customFields?: string | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfProductSpecificationDto>;
364
484
  protected processGetAllProductSpecifications(response: AxiosResponse): Promise<PagedOfProductSpecificationDto>;
365
485
  /**
366
486
  * Returns a list of products associated with storefront product references relevant to the specified query parameters.
@@ -370,6 +490,7 @@ export declare class ProductReferencesApiClient extends ApiClientBase implements
370
490
  * @param productSpecificationId (optional) Customer's Canvas product specification filter.
371
491
  * @param productId (optional) Customer's Canvas product filter.
372
492
  * @param productLinkId (optional) Customer's Canvas product link filter.
493
+ * @param productBundleId (optional) Customer's Canvas product bundle filter.
373
494
  * @param skip (optional) Defines page start offset from beginning of sorted result list.
374
495
  * @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
375
496
  * @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC".
@@ -380,7 +501,7 @@ export declare class ProductReferencesApiClient extends ApiClientBase implements
380
501
  * @param tenantId (optional) Tenant identifier.
381
502
  * @return Success
382
503
  */
383
- getAllProducts(storefrontId: number, productReference?: string | null | undefined, productSpecificationId?: number | null | undefined, productId?: number | null | undefined, productLinkId?: number | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, sku?: string | null | undefined, tags?: string[] | null | undefined, customFields?: string | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfProductDto>;
504
+ getAllProducts(storefrontId: number, productReference?: string | null | undefined, productSpecificationId?: number | null | undefined, productId?: number | null | undefined, productLinkId?: number | null | undefined, productBundleId?: number | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, sku?: string | null | undefined, tags?: string[] | null | undefined, customFields?: string | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfProductDto>;
384
505
  protected processGetAllProducts(response: AxiosResponse): Promise<PagedOfProductDto>;
385
506
  /**
386
507
  * Returns a list of product links associated with storefront product references relevant to the specified query parameters.
@@ -390,6 +511,7 @@ export declare class ProductReferencesApiClient extends ApiClientBase implements
390
511
  * @param productSpecificationId (optional) Customer's Canvas product specification filter.
391
512
  * @param productId (optional) Customer's Canvas product filter.
392
513
  * @param productLinkId (optional) Customer's Canvas product link filter.
514
+ * @param productBundleId (optional) Customer's Canvas product bundle filter.
393
515
  * @param skip (optional) Defines page start offset from beginning of sorted result list.
394
516
  * @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
395
517
  * @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC".
@@ -400,8 +522,29 @@ export declare class ProductReferencesApiClient extends ApiClientBase implements
400
522
  * @param tenantId (optional) Tenant identifier.
401
523
  * @return Success
402
524
  */
403
- getAllProductLinks(storefrontId: number, productReference?: string | null | undefined, productSpecificationId?: number | null | undefined, productId?: number | null | undefined, productLinkId?: number | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, sku?: string | null | undefined, tags?: string[] | null | undefined, customFields?: string | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfProductLinkDto>;
525
+ getAllProductLinks(storefrontId: number, productReference?: string | null | undefined, productSpecificationId?: number | null | undefined, productId?: number | null | undefined, productLinkId?: number | null | undefined, productBundleId?: number | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, sku?: string | null | undefined, tags?: string[] | null | undefined, customFields?: string | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfProductLinkDto>;
404
526
  protected processGetAllProductLinks(response: AxiosResponse): Promise<PagedOfProductLinkDto>;
527
+ /**
528
+ * Returns a list of product bundles associated with storefront product references relevant to the specified query parameters.
529
+ * @param storefrontId Storefront identifier.
530
+ * @param productReference (optional) Product reference filter.
531
+ Product reference is an external reference to Customer's Canvas product, e.g online store product identifier.
532
+ * @param productSpecificationId (optional) Customer's Canvas product specification filter.
533
+ * @param productId (optional) Customer's Canvas product filter.
534
+ * @param productLinkId (optional) Customer's Canvas product link filter.
535
+ * @param productBundleId (optional) Customer's Canvas product bundle filter.
536
+ * @param skip (optional) Defines page start offset from beginning of sorted result list.
537
+ * @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
538
+ * @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC".
539
+ * @param search (optional) Search string for partial match.
540
+ * @param sku (optional) SKU filter.
541
+ * @param tags (optional) List of tags that product should have.
542
+ * @param customFields (optional) Serialized custom fields dictionary filter. For example: {"public":"true","name":"my item"}.
543
+ * @param tenantId (optional) Tenant identifier.
544
+ * @return Success
545
+ */
546
+ getAllProductBundles(storefrontId: number, productReference?: string | null | undefined, productSpecificationId?: number | null | undefined, productId?: number | null | undefined, productLinkId?: number | null | undefined, productBundleId?: number | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, sku?: string | null | undefined, tags?: string[] | null | undefined, customFields?: string | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfProductBundleDto>;
547
+ protected processGetAllProductBundles(response: AxiosResponse): Promise<PagedOfProductBundleDto>;
405
548
  /**
406
549
  * Returns a storefront product reference.
407
550
  * @param reference An external reference to Customer's Canvas product, e.g online store product identifier.
@@ -449,6 +592,15 @@ export declare class ProductReferencesApiClient extends ApiClientBase implements
449
592
  */
450
593
  getProductLink(reference: string | null, storefrontId: number, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProductLinkDto>;
451
594
  protected processGetProductLink(response: AxiosResponse): Promise<ProductLinkDto>;
595
+ /**
596
+ * Returns a product bundle by storefront product reference.
597
+ * @param reference An external reference to Customer's Canvas product, e.g online store product identifier.
598
+ * @param storefrontId Storefront identifier.
599
+ * @param tenantId (optional) Tenant identifier.
600
+ * @return Success
601
+ */
602
+ getProductBundle(reference: string | null, storefrontId: number, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProductBundleDto>;
603
+ protected processGetProductBundle(response: AxiosResponse): Promise<ProductBundleDto>;
452
604
  /**
453
605
  * Returns a product cost details from ecommerce system.
454
606
  * @param reference An external reference to Customer's Canvas product, e.g online store product identifier.
@@ -522,7 +674,7 @@ export interface IProductsApiClient {
522
674
  /**
523
675
  * Returns a list of product links.
524
676
  * @param id Product identifier.
525
- * @param productVersionId (optional)
677
+ * @param productVersionId (optional) Product version identifier.
526
678
  * @param skip (optional) Defines page start offset from beginning of sorted result list.
527
679
  * @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
528
680
  * @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC".
@@ -535,7 +687,7 @@ export interface IProductsApiClient {
535
687
  * Returns a product link.
536
688
  * @param id Product identifier.
537
689
  * @param productLinkId Product link identifier.
538
- * @param productVersionId (optional)
690
+ * @param productVersionId (optional) Product version identifier.
539
691
  * @param tenantId (optional) Tenant identifier.
540
692
  * @return Success
541
693
  */
@@ -702,7 +854,7 @@ export declare class ProductsApiClient extends ApiClientBase implements IProduct
702
854
  /**
703
855
  * Returns a list of product links.
704
856
  * @param id Product identifier.
705
- * @param productVersionId (optional)
857
+ * @param productVersionId (optional) Product version identifier.
706
858
  * @param skip (optional) Defines page start offset from beginning of sorted result list.
707
859
  * @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
708
860
  * @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC".
@@ -716,7 +868,7 @@ export declare class ProductsApiClient extends ApiClientBase implements IProduct
716
868
  * Returns a product link.
717
869
  * @param id Product identifier.
718
870
  * @param productLinkId Product link identifier.
719
- * @param productVersionId (optional)
871
+ * @param productVersionId (optional) Product version identifier.
720
872
  * @param tenantId (optional) Tenant identifier.
721
873
  * @return Success
722
874
  */
@@ -1509,72 +1661,90 @@ export interface ImageInfo {
1509
1661
  /** Product Resource URL. */
1510
1662
  url?: string | null;
1511
1663
  }
1512
- /** Available option types. */
1513
- export declare enum OptionType {
1514
- Simple = "Simple",
1515
- Size = "Size",
1516
- PageCount = "PageCount"
1517
- }
1518
- /** DTO class, containing information about a product filter option. */
1519
- export interface ProductFilterOptionDto {
1520
- /** Product option identifier. */
1521
- productOptionId?: number | null;
1522
- /** Product option value identifier. */
1523
- productOptionValueId?: number | null;
1524
- /** Product option type ('Simple' / 'Size' / 'PageCount'). */
1525
- productOptionType?: OptionType;
1526
- /** Product option traits. */
1527
- productOptionTraits?: string[] | null;
1528
- /** Product option title. */
1529
- productOptionTitle?: string | null;
1530
- /** Product option value title. */
1531
- productOptionValueTitle?: string | null;
1532
- /** Indicates if option value should be used as a default value for corresponding option. */
1533
- isDefault?: boolean;
1664
+ /** Product bundle resource type. */
1665
+ export declare enum ProductBundleResourceType {
1666
+ Custom = "Custom",
1667
+ Preview = "Preview"
1534
1668
  }
1535
- /** DTO class, containing information about a product link. */
1536
- export interface ProductLinkDto {
1537
- /** Product link identifier. */
1669
+ /** DTO class, containing information about a product bundle resource. */
1670
+ export interface ProductBundleResourceDto {
1671
+ /** Product bundle resource identifier. */
1538
1672
  id?: number;
1539
- /** Product link version identifier. */
1540
- productLinkVersionId?: number;
1541
- /** Linked product identifier. */
1542
- productId?: number;
1543
- /** Linked product version identifier. */
1544
- productVersionId?: number;
1545
1673
  /** Tenant identifier. */
1546
1674
  tenantId?: number;
1547
- /** Product link name. */
1675
+ /** Resource identifier. */
1676
+ resourceId?: string | null;
1677
+ /** Resource name. */
1548
1678
  name?: string | null;
1549
- /** Product link description. */
1679
+ /** Resource namespace. */
1680
+ namespace?: string | null;
1681
+ /** Resource type. */
1682
+ type?: ProductBundleResourceType;
1683
+ /** Resource URL. */
1684
+ url?: string | null;
1685
+ }
1686
+ /** DTO class, containing information about a product bundle item. */
1687
+ export interface ProductBundleItemDto {
1688
+ /** Product bundle item identifier. */
1689
+ id?: number;
1690
+ /** Product bundle item name. */
1691
+ name?: string | null;
1692
+ /** Product bundle item description. */
1550
1693
  description?: string | null;
1551
- /** Product filter identifier. */
1552
- productFilterId?: number;
1553
- /** Product link image info. */
1694
+ /** Bundled product identifier. */
1695
+ productId?: number | null;
1696
+ /** Bundled product version identifier. */
1697
+ productVersionId?: number | null;
1698
+ /** Bundled product name. */
1699
+ productName?: string | null;
1700
+ /** Bundled product variant identifier. */
1701
+ productVariantId?: number | null;
1702
+ /** Bundled product variant UID. */
1703
+ productVariantUID?: string | null;
1704
+ /** Bundled product variant Name. */
1705
+ productVariantName?: string | null;
1706
+ /** Bundled product variant SKU. */
1707
+ productVariantSku?: string | null;
1708
+ /** Product bundle item image info. */
1554
1709
  image?: ImageInfo | null;
1555
- /** Product link creation time. */
1710
+ /** Product bundle item resources. */
1711
+ resources?: ProductBundleResourceDto[] | null;
1712
+ }
1713
+ /** DTO class, containing information about a product bundle. */
1714
+ export interface ProductBundleDto {
1715
+ /** Product bundle identifier. */
1716
+ id?: number;
1717
+ /** Product bundle version identifier. */
1718
+ productBundleVersionId?: number;
1719
+ /** Tenant identifier. */
1720
+ tenantId?: number;
1721
+ /** Product bundle name. */
1722
+ name?: string | null;
1723
+ /** Product bundle description. */
1724
+ description?: string | null;
1725
+ /** Product bundle creation time. */
1556
1726
  created?: string;
1557
- /** Product link modification time. */
1727
+ /** Product bundle las modification time. */
1558
1728
  lastModified?: string | null;
1559
- /** Product filter options. */
1560
- productFilterOptions?: ProductFilterOptionDto[] | null;
1561
1729
  /** Personalization workflow identifier. */
1562
1730
  personalizationWorkflowId?: number | null;
1563
- /** Processing pipeline identifier. */
1564
- processingPipelineId?: number | null;
1565
- /** Default storefront identifier. */
1566
- storefrontId?: number | null;
1567
- /** Default storefront product identifier. */
1568
- storefrontProductId?: string | null;
1569
- /** Default storefront product name. */
1570
- storefrontProductName?: string | null;
1731
+ /** Product bundle custom fields. */
1732
+ customFields?: {
1733
+ [key: string]: string;
1734
+ } | null;
1735
+ /** Product bundle image info. */
1736
+ image?: ImageInfo | null;
1737
+ /** Product bundle items. */
1738
+ items?: ProductBundleItemDto[] | null;
1739
+ /** Product bundle resources. */
1740
+ resources?: ProductBundleResourceDto[] | null;
1571
1741
  }
1572
1742
  /** Paged list of items. */
1573
- export interface PagedOfProductLinkDto {
1743
+ export interface PagedOfProductBundleDto {
1574
1744
  /** Items count. */
1575
1745
  total?: number;
1576
1746
  /** Items list. */
1577
- items?: ProductLinkDto[] | null;
1747
+ items?: ProductBundleDto[] | null;
1578
1748
  }
1579
1749
  /** Conflict types. */
1580
1750
  export declare enum ConflictType {
@@ -1678,6 +1848,10 @@ export interface ProductSummaryDto {
1678
1848
  productLinkVersionId?: number | null;
1679
1849
  /** Product filter identifier for product link. If product link is not specified, should be null. */
1680
1850
  productFilterId?: number | null;
1851
+ /** Product bundle identifier. If product bundle is not specified, should be null. */
1852
+ productBundleId?: number | null;
1853
+ /** Product bundle version identifier. If product bundle is not specified, should be null. */
1854
+ productBundleVersionId?: number | null;
1681
1855
  /** Product variant identifier. If product variant is not specified, should be null. */
1682
1856
  productVariantId?: number | null;
1683
1857
  /** Product variant SKU. If product variant is not specified, should be null. */
@@ -1724,11 +1898,103 @@ export interface PersonalizationWorkflowDto {
1724
1898
  /** Workflow type. */
1725
1899
  workflowType?: WorkflowType;
1726
1900
  }
1901
+ /** Product link resource type. */
1902
+ export declare enum ProductLinkResourceType {
1903
+ Preview = "Preview",
1904
+ Custom = "Custom"
1905
+ }
1906
+ /** DTO class, containing information about a product link resource. */
1907
+ export interface ProductLinkResourceDto {
1908
+ /** Product link resource identifier. */
1909
+ id?: number;
1910
+ /** Tenant identifier. */
1911
+ tenantId?: number;
1912
+ /** Resource identifier. */
1913
+ resourceId?: string | null;
1914
+ /** Resource name. */
1915
+ name?: string | null;
1916
+ /** Resource namespace. */
1917
+ namespace?: string | null;
1918
+ /** Resource type. */
1919
+ type?: ProductLinkResourceType;
1920
+ /** Resource URL. */
1921
+ url?: string | null;
1922
+ }
1923
+ /** Available option types. */
1924
+ export declare enum OptionType {
1925
+ Simple = "Simple",
1926
+ Size = "Size",
1927
+ PageCount = "PageCount"
1928
+ }
1929
+ /** DTO class, containing information about a product filter option. */
1930
+ export interface ProductFilterOptionDto {
1931
+ /** Product option identifier. */
1932
+ productOptionId?: number | null;
1933
+ /** Product option value identifier. */
1934
+ productOptionValueId?: number | null;
1935
+ /** Product option type ('Simple' / 'Size' / 'PageCount'). */
1936
+ productOptionType?: OptionType;
1937
+ /** Product option traits. */
1938
+ productOptionTraits?: string[] | null;
1939
+ /** Product option title. */
1940
+ productOptionTitle?: string | null;
1941
+ /** Product option value title. */
1942
+ productOptionValueTitle?: string | null;
1943
+ /** Indicates if option value should be used as a default value for corresponding option. */
1944
+ isDefault?: boolean;
1945
+ }
1946
+ /** DTO class, containing information about a product link. */
1947
+ export interface ProductLinkDto {
1948
+ /** Product link identifier. */
1949
+ id?: number;
1950
+ /** Product link version identifier. */
1951
+ productLinkVersionId?: number;
1952
+ /** Linked product identifier. */
1953
+ productId?: number;
1954
+ /** Linked product version identifier. */
1955
+ productVersionId?: number;
1956
+ /** Tenant identifier. */
1957
+ tenantId?: number;
1958
+ /** Product link name. */
1959
+ name?: string | null;
1960
+ /** Product link description. */
1961
+ description?: string | null;
1962
+ /** Product filter identifier. */
1963
+ productFilterId?: number;
1964
+ /** Product link image info. */
1965
+ image?: ImageInfo | null;
1966
+ /** Product link resources. */
1967
+ resources?: ProductLinkResourceDto[] | null;
1968
+ /** Product link creation time. */
1969
+ created?: string;
1970
+ /** Product link modification time. */
1971
+ lastModified?: string | null;
1972
+ /** Product filter options. */
1973
+ productFilterOptions?: ProductFilterOptionDto[] | null;
1974
+ /** Personalization workflow identifier. */
1975
+ personalizationWorkflowId?: number | null;
1976
+ /** Processing pipeline identifier. */
1977
+ processingPipelineId?: number | null;
1978
+ /** Default storefront identifier. */
1979
+ storefrontId?: number | null;
1980
+ /** Default storefront product identifier. */
1981
+ storefrontProductId?: string | null;
1982
+ /** Default storefront product name. */
1983
+ storefrontProductName?: string | null;
1984
+ }
1985
+ /** Paged list of items. */
1986
+ export interface PagedOfProductLinkDto {
1987
+ /** Items count. */
1988
+ total?: number;
1989
+ /** Items list. */
1990
+ items?: ProductLinkDto[] | null;
1991
+ }
1727
1992
  /** Available product reference target types. */
1728
1993
  export declare enum ProductReferenceType {
1729
1994
  ProductSpecification = "ProductSpecification",
1730
1995
  Product = "Product",
1731
- ProductLink = "ProductLink"
1996
+ ProductLink = "ProductLink",
1997
+ ProductBundle = "ProductBundle"
1732
1998
  }
1733
1999
  /** DTO class, containing information about storefront product reference. */
1734
2000
  export interface ProductReferenceDto {
@@ -1746,6 +2012,8 @@ export interface ProductReferenceDto {
1746
2012
  productVersionId?: number;
1747
2013
  /** Customer's Canvas product link identifier. */
1748
2014
  productLinkId?: number;
2015
+ /** Customer's Canvas product bundle identifier. */
2016
+ productBundleId?: number;
1749
2017
  /** Storefront identifier. */
1750
2018
  storefrontId?: number;
1751
2019
  /** Tenant identifier. */
@@ -2087,6 +2355,8 @@ export interface ProductVariantMockupDto {
2087
2355
  mockupId?: string | null;
2088
2356
  /** Mockup name. */
2089
2357
  mockupName?: string | null;
2358
+ /** Mockup validation type. */
2359
+ mockupValidationType?: string | null;
2090
2360
  /** Mockup type. */
2091
2361
  mockupType?: ProductVariantMockupType;
2092
2362
  /** Surface index indicates a surface of a design to which mockup should be applied. */
@@ -2178,6 +2448,8 @@ export interface ProjectItemDto {
2178
2448
  id?: number;
2179
2449
  /** Item name. */
2180
2450
  name?: string | null;
2451
+ /** Project item group identifier. */
2452
+ groupId?: string | null;
2181
2453
  /** Item quantity information. */
2182
2454
  quantity?: number | null;
2183
2455
  /** Order item identifier from storefront order. */
@@ -2258,10 +2530,31 @@ export interface ProjectItemResourceParametersDto {
2258
2530
  /** Original resource identifier. */
2259
2531
  resourceId?: string | null;
2260
2532
  }
2533
+ export declare enum ProjectItemProductType {
2534
+ ProductSpecification = "ProductSpecification",
2535
+ Product = "Product",
2536
+ ProductLink = "ProductLink"
2537
+ }
2538
+ /** Additional project item product information description. */
2539
+ export interface ProjectItemProductSpecifierDto {
2540
+ /** Customer's Canvas product type. */
2541
+ type?: ProjectItemProductType;
2542
+ /** Customer's Canvas product identifier.
2543
+ May keep reference to `Product`, `Product Specification` and `Product Link` (depending on `Type` value). */
2544
+ id?: number | null;
2545
+ /** Customer's Canvas product version identifier.
2546
+ May keep reference to version of `Product`, or `Product Link` (depending on `Type` value). */
2547
+ versionId?: number | null;
2548
+ /** Customer's Canvas product variant identifier.
2549
+ May keep reference to version of `Product` (depending on `Type` value). */
2550
+ variantId?: number | null;
2551
+ }
2261
2552
  /** Dto class, containing create operation parameters for a project item. */
2262
2553
  export interface ProjectItemParametersDto {
2263
2554
  /** Item name. */
2264
2555
  name?: string | null;
2556
+ /** Project item group identifier. */
2557
+ groupId?: string | null;
2265
2558
  /** Item quantity information. */
2266
2559
  quantity?: number | null;
2267
2560
  /** Line item index from ecommerce system order. */
@@ -2282,6 +2575,8 @@ export interface ProjectItemParametersDto {
2282
2575
  sku?: string | null;
2283
2576
  /** External resources descriptions. */
2284
2577
  resources?: ProjectItemResourceParametersDto[] | null;
2578
+ /** Additional project item product information description. */
2579
+ productSpecifier?: ProjectItemProductSpecifierDto | null;
2285
2580
  }
2286
2581
  /** Dto class, containing create operation parameters for single-item project entity. */
2287
2582
  export interface CreateSingleItemProjectDto {