@aurigma/axios-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.
- package/dist/cjs/storefront-api-client.d.ts +344 -59
- package/dist/cjs/storefront-api-client.js +582 -12
- package/dist/cjs/storefront-api-client.js.map +1 -1
- package/dist/esm/storefront-api-client.d.ts +344 -59
- package/dist/esm/storefront-api-client.js +580 -11
- package/dist/esm/storefront-api-client.js.map +1 -1
- package/package.json +1 -1
|
@@ -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,27 @@ 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.
|
|
336
|
+
* @param skip (optional) Defines page start offset from beginning of sorted result list.
|
|
337
|
+
* @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
|
|
338
|
+
* @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC".
|
|
339
|
+
* @param search (optional) Search string for partial match.
|
|
340
|
+
* @param sku (optional) SKU filter.
|
|
341
|
+
* @param tags (optional) List of tags that product should have.
|
|
342
|
+
* @param customFields (optional) Serialized custom fields dictionary filter. For example: {"public":"true","name":"my item"}.
|
|
343
|
+
* @param tenantId (optional) Tenant identifier.
|
|
344
|
+
* @return Success
|
|
345
|
+
*/
|
|
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.
|
|
246
356
|
* @param skip (optional) Defines page start offset from beginning of sorted result list.
|
|
247
357
|
* @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
|
|
248
358
|
* @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC".
|
|
@@ -253,7 +363,7 @@ export interface IProductReferencesApiClient {
|
|
|
253
363
|
* @param tenantId (optional) Tenant identifier.
|
|
254
364
|
* @return Success
|
|
255
365
|
*/
|
|
256
|
-
|
|
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.
|
|
@@ -1509,72 +1661,86 @@ export interface ImageInfo {
|
|
|
1509
1661
|
/** Product Resource URL. */
|
|
1510
1662
|
url?: string | null;
|
|
1511
1663
|
}
|
|
1512
|
-
/**
|
|
1513
|
-
export declare enum
|
|
1514
|
-
|
|
1515
|
-
|
|
1516
|
-
PageCount = "PageCount"
|
|
1664
|
+
/** Product bundle resource type. */
|
|
1665
|
+
export declare enum ProductBundleResourceType {
|
|
1666
|
+
Custom = "Custom",
|
|
1667
|
+
Preview = "Preview"
|
|
1517
1668
|
}
|
|
1518
|
-
/** DTO class, containing information about a product
|
|
1519
|
-
export interface
|
|
1520
|
-
/** Product
|
|
1521
|
-
|
|
1522
|
-
/**
|
|
1523
|
-
|
|
1524
|
-
/**
|
|
1525
|
-
|
|
1526
|
-
/**
|
|
1527
|
-
|
|
1528
|
-
/**
|
|
1529
|
-
|
|
1530
|
-
/**
|
|
1531
|
-
|
|
1532
|
-
/**
|
|
1533
|
-
|
|
1669
|
+
/** DTO class, containing information about a product bundle resource. */
|
|
1670
|
+
export interface ProductBundleResourceDto {
|
|
1671
|
+
/** Product bundle resource identifier. */
|
|
1672
|
+
id?: number;
|
|
1673
|
+
/** Tenant identifier. */
|
|
1674
|
+
tenantId?: number;
|
|
1675
|
+
/** Resource identifier. */
|
|
1676
|
+
resourceId?: string | null;
|
|
1677
|
+
/** Resource name. */
|
|
1678
|
+
name?: string | null;
|
|
1679
|
+
/** Resource namespace. */
|
|
1680
|
+
namespace?: string | null;
|
|
1681
|
+
/** Resource type. */
|
|
1682
|
+
type?: ProductBundleResourceType;
|
|
1683
|
+
/** Resource URL. */
|
|
1684
|
+
url?: string | null;
|
|
1534
1685
|
}
|
|
1535
|
-
/** DTO class, containing information about a product
|
|
1536
|
-
export interface
|
|
1537
|
-
/** Product
|
|
1686
|
+
/** DTO class, containing information about a product bundle item. */
|
|
1687
|
+
export interface ProductBundleItemDto {
|
|
1688
|
+
/** Product bundle item identifier. */
|
|
1538
1689
|
id?: number;
|
|
1539
|
-
/**
|
|
1540
|
-
|
|
1541
|
-
/**
|
|
1542
|
-
|
|
1543
|
-
/**
|
|
1544
|
-
|
|
1690
|
+
/** Bundled product identifier. */
|
|
1691
|
+
productId?: number | null;
|
|
1692
|
+
/** Bundled product version identifier. */
|
|
1693
|
+
productVersionId?: number | null;
|
|
1694
|
+
/** Bundled product name. */
|
|
1695
|
+
productName?: string | null;
|
|
1696
|
+
/** Bundled product variant identifier. */
|
|
1697
|
+
productVariantId?: number | null;
|
|
1698
|
+
/** Bundled product variant UID. */
|
|
1699
|
+
productVariantUID?: string | null;
|
|
1700
|
+
/** Bundled product variant Name. */
|
|
1701
|
+
productVariantName?: string | null;
|
|
1702
|
+
/** Bundled product variant SKU. */
|
|
1703
|
+
productVariantSku?: string | null;
|
|
1704
|
+
/** Product bundle item image info. */
|
|
1705
|
+
image?: ImageInfo | null;
|
|
1706
|
+
/** Product bundle item resources. */
|
|
1707
|
+
resources?: ProductBundleResourceDto[] | null;
|
|
1708
|
+
}
|
|
1709
|
+
/** DTO class, containing information about a product bundle. */
|
|
1710
|
+
export interface ProductBundleDto {
|
|
1711
|
+
/** Product bundle identifier. */
|
|
1712
|
+
id?: number;
|
|
1713
|
+
/** Product bundle version identifier. */
|
|
1714
|
+
productBundleVersionId?: number;
|
|
1545
1715
|
/** Tenant identifier. */
|
|
1546
1716
|
tenantId?: number;
|
|
1547
|
-
/** Product
|
|
1717
|
+
/** Product bundle name. */
|
|
1548
1718
|
name?: string | null;
|
|
1549
|
-
/** Product
|
|
1719
|
+
/** Product bundle description. */
|
|
1550
1720
|
description?: string | null;
|
|
1551
|
-
/** Product
|
|
1552
|
-
productFilterId?: number;
|
|
1553
|
-
/** Product link image info. */
|
|
1554
|
-
image?: ImageInfo | null;
|
|
1555
|
-
/** Product link creation time. */
|
|
1721
|
+
/** Product bundle creation time. */
|
|
1556
1722
|
created?: string;
|
|
1557
|
-
/** Product
|
|
1723
|
+
/** Product bundle las modification time. */
|
|
1558
1724
|
lastModified?: string | null;
|
|
1559
|
-
/** Product filter options. */
|
|
1560
|
-
productFilterOptions?: ProductFilterOptionDto[] | null;
|
|
1561
1725
|
/** Personalization workflow identifier. */
|
|
1562
1726
|
personalizationWorkflowId?: number | null;
|
|
1563
|
-
/**
|
|
1564
|
-
|
|
1565
|
-
|
|
1566
|
-
|
|
1567
|
-
/**
|
|
1568
|
-
|
|
1569
|
-
/**
|
|
1570
|
-
|
|
1727
|
+
/** Product bundle custom fields. */
|
|
1728
|
+
customFields?: {
|
|
1729
|
+
[key: string]: string;
|
|
1730
|
+
} | null;
|
|
1731
|
+
/** Product bundle image info. */
|
|
1732
|
+
image?: ImageInfo | null;
|
|
1733
|
+
/** Product bundle items. */
|
|
1734
|
+
items?: ProductBundleItemDto[] | null;
|
|
1735
|
+
/** Product bundle resources. */
|
|
1736
|
+
resources?: ProductBundleResourceDto[] | null;
|
|
1571
1737
|
}
|
|
1572
1738
|
/** Paged list of items. */
|
|
1573
|
-
export interface
|
|
1739
|
+
export interface PagedOfProductBundleDto {
|
|
1574
1740
|
/** Items count. */
|
|
1575
1741
|
total?: number;
|
|
1576
1742
|
/** Items list. */
|
|
1577
|
-
items?:
|
|
1743
|
+
items?: ProductBundleDto[] | null;
|
|
1578
1744
|
}
|
|
1579
1745
|
/** Conflict types. */
|
|
1580
1746
|
export declare enum ConflictType {
|
|
@@ -1678,6 +1844,10 @@ export interface ProductSummaryDto {
|
|
|
1678
1844
|
productLinkVersionId?: number | null;
|
|
1679
1845
|
/** Product filter identifier for product link. If product link is not specified, should be null. */
|
|
1680
1846
|
productFilterId?: number | null;
|
|
1847
|
+
/** Product bundle identifier. If product bundle is not specified, should be null. */
|
|
1848
|
+
productBundleId?: number | null;
|
|
1849
|
+
/** Product bundle version identifier. If product bundle is not specified, should be null. */
|
|
1850
|
+
productBundleVersionId?: number | null;
|
|
1681
1851
|
/** Product variant identifier. If product variant is not specified, should be null. */
|
|
1682
1852
|
productVariantId?: number | null;
|
|
1683
1853
|
/** Product variant SKU. If product variant is not specified, should be null. */
|
|
@@ -1724,11 +1894,103 @@ export interface PersonalizationWorkflowDto {
|
|
|
1724
1894
|
/** Workflow type. */
|
|
1725
1895
|
workflowType?: WorkflowType;
|
|
1726
1896
|
}
|
|
1897
|
+
/** Product link resource type. */
|
|
1898
|
+
export declare enum ProductLinkResourceType {
|
|
1899
|
+
Preview = "Preview",
|
|
1900
|
+
Custom = "Custom"
|
|
1901
|
+
}
|
|
1902
|
+
/** DTO class, containing information about a product link resource. */
|
|
1903
|
+
export interface ProductLinkResourceDto {
|
|
1904
|
+
/** Product link resource identifier. */
|
|
1905
|
+
id?: number;
|
|
1906
|
+
/** Tenant identifier. */
|
|
1907
|
+
tenantId?: number;
|
|
1908
|
+
/** Resource identifier. */
|
|
1909
|
+
resourceId?: string | null;
|
|
1910
|
+
/** Resource name. */
|
|
1911
|
+
name?: string | null;
|
|
1912
|
+
/** Resource namespace. */
|
|
1913
|
+
namespace?: string | null;
|
|
1914
|
+
/** Resource type. */
|
|
1915
|
+
type?: ProductLinkResourceType;
|
|
1916
|
+
/** Resource URL. */
|
|
1917
|
+
url?: string | null;
|
|
1918
|
+
}
|
|
1919
|
+
/** Available option types. */
|
|
1920
|
+
export declare enum OptionType {
|
|
1921
|
+
Simple = "Simple",
|
|
1922
|
+
Size = "Size",
|
|
1923
|
+
PageCount = "PageCount"
|
|
1924
|
+
}
|
|
1925
|
+
/** DTO class, containing information about a product filter option. */
|
|
1926
|
+
export interface ProductFilterOptionDto {
|
|
1927
|
+
/** Product option identifier. */
|
|
1928
|
+
productOptionId?: number | null;
|
|
1929
|
+
/** Product option value identifier. */
|
|
1930
|
+
productOptionValueId?: number | null;
|
|
1931
|
+
/** Product option type ('Simple' / 'Size' / 'PageCount'). */
|
|
1932
|
+
productOptionType?: OptionType;
|
|
1933
|
+
/** Product option traits. */
|
|
1934
|
+
productOptionTraits?: string[] | null;
|
|
1935
|
+
/** Product option title. */
|
|
1936
|
+
productOptionTitle?: string | null;
|
|
1937
|
+
/** Product option value title. */
|
|
1938
|
+
productOptionValueTitle?: string | null;
|
|
1939
|
+
/** Indicates if option value should be used as a default value for corresponding option. */
|
|
1940
|
+
isDefault?: boolean;
|
|
1941
|
+
}
|
|
1942
|
+
/** DTO class, containing information about a product link. */
|
|
1943
|
+
export interface ProductLinkDto {
|
|
1944
|
+
/** Product link identifier. */
|
|
1945
|
+
id?: number;
|
|
1946
|
+
/** Product link version identifier. */
|
|
1947
|
+
productLinkVersionId?: number;
|
|
1948
|
+
/** Linked product identifier. */
|
|
1949
|
+
productId?: number;
|
|
1950
|
+
/** Linked product version identifier. */
|
|
1951
|
+
productVersionId?: number;
|
|
1952
|
+
/** Tenant identifier. */
|
|
1953
|
+
tenantId?: number;
|
|
1954
|
+
/** Product link name. */
|
|
1955
|
+
name?: string | null;
|
|
1956
|
+
/** Product link description. */
|
|
1957
|
+
description?: string | null;
|
|
1958
|
+
/** Product filter identifier. */
|
|
1959
|
+
productFilterId?: number;
|
|
1960
|
+
/** Product link image info. */
|
|
1961
|
+
image?: ImageInfo | null;
|
|
1962
|
+
/** Product link resources. */
|
|
1963
|
+
resources?: ProductLinkResourceDto[] | null;
|
|
1964
|
+
/** Product link creation time. */
|
|
1965
|
+
created?: string;
|
|
1966
|
+
/** Product link modification time. */
|
|
1967
|
+
lastModified?: string | null;
|
|
1968
|
+
/** Product filter options. */
|
|
1969
|
+
productFilterOptions?: ProductFilterOptionDto[] | null;
|
|
1970
|
+
/** Personalization workflow identifier. */
|
|
1971
|
+
personalizationWorkflowId?: number | null;
|
|
1972
|
+
/** Processing pipeline identifier. */
|
|
1973
|
+
processingPipelineId?: number | null;
|
|
1974
|
+
/** Default storefront identifier. */
|
|
1975
|
+
storefrontId?: number | null;
|
|
1976
|
+
/** Default storefront product identifier. */
|
|
1977
|
+
storefrontProductId?: string | null;
|
|
1978
|
+
/** Default storefront product name. */
|
|
1979
|
+
storefrontProductName?: string | null;
|
|
1980
|
+
}
|
|
1981
|
+
/** Paged list of items. */
|
|
1982
|
+
export interface PagedOfProductLinkDto {
|
|
1983
|
+
/** Items count. */
|
|
1984
|
+
total?: number;
|
|
1985
|
+
/** Items list. */
|
|
1986
|
+
items?: ProductLinkDto[] | null;
|
|
1987
|
+
}
|
|
1727
1988
|
/** Available product reference target types. */
|
|
1728
1989
|
export declare enum ProductReferenceType {
|
|
1729
1990
|
ProductSpecification = "ProductSpecification",
|
|
1730
1991
|
Product = "Product",
|
|
1731
|
-
ProductLink = "ProductLink"
|
|
1992
|
+
ProductLink = "ProductLink",
|
|
1993
|
+
ProductBundle = "ProductBundle"
|
|
1732
1994
|
}
|
|
1733
1995
|
/** DTO class, containing information about storefront product reference. */
|
|
1734
1996
|
export interface ProductReferenceDto {
|
|
@@ -1746,6 +2008,8 @@ export interface ProductReferenceDto {
|
|
|
1746
2008
|
productVersionId?: number;
|
|
1747
2009
|
/** Customer's Canvas product link identifier. */
|
|
1748
2010
|
productLinkId?: number;
|
|
2011
|
+
/** Customer's Canvas product bundle identifier. */
|
|
2012
|
+
productBundleId?: number;
|
|
1749
2013
|
/** Storefront identifier. */
|
|
1750
2014
|
storefrontId?: number;
|
|
1751
2015
|
/** Tenant identifier. */
|
|
@@ -2258,6 +2522,25 @@ export interface ProjectItemResourceParametersDto {
|
|
|
2258
2522
|
/** Original resource identifier. */
|
|
2259
2523
|
resourceId?: string | null;
|
|
2260
2524
|
}
|
|
2525
|
+
export declare enum ProjectItemProductType {
|
|
2526
|
+
ProductSpecification = "ProductSpecification",
|
|
2527
|
+
Product = "Product",
|
|
2528
|
+
ProductLink = "ProductLink"
|
|
2529
|
+
}
|
|
2530
|
+
/** Additional project item product information description. */
|
|
2531
|
+
export interface ProjectItemProductSpecifierDto {
|
|
2532
|
+
/** Customer's Canvas product type. */
|
|
2533
|
+
type?: ProjectItemProductType;
|
|
2534
|
+
/** Customer's Canvas product identifier.
|
|
2535
|
+
May keep reference to `Product`, `Product Specification` and `Product Link` (depending on `Type` value). */
|
|
2536
|
+
id?: number | null;
|
|
2537
|
+
/** Customer's Canvas product version identifier.
|
|
2538
|
+
May keep reference to version of `Product`, or `Product Link` (depending on `Type` value). */
|
|
2539
|
+
versionId?: number | null;
|
|
2540
|
+
/** Customer's Canvas product variant identifier.
|
|
2541
|
+
May keep reference to version of `Product` (depending on `Type` value). */
|
|
2542
|
+
variantId?: number | null;
|
|
2543
|
+
}
|
|
2261
2544
|
/** Dto class, containing create operation parameters for a project item. */
|
|
2262
2545
|
export interface ProjectItemParametersDto {
|
|
2263
2546
|
/** Item name. */
|
|
@@ -2282,6 +2565,8 @@ export interface ProjectItemParametersDto {
|
|
|
2282
2565
|
sku?: string | null;
|
|
2283
2566
|
/** External resources descriptions. */
|
|
2284
2567
|
resources?: ProjectItemResourceParametersDto[] | null;
|
|
2568
|
+
/** Additional project item product information description. */
|
|
2569
|
+
productSpecifier?: ProjectItemProductSpecifierDto | null;
|
|
2285
2570
|
}
|
|
2286
2571
|
/** Dto class, containing create operation parameters for single-item project entity. */
|
|
2287
2572
|
export interface CreateSingleItemProjectDto {
|