@aurigma/ng-storefront-api-client 2.59.1 → 2.60.2

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.
@@ -88,6 +88,92 @@ export declare class ProcessingPipelinesApiClient extends ApiClientBase implemen
88
88
  get(id: number, tenantId?: number | null | undefined): Observable<ProcessingPipelineDto>;
89
89
  protected processGet(response: HttpResponseBase): Observable<ProcessingPipelineDto>;
90
90
  }
91
+ export interface IProductBundlesApiClient {
92
+ /**
93
+ * Returns all product bundles, relevant to the specified query parameters.
94
+ * @param skip (optional) Defines page start offset from beginning of sorted result list.
95
+ * @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
96
+ * @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC".
97
+ * @param search (optional) Search string for partial match.
98
+ * @param customFields (optional) Serialized custom fields dictionary filter. For example: {"public":"true","name":"my item"}
99
+ * @param tenantId (optional) Tenant identifier.
100
+ * @return Success
101
+ */
102
+ 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): Observable<PagedOfProductBundleDto>;
103
+ /**
104
+ * Returns a product bundle by its identifier.
105
+ * @param id Product identifier.
106
+ * @param productBundleVersionId (optional) Product bundle version identifier. Optional
107
+ * @param tenantId (optional) Tenant identifier.
108
+ * @return Success
109
+ */
110
+ getProductBundle(id: number, productBundleVersionId?: number | null | undefined, tenantId?: number | null | undefined): Observable<ProductBundleDto>;
111
+ /**
112
+ * Returns a product bundle summary by product bundle identifier.
113
+ * @param id Product bundle identifier.
114
+ * @param productBundleVersionId (optional) Product bundle version identifier.
115
+ * @param productVariantId (optional) Product variant identifier.
116
+ * @param sku (optional) Product variant SKU.
117
+ * @param tenantId (optional) Tenant identifier.
118
+ * @return Success
119
+ */
120
+ getProductSummary(id: number, productBundleVersionId?: number | null | undefined, productVariantId?: number | null | undefined, sku?: string | null | undefined, tenantId?: number | null | undefined): Observable<ProductSummaryDto>;
121
+ /**
122
+ * Returns a product bundle personalization workflow description by product bundle identifier.
123
+ * @param id Product bundle identifier.
124
+ * @param productBundleVersionId (optional) Product bundle version identifier.
125
+ * @param tenantId (optional) Tenant identifier.
126
+ * @return Success
127
+ */
128
+ getPersonalizationWorkflow(id: number, productBundleVersionId?: number | null | undefined, tenantId?: number | null | undefined): Observable<PersonalizationWorkflowDto>;
129
+ }
130
+ export declare class ProductBundlesApiClient extends ApiClientBase implements IProductBundlesApiClient {
131
+ private http;
132
+ private baseUrl;
133
+ protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
134
+ constructor(configuration: ApiClientConfiguration, http: HttpClient, baseUrl?: string);
135
+ /**
136
+ * Returns all product bundles, relevant to the specified query parameters.
137
+ * @param skip (optional) Defines page start offset from beginning of sorted result list.
138
+ * @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
139
+ * @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC".
140
+ * @param search (optional) Search string for partial match.
141
+ * @param customFields (optional) Serialized custom fields dictionary filter. For example: {"public":"true","name":"my item"}
142
+ * @param tenantId (optional) Tenant identifier.
143
+ * @return Success
144
+ */
145
+ 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): Observable<PagedOfProductBundleDto>;
146
+ protected processGetAllProductBundles(response: HttpResponseBase): Observable<PagedOfProductBundleDto>;
147
+ /**
148
+ * Returns a product bundle by its identifier.
149
+ * @param id Product identifier.
150
+ * @param productBundleVersionId (optional) Product bundle version identifier. Optional
151
+ * @param tenantId (optional) Tenant identifier.
152
+ * @return Success
153
+ */
154
+ getProductBundle(id: number, productBundleVersionId?: number | null | undefined, tenantId?: number | null | undefined): Observable<ProductBundleDto>;
155
+ protected processGetProductBundle(response: HttpResponseBase): Observable<ProductBundleDto>;
156
+ /**
157
+ * Returns a product bundle summary by product bundle identifier.
158
+ * @param id Product bundle identifier.
159
+ * @param productBundleVersionId (optional) Product bundle version identifier.
160
+ * @param productVariantId (optional) Product variant identifier.
161
+ * @param sku (optional) Product variant SKU.
162
+ * @param tenantId (optional) Tenant identifier.
163
+ * @return Success
164
+ */
165
+ getProductSummary(id: number, productBundleVersionId?: number | null | undefined, productVariantId?: number | null | undefined, sku?: string | null | undefined, tenantId?: number | null | undefined): Observable<ProductSummaryDto>;
166
+ protected processGetProductSummary(response: HttpResponseBase): Observable<ProductSummaryDto>;
167
+ /**
168
+ * Returns a product bundle personalization workflow description by product bundle identifier.
169
+ * @param id Product bundle identifier.
170
+ * @param productBundleVersionId (optional) Product bundle version identifier.
171
+ * @param tenantId (optional) Tenant identifier.
172
+ * @return Success
173
+ */
174
+ getPersonalizationWorkflow(id: number, productBundleVersionId?: number | null | undefined, tenantId?: number | null | undefined): Observable<PersonalizationWorkflowDto>;
175
+ protected processGetPersonalizationWorkflow(response: HttpResponseBase): Observable<PersonalizationWorkflowDto>;
176
+ }
91
177
  export interface IProductLinksApiClient {
92
178
  /**
93
179
  * Returns all product links, relevant to the specified query parameters.
@@ -189,6 +275,7 @@ export interface IProductReferencesApiClient {
189
275
  * @param productSpecificationId (optional) Customer's Canvas product specification filter.
190
276
  * @param productId (optional) Customer's Canvas product filter.
191
277
  * @param productLinkId (optional) Customer's Canvas product link filter.
278
+ * @param productBundleId (optional) Customer's Canvas product bundle filter.
192
279
  * @param skip (optional) Defines page start offset from beginning of sorted result list.
193
280
  * @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
194
281
  * @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC".
@@ -199,7 +286,7 @@ export interface IProductReferencesApiClient {
199
286
  * @param tenantId (optional) Tenant identifier.
200
287
  * @return Success
201
288
  */
202
- 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): Observable<PagedOfProductReferenceDto>;
289
+ 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): Observable<PagedOfProductReferenceDto>;
203
290
  /**
204
291
  * Returns a list of product specifications associated with storefront product references relevant to the specified query parameters.
205
292
  * @param storefrontId Storefront identifier.
@@ -208,6 +295,7 @@ export interface IProductReferencesApiClient {
208
295
  * @param productSpecificationId (optional) Customer's Canvas product specification filter.
209
296
  * @param productId (optional) Customer's Canvas product filter.
210
297
  * @param productLinkId (optional) Customer's Canvas product link filter.
298
+ * @param productBundleId (optional) Customer's Canvas product bundle filter.
211
299
  * @param skip (optional) Defines page start offset from beginning of sorted result list.
212
300
  * @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
213
301
  * @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC".
@@ -218,7 +306,7 @@ export interface IProductReferencesApiClient {
218
306
  * @param tenantId (optional) Tenant identifier.
219
307
  * @return Success
220
308
  */
221
- 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): Observable<PagedOfProductSpecificationDto>;
309
+ 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): Observable<PagedOfProductSpecificationDto>;
222
310
  /**
223
311
  * Returns a list of products associated with storefront product references relevant to the specified query parameters.
224
312
  * @param storefrontId Storefront identifier.
@@ -227,6 +315,7 @@ export interface IProductReferencesApiClient {
227
315
  * @param productSpecificationId (optional) Customer's Canvas product specification filter.
228
316
  * @param productId (optional) Customer's Canvas product filter.
229
317
  * @param productLinkId (optional) Customer's Canvas product link filter.
318
+ * @param productBundleId (optional) Customer's Canvas product bundle filter.
230
319
  * @param skip (optional) Defines page start offset from beginning of sorted result list.
231
320
  * @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
232
321
  * @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC".
@@ -237,7 +326,7 @@ export interface IProductReferencesApiClient {
237
326
  * @param tenantId (optional) Tenant identifier.
238
327
  * @return Success
239
328
  */
240
- 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): Observable<PagedOfProductDto>;
329
+ 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): Observable<PagedOfProductDto>;
241
330
  /**
242
331
  * Returns a list of product links associated with storefront product references relevant to the specified query parameters.
243
332
  * @param storefrontId Storefront identifier.
@@ -246,6 +335,27 @@ export interface IProductReferencesApiClient {
246
335
  * @param productSpecificationId (optional) Customer's Canvas product specification filter.
247
336
  * @param productId (optional) Customer's Canvas product filter.
248
337
  * @param productLinkId (optional) Customer's Canvas product link filter.
338
+ * @param productBundleId (optional) Customer's Canvas product bundle filter.
339
+ * @param skip (optional) Defines page start offset from beginning of sorted result list.
340
+ * @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
341
+ * @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC".
342
+ * @param search (optional) Search string for partial match.
343
+ * @param sku (optional) SKU filter.
344
+ * @param tags (optional) List of tags that product should have.
345
+ * @param customFields (optional) Serialized custom fields dictionary filter. For example: {"public":"true","name":"my item"}.
346
+ * @param tenantId (optional) Tenant identifier.
347
+ * @return Success
348
+ */
349
+ 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): Observable<PagedOfProductLinkDto>;
350
+ /**
351
+ * Returns a list of product bundles associated with storefront product references relevant to the specified query parameters.
352
+ * @param storefrontId Storefront identifier.
353
+ * @param productReference (optional) Product reference filter.
354
+ Product reference is an external reference to Customer's Canvas product, e.g online store product identifier.
355
+ * @param productSpecificationId (optional) Customer's Canvas product specification filter.
356
+ * @param productId (optional) Customer's Canvas product filter.
357
+ * @param productLinkId (optional) Customer's Canvas product link filter.
358
+ * @param productBundleId (optional) Customer's Canvas product bundle filter.
249
359
  * @param skip (optional) Defines page start offset from beginning of sorted result list.
250
360
  * @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
251
361
  * @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC".
@@ -256,7 +366,7 @@ export interface IProductReferencesApiClient {
256
366
  * @param tenantId (optional) Tenant identifier.
257
367
  * @return Success
258
368
  */
259
- 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): Observable<PagedOfProductLinkDto>;
369
+ 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): Observable<PagedOfProductBundleDto>;
260
370
  /**
261
371
  * Returns a storefront product reference.
262
372
  * @param reference An external reference to Customer's Canvas product, e.g online store product identifier.
@@ -299,6 +409,14 @@ export interface IProductReferencesApiClient {
299
409
  * @return Success
300
410
  */
301
411
  getProductLink(reference: string | null, storefrontId: number, tenantId?: number | null | undefined): Observable<ProductLinkDto>;
412
+ /**
413
+ * Returns a product bundle by storefront product reference.
414
+ * @param reference An external reference to Customer's Canvas product, e.g online store product identifier.
415
+ * @param storefrontId Storefront identifier.
416
+ * @param tenantId (optional) Tenant identifier.
417
+ * @return Success
418
+ */
419
+ getProductBundle(reference: string | null, storefrontId: number, tenantId?: number | null | undefined): Observable<ProductBundleDto>;
302
420
  /**
303
421
  * Returns a product cost details from ecommerce system.
304
422
  * @param reference An external reference to Customer's Canvas product, e.g online store product identifier.
@@ -333,6 +451,7 @@ export declare class ProductReferencesApiClient extends ApiClientBase implements
333
451
  * @param productSpecificationId (optional) Customer's Canvas product specification filter.
334
452
  * @param productId (optional) Customer's Canvas product filter.
335
453
  * @param productLinkId (optional) Customer's Canvas product link filter.
454
+ * @param productBundleId (optional) Customer's Canvas product bundle filter.
336
455
  * @param skip (optional) Defines page start offset from beginning of sorted result list.
337
456
  * @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
338
457
  * @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC".
@@ -343,7 +462,7 @@ export declare class ProductReferencesApiClient extends ApiClientBase implements
343
462
  * @param tenantId (optional) Tenant identifier.
344
463
  * @return Success
345
464
  */
346
- 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): Observable<PagedOfProductReferenceDto>;
465
+ 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): Observable<PagedOfProductReferenceDto>;
347
466
  protected processGetAll(response: HttpResponseBase): Observable<PagedOfProductReferenceDto>;
348
467
  /**
349
468
  * Returns a list of product specifications associated with storefront product references relevant to the specified query parameters.
@@ -353,6 +472,7 @@ export declare class ProductReferencesApiClient extends ApiClientBase implements
353
472
  * @param productSpecificationId (optional) Customer's Canvas product specification filter.
354
473
  * @param productId (optional) Customer's Canvas product filter.
355
474
  * @param productLinkId (optional) Customer's Canvas product link filter.
475
+ * @param productBundleId (optional) Customer's Canvas product bundle filter.
356
476
  * @param skip (optional) Defines page start offset from beginning of sorted result list.
357
477
  * @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
358
478
  * @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC".
@@ -363,7 +483,7 @@ export declare class ProductReferencesApiClient extends ApiClientBase implements
363
483
  * @param tenantId (optional) Tenant identifier.
364
484
  * @return Success
365
485
  */
366
- 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): Observable<PagedOfProductSpecificationDto>;
486
+ 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): Observable<PagedOfProductSpecificationDto>;
367
487
  protected processGetAllProductSpecifications(response: HttpResponseBase): Observable<PagedOfProductSpecificationDto>;
368
488
  /**
369
489
  * Returns a list of products associated with storefront product references relevant to the specified query parameters.
@@ -373,6 +493,7 @@ export declare class ProductReferencesApiClient extends ApiClientBase implements
373
493
  * @param productSpecificationId (optional) Customer's Canvas product specification filter.
374
494
  * @param productId (optional) Customer's Canvas product filter.
375
495
  * @param productLinkId (optional) Customer's Canvas product link filter.
496
+ * @param productBundleId (optional) Customer's Canvas product bundle filter.
376
497
  * @param skip (optional) Defines page start offset from beginning of sorted result list.
377
498
  * @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
378
499
  * @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC".
@@ -383,7 +504,7 @@ export declare class ProductReferencesApiClient extends ApiClientBase implements
383
504
  * @param tenantId (optional) Tenant identifier.
384
505
  * @return Success
385
506
  */
386
- 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): Observable<PagedOfProductDto>;
507
+ 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): Observable<PagedOfProductDto>;
387
508
  protected processGetAllProducts(response: HttpResponseBase): Observable<PagedOfProductDto>;
388
509
  /**
389
510
  * Returns a list of product links associated with storefront product references relevant to the specified query parameters.
@@ -393,6 +514,7 @@ export declare class ProductReferencesApiClient extends ApiClientBase implements
393
514
  * @param productSpecificationId (optional) Customer's Canvas product specification filter.
394
515
  * @param productId (optional) Customer's Canvas product filter.
395
516
  * @param productLinkId (optional) Customer's Canvas product link filter.
517
+ * @param productBundleId (optional) Customer's Canvas product bundle filter.
396
518
  * @param skip (optional) Defines page start offset from beginning of sorted result list.
397
519
  * @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
398
520
  * @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC".
@@ -403,8 +525,29 @@ export declare class ProductReferencesApiClient extends ApiClientBase implements
403
525
  * @param tenantId (optional) Tenant identifier.
404
526
  * @return Success
405
527
  */
406
- 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): Observable<PagedOfProductLinkDto>;
528
+ 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): Observable<PagedOfProductLinkDto>;
407
529
  protected processGetAllProductLinks(response: HttpResponseBase): Observable<PagedOfProductLinkDto>;
530
+ /**
531
+ * Returns a list of product bundles associated with storefront product references relevant to the specified query parameters.
532
+ * @param storefrontId Storefront identifier.
533
+ * @param productReference (optional) Product reference filter.
534
+ Product reference is an external reference to Customer's Canvas product, e.g online store product identifier.
535
+ * @param productSpecificationId (optional) Customer's Canvas product specification filter.
536
+ * @param productId (optional) Customer's Canvas product filter.
537
+ * @param productLinkId (optional) Customer's Canvas product link filter.
538
+ * @param productBundleId (optional) Customer's Canvas product bundle filter.
539
+ * @param skip (optional) Defines page start offset from beginning of sorted result list.
540
+ * @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
541
+ * @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC".
542
+ * @param search (optional) Search string for partial match.
543
+ * @param sku (optional) SKU filter.
544
+ * @param tags (optional) List of tags that product should have.
545
+ * @param customFields (optional) Serialized custom fields dictionary filter. For example: {"public":"true","name":"my item"}.
546
+ * @param tenantId (optional) Tenant identifier.
547
+ * @return Success
548
+ */
549
+ 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): Observable<PagedOfProductBundleDto>;
550
+ protected processGetAllProductBundles(response: HttpResponseBase): Observable<PagedOfProductBundleDto>;
408
551
  /**
409
552
  * Returns a storefront product reference.
410
553
  * @param reference An external reference to Customer's Canvas product, e.g online store product identifier.
@@ -452,6 +595,15 @@ export declare class ProductReferencesApiClient extends ApiClientBase implements
452
595
  */
453
596
  getProductLink(reference: string | null, storefrontId: number, tenantId?: number | null | undefined): Observable<ProductLinkDto>;
454
597
  protected processGetProductLink(response: HttpResponseBase): Observable<ProductLinkDto>;
598
+ /**
599
+ * Returns a product bundle by storefront product reference.
600
+ * @param reference An external reference to Customer's Canvas product, e.g online store product identifier.
601
+ * @param storefrontId Storefront identifier.
602
+ * @param tenantId (optional) Tenant identifier.
603
+ * @return Success
604
+ */
605
+ getProductBundle(reference: string | null, storefrontId: number, tenantId?: number | null | undefined): Observable<ProductBundleDto>;
606
+ protected processGetProductBundle(response: HttpResponseBase): Observable<ProductBundleDto>;
455
607
  /**
456
608
  * Returns a product cost details from ecommerce system.
457
609
  * @param reference An external reference to Customer's Canvas product, e.g online store product identifier.
@@ -1512,72 +1664,86 @@ export interface ImageInfo {
1512
1664
  /** Product Resource URL. */
1513
1665
  url?: string | null;
1514
1666
  }
1515
- /** Available option types. */
1516
- export declare enum OptionType {
1517
- Simple = "Simple",
1518
- Size = "Size",
1519
- PageCount = "PageCount"
1667
+ /** Product bundle resource type. */
1668
+ export declare enum ProductBundleResourceType {
1669
+ Custom = "Custom",
1670
+ Preview = "Preview"
1520
1671
  }
1521
- /** DTO class, containing information about a product filter option. */
1522
- export interface ProductFilterOptionDto {
1523
- /** Product option identifier. */
1524
- productOptionId?: number | null;
1525
- /** Product option value identifier. */
1526
- productOptionValueId?: number | null;
1527
- /** Product option type ('Simple' / 'Size' / 'PageCount'). */
1528
- productOptionType?: OptionType;
1529
- /** Product option traits. */
1530
- productOptionTraits?: string[] | null;
1531
- /** Product option title. */
1532
- productOptionTitle?: string | null;
1533
- /** Product option value title. */
1534
- productOptionValueTitle?: string | null;
1535
- /** Indicates if option value should be used as a default value for corresponding option. */
1536
- isDefault?: boolean;
1672
+ /** DTO class, containing information about a product bundle resource. */
1673
+ export interface ProductBundleResourceDto {
1674
+ /** Product bundle resource identifier. */
1675
+ id?: number;
1676
+ /** Tenant identifier. */
1677
+ tenantId?: number;
1678
+ /** Resource identifier. */
1679
+ resourceId?: string | null;
1680
+ /** Resource name. */
1681
+ name?: string | null;
1682
+ /** Resource namespace. */
1683
+ namespace?: string | null;
1684
+ /** Resource type. */
1685
+ type?: ProductBundleResourceType;
1686
+ /** Resource URL. */
1687
+ url?: string | null;
1537
1688
  }
1538
- /** DTO class, containing information about a product link. */
1539
- export interface ProductLinkDto {
1540
- /** Product link identifier. */
1689
+ /** DTO class, containing information about a product bundle item. */
1690
+ export interface ProductBundleItemDto {
1691
+ /** Product bundle item identifier. */
1541
1692
  id?: number;
1542
- /** Product link version identifier. */
1543
- productLinkVersionId?: number;
1544
- /** Linked product identifier. */
1545
- productId?: number;
1546
- /** Linked product version identifier. */
1547
- productVersionId?: number;
1693
+ /** Bundled product identifier. */
1694
+ productId?: number | null;
1695
+ /** Bundled product version identifier. */
1696
+ productVersionId?: number | null;
1697
+ /** Bundled product name. */
1698
+ productName?: string | null;
1699
+ /** Bundled product variant identifier. */
1700
+ productVariantId?: number | null;
1701
+ /** Bundled product variant UID. */
1702
+ productVariantUID?: string | null;
1703
+ /** Bundled product variant Name. */
1704
+ productVariantName?: string | null;
1705
+ /** Bundled product variant SKU. */
1706
+ productVariantSku?: string | null;
1707
+ /** Product bundle item image info. */
1708
+ image?: ImageInfo | null;
1709
+ /** Product bundle item resources. */
1710
+ resources?: ProductBundleResourceDto[] | null;
1711
+ }
1712
+ /** DTO class, containing information about a product bundle. */
1713
+ export interface ProductBundleDto {
1714
+ /** Product bundle identifier. */
1715
+ id?: number;
1716
+ /** Product bundle version identifier. */
1717
+ productBundleVersionId?: number;
1548
1718
  /** Tenant identifier. */
1549
1719
  tenantId?: number;
1550
- /** Product link name. */
1720
+ /** Product bundle name. */
1551
1721
  name?: string | null;
1552
- /** Product link description. */
1722
+ /** Product bundle description. */
1553
1723
  description?: string | null;
1554
- /** Product filter identifier. */
1555
- productFilterId?: number;
1556
- /** Product link image info. */
1557
- image?: ImageInfo | null;
1558
- /** Product link creation time. */
1724
+ /** Product bundle creation time. */
1559
1725
  created?: string;
1560
- /** Product link modification time. */
1726
+ /** Product bundle las modification time. */
1561
1727
  lastModified?: string | null;
1562
- /** Product filter options. */
1563
- productFilterOptions?: ProductFilterOptionDto[] | null;
1564
1728
  /** Personalization workflow identifier. */
1565
1729
  personalizationWorkflowId?: number | null;
1566
- /** Processing pipeline identifier. */
1567
- processingPipelineId?: number | null;
1568
- /** Default storefront identifier. */
1569
- storefrontId?: number | null;
1570
- /** Default storefront product identifier. */
1571
- storefrontProductId?: string | null;
1572
- /** Default storefront product name. */
1573
- storefrontProductName?: string | null;
1730
+ /** Product bundle custom fields. */
1731
+ customFields?: {
1732
+ [key: string]: string;
1733
+ } | null;
1734
+ /** Product bundle image info. */
1735
+ image?: ImageInfo | null;
1736
+ /** Product bundle items. */
1737
+ items?: ProductBundleItemDto[] | null;
1738
+ /** Product bundle resources. */
1739
+ resources?: ProductBundleResourceDto[] | null;
1574
1740
  }
1575
1741
  /** Paged list of items. */
1576
- export interface PagedOfProductLinkDto {
1742
+ export interface PagedOfProductBundleDto {
1577
1743
  /** Items count. */
1578
1744
  total?: number;
1579
1745
  /** Items list. */
1580
- items?: ProductLinkDto[] | null;
1746
+ items?: ProductBundleDto[] | null;
1581
1747
  }
1582
1748
  /** Conflict types. */
1583
1749
  export declare enum ConflictType {
@@ -1681,6 +1847,10 @@ export interface ProductSummaryDto {
1681
1847
  productLinkVersionId?: number | null;
1682
1848
  /** Product filter identifier for product link. If product link is not specified, should be null. */
1683
1849
  productFilterId?: number | null;
1850
+ /** Product bundle identifier. If product bundle is not specified, should be null. */
1851
+ productBundleId?: number | null;
1852
+ /** Product bundle version identifier. If product bundle is not specified, should be null. */
1853
+ productBundleVersionId?: number | null;
1684
1854
  /** Product variant identifier. If product variant is not specified, should be null. */
1685
1855
  productVariantId?: number | null;
1686
1856
  /** Product variant SKU. If product variant is not specified, should be null. */
@@ -1727,11 +1897,103 @@ export interface PersonalizationWorkflowDto {
1727
1897
  /** Workflow type. */
1728
1898
  workflowType?: WorkflowType;
1729
1899
  }
1900
+ /** Product link resource type. */
1901
+ export declare enum ProductLinkResourceType {
1902
+ Preview = "Preview",
1903
+ Custom = "Custom"
1904
+ }
1905
+ /** DTO class, containing information about a product link resource. */
1906
+ export interface ProductLinkResourceDto {
1907
+ /** Product link resource identifier. */
1908
+ id?: number;
1909
+ /** Tenant identifier. */
1910
+ tenantId?: number;
1911
+ /** Resource identifier. */
1912
+ resourceId?: string | null;
1913
+ /** Resource name. */
1914
+ name?: string | null;
1915
+ /** Resource namespace. */
1916
+ namespace?: string | null;
1917
+ /** Resource type. */
1918
+ type?: ProductLinkResourceType;
1919
+ /** Resource URL. */
1920
+ url?: string | null;
1921
+ }
1922
+ /** Available option types. */
1923
+ export declare enum OptionType {
1924
+ Simple = "Simple",
1925
+ Size = "Size",
1926
+ PageCount = "PageCount"
1927
+ }
1928
+ /** DTO class, containing information about a product filter option. */
1929
+ export interface ProductFilterOptionDto {
1930
+ /** Product option identifier. */
1931
+ productOptionId?: number | null;
1932
+ /** Product option value identifier. */
1933
+ productOptionValueId?: number | null;
1934
+ /** Product option type ('Simple' / 'Size' / 'PageCount'). */
1935
+ productOptionType?: OptionType;
1936
+ /** Product option traits. */
1937
+ productOptionTraits?: string[] | null;
1938
+ /** Product option title. */
1939
+ productOptionTitle?: string | null;
1940
+ /** Product option value title. */
1941
+ productOptionValueTitle?: string | null;
1942
+ /** Indicates if option value should be used as a default value for corresponding option. */
1943
+ isDefault?: boolean;
1944
+ }
1945
+ /** DTO class, containing information about a product link. */
1946
+ export interface ProductLinkDto {
1947
+ /** Product link identifier. */
1948
+ id?: number;
1949
+ /** Product link version identifier. */
1950
+ productLinkVersionId?: number;
1951
+ /** Linked product identifier. */
1952
+ productId?: number;
1953
+ /** Linked product version identifier. */
1954
+ productVersionId?: number;
1955
+ /** Tenant identifier. */
1956
+ tenantId?: number;
1957
+ /** Product link name. */
1958
+ name?: string | null;
1959
+ /** Product link description. */
1960
+ description?: string | null;
1961
+ /** Product filter identifier. */
1962
+ productFilterId?: number;
1963
+ /** Product link image info. */
1964
+ image?: ImageInfo | null;
1965
+ /** Product link resources. */
1966
+ resources?: ProductLinkResourceDto[] | null;
1967
+ /** Product link creation time. */
1968
+ created?: string;
1969
+ /** Product link modification time. */
1970
+ lastModified?: string | null;
1971
+ /** Product filter options. */
1972
+ productFilterOptions?: ProductFilterOptionDto[] | null;
1973
+ /** Personalization workflow identifier. */
1974
+ personalizationWorkflowId?: number | null;
1975
+ /** Processing pipeline identifier. */
1976
+ processingPipelineId?: number | null;
1977
+ /** Default storefront identifier. */
1978
+ storefrontId?: number | null;
1979
+ /** Default storefront product identifier. */
1980
+ storefrontProductId?: string | null;
1981
+ /** Default storefront product name. */
1982
+ storefrontProductName?: string | null;
1983
+ }
1984
+ /** Paged list of items. */
1985
+ export interface PagedOfProductLinkDto {
1986
+ /** Items count. */
1987
+ total?: number;
1988
+ /** Items list. */
1989
+ items?: ProductLinkDto[] | null;
1990
+ }
1730
1991
  /** Available product reference target types. */
1731
1992
  export declare enum ProductReferenceType {
1732
1993
  ProductSpecification = "ProductSpecification",
1733
1994
  Product = "Product",
1734
- ProductLink = "ProductLink"
1995
+ ProductLink = "ProductLink",
1996
+ ProductBundle = "ProductBundle"
1735
1997
  }
1736
1998
  /** DTO class, containing information about storefront product reference. */
1737
1999
  export interface ProductReferenceDto {
@@ -1749,6 +2011,8 @@ export interface ProductReferenceDto {
1749
2011
  productVersionId?: number;
1750
2012
  /** Customer's Canvas product link identifier. */
1751
2013
  productLinkId?: number;
2014
+ /** Customer's Canvas product bundle identifier. */
2015
+ productBundleId?: number;
1752
2016
  /** Storefront identifier. */
1753
2017
  storefrontId?: number;
1754
2018
  /** Tenant identifier. */
@@ -2261,6 +2525,25 @@ export interface ProjectItemResourceParametersDto {
2261
2525
  /** Original resource identifier. */
2262
2526
  resourceId?: string | null;
2263
2527
  }
2528
+ export declare enum ProjectItemProductType {
2529
+ ProductSpecification = "ProductSpecification",
2530
+ Product = "Product",
2531
+ ProductLink = "ProductLink"
2532
+ }
2533
+ /** Additional project item product information description. */
2534
+ export interface ProjectItemProductSpecifierDto {
2535
+ /** Customer's Canvas product type. */
2536
+ type?: ProjectItemProductType;
2537
+ /** Customer's Canvas product identifier.
2538
+ May keep reference to `Product`, `Product Specification` and `Product Link` (depending on `Type` value). */
2539
+ id?: number | null;
2540
+ /** Customer's Canvas product version identifier.
2541
+ May keep reference to version of `Product`, or `Product Link` (depending on `Type` value). */
2542
+ versionId?: number | null;
2543
+ /** Customer's Canvas product variant identifier.
2544
+ May keep reference to version of `Product` (depending on `Type` value). */
2545
+ variantId?: number | null;
2546
+ }
2264
2547
  /** Dto class, containing create operation parameters for a project item. */
2265
2548
  export interface ProjectItemParametersDto {
2266
2549
  /** Item name. */
@@ -2285,6 +2568,8 @@ export interface ProjectItemParametersDto {
2285
2568
  sku?: string | null;
2286
2569
  /** External resources descriptions. */
2287
2570
  resources?: ProjectItemResourceParametersDto[] | null;
2571
+ /** Additional project item product information description. */
2572
+ productSpecifier?: ProjectItemProductSpecifierDto | null;
2288
2573
  }
2289
2574
  /** Dto class, containing create operation parameters for single-item project entity. */
2290
2575
  export interface CreateSingleItemProjectDto {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@aurigma/ng-storefront-api-client",
3
- "version": "2.59.1",
3
+ "version": "2.60.2",
4
4
  "license": "SEE LICENSE IN License.md",
5
5
  "description": "Angular API Client for Storefront API service of Customer's Canvas web-to-print system.",
6
6
  "author": "Aurigma Inc <info@aurigma.com> (https://customerscanvas.com)",