@aurigma/axios-storefront-api-client 2.51.1 → 2.53.1

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,20 +85,118 @@ 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 IProductLinksApiClient {
89
+ /**
90
+ * Returns all product links, 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 tenantId (optional) Tenant identifier.
96
+ * @return Success
97
+ */
98
+ getAllProductLinks(skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, tenantId?: number | null | undefined): Promise<PagedOfProductLinkDto>;
99
+ /**
100
+ * Returns a product link by its identifier.
101
+ * @param id Product identifier.
102
+ * @param productLinkVersionId (optional) Product link version identifier. Optional
103
+ * @param productVersionId (optional) Product version identifier which represents linked product version. Optional
104
+ * @param tenantId (optional) Tenant identifier.
105
+ * @return Success
106
+ */
107
+ getProductLink(id: number, productLinkVersionId?: number | null | undefined, productVersionId?: number | null | undefined, tenantId?: number | null | undefined): Promise<ProductLinkDto>;
108
+ /**
109
+ * Returns a product link summary by product link identifier.
110
+ * @param id Product link identifier.
111
+ * @param productLinkVersionId (optional) Product link version identifier.
112
+ * @param productVersionId (optional) Product link identifier.
113
+ * @param productVariantId (optional) Product variant identifier.
114
+ * @param sku (optional) Product variant SKU.
115
+ * @param tenantId (optional) Tenant identifier.
116
+ * @return Success
117
+ */
118
+ getProductSummary(id: number, productLinkVersionId?: number | null | undefined, productVersionId?: number | null | undefined, productVariantId?: number | null | undefined, sku?: string | null | undefined, tenantId?: number | null | undefined): Promise<ProductSummaryDto>;
119
+ /**
120
+ * Returns a product link personalization workflow description by product link identifier.
121
+ * @param id Product link identifier.
122
+ * @param productLinkVersionId (optional) Product link version identifier.
123
+ * @param productVersionId (optional) Product version identifier.
124
+ * @param productFilterId (optional) Product filter identifier.
125
+ * @param tenantId (optional) Tenant identifier.
126
+ * @return Success
127
+ */
128
+ getPersonalizationWorkflow(id: number, productLinkVersionId?: number | null | undefined, productVersionId?: number | null | undefined, productFilterId?: number | null | undefined, tenantId?: number | null | undefined): Promise<PersonalizationWorkflowDto>;
129
+ }
130
+ export declare class ProductLinksApiClient extends ApiClientBase implements IProductLinksApiClient {
131
+ private instance;
132
+ private baseUrl;
133
+ protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
134
+ constructor(configuration: ApiClientConfiguration, baseUrl?: string, instance?: AxiosInstance);
135
+ /**
136
+ * Returns all product links, 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 tenantId (optional) Tenant identifier.
142
+ * @return Success
143
+ */
144
+ getAllProductLinks(skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfProductLinkDto>;
145
+ protected processGetAllProductLinks(response: AxiosResponse): Promise<PagedOfProductLinkDto>;
146
+ /**
147
+ * Returns a product link by its identifier.
148
+ * @param id Product identifier.
149
+ * @param productLinkVersionId (optional) Product link version identifier. Optional
150
+ * @param productVersionId (optional) Product version identifier which represents linked product version. Optional
151
+ * @param tenantId (optional) Tenant identifier.
152
+ * @return Success
153
+ */
154
+ getProductLink(id: number, productLinkVersionId?: number | null | undefined, productVersionId?: number | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProductLinkDto>;
155
+ protected processGetProductLink(response: AxiosResponse): Promise<ProductLinkDto>;
156
+ /**
157
+ * Returns a product link summary by product link identifier.
158
+ * @param id Product link identifier.
159
+ * @param productLinkVersionId (optional) Product link version identifier.
160
+ * @param productVersionId (optional) Product link identifier.
161
+ * @param productVariantId (optional) Product variant identifier.
162
+ * @param sku (optional) Product variant SKU.
163
+ * @param tenantId (optional) Tenant identifier.
164
+ * @return Success
165
+ */
166
+ getProductSummary(id: number, productLinkVersionId?: number | null | undefined, productVersionId?: number | null | undefined, productVariantId?: number | null | undefined, sku?: string | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProductSummaryDto>;
167
+ protected processGetProductSummary(response: AxiosResponse): Promise<ProductSummaryDto>;
168
+ /**
169
+ * Returns a product link personalization workflow description by product link identifier.
170
+ * @param id Product link identifier.
171
+ * @param productLinkVersionId (optional) Product link version identifier.
172
+ * @param productVersionId (optional) Product version identifier.
173
+ * @param productFilterId (optional) Product filter identifier.
174
+ * @param tenantId (optional) Tenant identifier.
175
+ * @return Success
176
+ */
177
+ getPersonalizationWorkflow(id: number, productLinkVersionId?: number | null | undefined, productVersionId?: number | null | undefined, productFilterId?: number | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PersonalizationWorkflowDto>;
178
+ protected processGetPersonalizationWorkflow(response: AxiosResponse): Promise<PersonalizationWorkflowDto>;
179
+ }
88
180
  export interface IProductReferencesApiClient {
89
181
  /**
90
182
  * Returns all storefront product references relevant to the specified query parameters.
91
183
  * @param storefrontId Storefront identifier.
92
- * @param productReference (optional) Product reference filter. Product reference is an external reference to Customer's Canvas product specification, e.g online store product identifier.
93
- * @param productSpecificationId (optional) Cusomer's Canvas product specification filter.
184
+ * @param productReference (optional) Product reference filter.
185
+ Product reference is an external reference to Customer's Canvas product, e.g online store product identifier.
186
+ * @param productSpecificationId (optional) Customer's Canvas product specification filter.
187
+ * @param productId (optional) Customer's Canvas product filter.
188
+ * @param productLinkId (optional) Customer's Canvas product link filter.
94
189
  * @param skip (optional) Defines page start offset from beginning of sorted result list.
95
190
  * @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
96
191
  * @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC".
97
192
  * @param search (optional) Search string for partial match.
193
+ * @param sku (optional) SKU filter.
194
+ * @param tags (optional) List of tags that product should have.
195
+ * @param customFields (optional) Serialized custom fields dictionary filter. For example: {"public":"true","name":"my item"}.
98
196
  * @param tenantId (optional) Tenant identifier.
99
197
  * @return Success
100
198
  */
101
- getAll(storefrontId: number, productReference?: string | null | undefined, productSpecificationId?: number | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, tenantId?: number | null | undefined): Promise<PagedOfProductReferenceDto>;
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>;
102
200
  /**
103
201
  * Creates a new storefront product reference.
104
202
  * @param storefrontId Storefront identifier.
@@ -107,9 +205,66 @@ export interface IProductReferencesApiClient {
107
205
  * @return Success
108
206
  */
109
207
  create(storefrontId: number, tenantId?: number | null | undefined, body?: CreateProductReferenceDto | null | undefined): Promise<ProductReferenceDto>;
208
+ /**
209
+ * Returns a list of product specifications associated with storefront product references relevant to the specified query parameters.
210
+ * @param storefrontId Storefront identifier.
211
+ * @param productReference (optional) Product reference filter.
212
+ Product reference is an external reference to Customer's Canvas product, e.g online store product identifier.
213
+ * @param productSpecificationId (optional) Customer's Canvas product specification filter.
214
+ * @param productId (optional) Customer's Canvas product filter.
215
+ * @param productLinkId (optional) Customer's Canvas product link filter.
216
+ * @param skip (optional) Defines page start offset from beginning of sorted result list.
217
+ * @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
218
+ * @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC".
219
+ * @param search (optional) Search string for partial match.
220
+ * @param sku (optional) SKU filter.
221
+ * @param tags (optional) List of tags that product should have.
222
+ * @param customFields (optional) Serialized custom fields dictionary filter. For example: {"public":"true","name":"my item"}.
223
+ * @param tenantId (optional) Tenant identifier.
224
+ * @return Success
225
+ */
226
+ 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>;
227
+ /**
228
+ * Returns a list of products associated with storefront product references relevant to the specified query parameters.
229
+ * @param storefrontId Storefront identifier.
230
+ * @param productReference (optional) Product reference filter.
231
+ Product reference is an external reference to Customer's Canvas product, e.g online store product identifier.
232
+ * @param productSpecificationId (optional) Customer's Canvas product specification filter.
233
+ * @param productId (optional) Customer's Canvas product filter.
234
+ * @param productLinkId (optional) Customer's Canvas product link filter.
235
+ * @param skip (optional) Defines page start offset from beginning of sorted result list.
236
+ * @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
237
+ * @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC".
238
+ * @param search (optional) Search string for partial match.
239
+ * @param sku (optional) SKU filter.
240
+ * @param tags (optional) List of tags that product should have.
241
+ * @param customFields (optional) Serialized custom fields dictionary filter. For example: {"public":"true","name":"my item"}.
242
+ * @param tenantId (optional) Tenant identifier.
243
+ * @return Success
244
+ */
245
+ 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>;
246
+ /**
247
+ * Returns a list of product links associated with storefront product references relevant to the specified query parameters.
248
+ * @param storefrontId Storefront identifier.
249
+ * @param productReference (optional) Product reference filter.
250
+ Product reference is an external reference to Customer's Canvas product, e.g online store product identifier.
251
+ * @param productSpecificationId (optional) Customer's Canvas product specification filter.
252
+ * @param productId (optional) Customer's Canvas product filter.
253
+ * @param productLinkId (optional) Customer's Canvas product link filter.
254
+ * @param skip (optional) Defines page start offset from beginning of sorted result list.
255
+ * @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
256
+ * @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC".
257
+ * @param search (optional) Search string for partial match.
258
+ * @param sku (optional) SKU filter.
259
+ * @param tags (optional) List of tags that product should have.
260
+ * @param customFields (optional) Serialized custom fields dictionary filter. For example: {"public":"true","name":"my item"}.
261
+ * @param tenantId (optional) Tenant identifier.
262
+ * @return Success
263
+ */
264
+ 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>;
110
265
  /**
111
266
  * Returns a storefront product reference.
112
- * @param reference Product reference - external reference to Customer's Canvas product specification, e.g online store product identifier.
267
+ * @param reference An external reference to Customer's Canvas product, e.g online store product identifier.
113
268
  * @param storefrontId Storefront identifier.
114
269
  * @param tenantId (optional) Tenant identifier.
115
270
  * @return Success
@@ -125,15 +280,41 @@ export interface IProductReferencesApiClient {
125
280
  delete(reference: string | null, storefrontId: number, tenantId?: number | null | undefined): Promise<ProductReferenceDto>;
126
281
  /**
127
282
  * Returns a product specification by the storefront product reference.
128
- * @param reference Product reference - external reference to Customer's Canvas product specification, e.g online store product identifier.
283
+ * @param reference Product reference - external reference to Customer's Canvas product, e.g online store product identifier.
129
284
  * @param storefrontId Storefront identifier.
130
285
  * @param tenantId (optional) Tenant identifier.
131
286
  * @return Success
132
287
  */
133
288
  getProductSpecification(reference: string | null, storefrontId: number, tenantId?: number | null | undefined): Promise<ProductSpecificationDto>;
289
+ /**
290
+ * Returns a product by storefront product reference.
291
+ * @param reference An external reference to Customer's Canvas product, e.g online store product identifier.
292
+ * @param storefrontId Storefront identifier.
293
+ * @param tenantId (optional) Tenant identifier.
294
+ * @return Success
295
+ */
296
+ getProduct(reference: string | null, storefrontId: number, tenantId?: number | null | undefined): Promise<ProductDto>;
297
+ /**
298
+ * Returns a product summary by storefront product reference.
299
+ * @param reference An external reference to Customer's Canvas product, e.g online store product identifier.
300
+ * @param storefrontId Storefront identifier.
301
+ * @param productVariantId (optional) Product variant identifier.
302
+ * @param sku (optional) Product variant SKU.
303
+ * @param tenantId (optional) Tenant identifier.
304
+ * @return Success
305
+ */
306
+ getProductSummary(reference: string | null, storefrontId: number, productVariantId?: number | null | undefined, sku?: string | null | undefined, tenantId?: number | null | undefined): Promise<ProductSummaryDto>;
307
+ /**
308
+ * Returns a product link by storefront product reference.
309
+ * @param reference An external reference to Customer's Canvas product, e.g online store product identifier.
310
+ * @param storefrontId Storefront identifier.
311
+ * @param tenantId (optional) Tenant identifier.
312
+ * @return Success
313
+ */
314
+ getProductLink(reference: string | null, storefrontId: number, tenantId?: number | null | undefined): Promise<ProductLinkDto>;
134
315
  /**
135
316
  * Returns a product cost details from ecommerce system.
136
- * @param reference Product reference - external reference to Customer's Canvas product product specification, e.g online store product identifier.
317
+ * @param reference An external reference to Customer's Canvas product, e.g online store product identifier.
137
318
  * @param sku Product SKU.
138
319
  * @param storefrontId Storefront identifier.
139
320
  * @param storefrontUserId (optional) Storefront user identifier.
@@ -144,8 +325,8 @@ export interface IProductReferencesApiClient {
144
325
  */
145
326
  getProductCostDetails(reference: string | null, sku: string, storefrontId: number, storefrontUserId?: string | null | undefined, currencyCode?: string | null | undefined, quantity?: number | undefined, tenantId?: number | null | undefined): Promise<ProductCostDetailsDto>;
146
327
  /**
147
- * Returns a product personalization workflow description by product specification identifier.
148
- * @param reference Product reference - external reference to Customer's Canvas product specification, e.g online store product identifier.
328
+ * Returns a product personalization workflow.
329
+ * @param reference An external reference to Customer's Canvas product, e.g online store product identifier.
149
330
  * @param storefrontId (optional) Storefront identifier.
150
331
  * @param tenantId (optional) Tenant identifier.
151
332
  * @return Success
@@ -153,7 +334,7 @@ export interface IProductReferencesApiClient {
153
334
  getPersonalizationWorkflow(reference: string | null, storefrontId?: number | undefined, tenantId?: number | null | undefined): Promise<PersonalizationWorkflowDto>;
154
335
  /**
155
336
  * Returns a product personalization workflow configuration by storefront product reference.
156
- * @param reference Product reference - external reference to Customer's Canvas product specification, e.g online store product identifier.
337
+ * @param reference An external reference to Customer's Canvas product, e.g online store product identifier.
157
338
  * @param storefrontId Storefront identifier.
158
339
  * @param tenantId (optional) Tenant identifier.
159
340
  * @return Success
@@ -169,16 +350,22 @@ export declare class ProductReferencesApiClient extends ApiClientBase implements
169
350
  /**
170
351
  * Returns all storefront product references relevant to the specified query parameters.
171
352
  * @param storefrontId Storefront identifier.
172
- * @param productReference (optional) Product reference filter. Product reference is an external reference to Customer's Canvas product specification, e.g online store product identifier.
173
- * @param productSpecificationId (optional) Cusomer's Canvas product specification filter.
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.
174
358
  * @param skip (optional) Defines page start offset from beginning of sorted result list.
175
359
  * @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
176
360
  * @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC".
177
361
  * @param search (optional) Search string for partial match.
362
+ * @param sku (optional) SKU filter.
363
+ * @param tags (optional) List of tags that product should have.
364
+ * @param customFields (optional) Serialized custom fields dictionary filter. For example: {"public":"true","name":"my item"}.
178
365
  * @param tenantId (optional) Tenant identifier.
179
366
  * @return Success
180
367
  */
181
- getAll(storefrontId: number, productReference?: string | null | undefined, productSpecificationId?: number | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfProductReferenceDto>;
368
+ 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>;
182
369
  protected processGetAll(response: AxiosResponse): Promise<PagedOfProductReferenceDto>;
183
370
  /**
184
371
  * Creates a new storefront product reference.
@@ -189,9 +376,69 @@ export declare class ProductReferencesApiClient extends ApiClientBase implements
189
376
  */
190
377
  create(storefrontId: number, tenantId?: number | null | undefined, body?: CreateProductReferenceDto | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProductReferenceDto>;
191
378
  protected processCreate(response: AxiosResponse): Promise<ProductReferenceDto>;
379
+ /**
380
+ * Returns a list of product specifications associated with storefront product references relevant to the specified query parameters.
381
+ * @param storefrontId Storefront identifier.
382
+ * @param productReference (optional) Product reference filter.
383
+ Product reference is an external reference to Customer's Canvas product, e.g online store product identifier.
384
+ * @param productSpecificationId (optional) Customer's Canvas product specification filter.
385
+ * @param productId (optional) Customer's Canvas product filter.
386
+ * @param productLinkId (optional) Customer's Canvas product link filter.
387
+ * @param skip (optional) Defines page start offset from beginning of sorted result list.
388
+ * @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
389
+ * @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC".
390
+ * @param search (optional) Search string for partial match.
391
+ * @param sku (optional) SKU filter.
392
+ * @param tags (optional) List of tags that product should have.
393
+ * @param customFields (optional) Serialized custom fields dictionary filter. For example: {"public":"true","name":"my item"}.
394
+ * @param tenantId (optional) Tenant identifier.
395
+ * @return Success
396
+ */
397
+ 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>;
398
+ protected processGetAllProductSpecifications(response: AxiosResponse): Promise<PagedOfProductSpecificationDto>;
399
+ /**
400
+ * Returns a list of products associated with storefront product references relevant to the specified query parameters.
401
+ * @param storefrontId Storefront identifier.
402
+ * @param productReference (optional) Product reference filter.
403
+ Product reference is an external reference to Customer's Canvas product, e.g online store product identifier.
404
+ * @param productSpecificationId (optional) Customer's Canvas product specification filter.
405
+ * @param productId (optional) Customer's Canvas product filter.
406
+ * @param productLinkId (optional) Customer's Canvas product link filter.
407
+ * @param skip (optional) Defines page start offset from beginning of sorted result list.
408
+ * @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
409
+ * @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC".
410
+ * @param search (optional) Search string for partial match.
411
+ * @param sku (optional) SKU filter.
412
+ * @param tags (optional) List of tags that product should have.
413
+ * @param customFields (optional) Serialized custom fields dictionary filter. For example: {"public":"true","name":"my item"}.
414
+ * @param tenantId (optional) Tenant identifier.
415
+ * @return Success
416
+ */
417
+ 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>;
418
+ protected processGetAllProducts(response: AxiosResponse): Promise<PagedOfProductDto>;
419
+ /**
420
+ * Returns a list of product links associated with storefront product references relevant to the specified query parameters.
421
+ * @param storefrontId Storefront identifier.
422
+ * @param productReference (optional) Product reference filter.
423
+ Product reference is an external reference to Customer's Canvas product, e.g online store product identifier.
424
+ * @param productSpecificationId (optional) Customer's Canvas product specification filter.
425
+ * @param productId (optional) Customer's Canvas product filter.
426
+ * @param productLinkId (optional) Customer's Canvas product link filter.
427
+ * @param skip (optional) Defines page start offset from beginning of sorted result list.
428
+ * @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
429
+ * @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC".
430
+ * @param search (optional) Search string for partial match.
431
+ * @param sku (optional) SKU filter.
432
+ * @param tags (optional) List of tags that product should have.
433
+ * @param customFields (optional) Serialized custom fields dictionary filter. For example: {"public":"true","name":"my item"}.
434
+ * @param tenantId (optional) Tenant identifier.
435
+ * @return Success
436
+ */
437
+ 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>;
438
+ protected processGetAllProductLinks(response: AxiosResponse): Promise<PagedOfProductLinkDto>;
192
439
  /**
193
440
  * Returns a storefront product reference.
194
- * @param reference Product reference - external reference to Customer's Canvas product specification, e.g online store product identifier.
441
+ * @param reference An external reference to Customer's Canvas product, e.g online store product identifier.
195
442
  * @param storefrontId Storefront identifier.
196
443
  * @param tenantId (optional) Tenant identifier.
197
444
  * @return Success
@@ -209,16 +456,45 @@ export declare class ProductReferencesApiClient extends ApiClientBase implements
209
456
  protected processDelete(response: AxiosResponse): Promise<ProductReferenceDto>;
210
457
  /**
211
458
  * Returns a product specification by the storefront product reference.
212
- * @param reference Product reference - external reference to Customer's Canvas product specification, e.g online store product identifier.
459
+ * @param reference Product reference - external reference to Customer's Canvas product, e.g online store product identifier.
213
460
  * @param storefrontId Storefront identifier.
214
461
  * @param tenantId (optional) Tenant identifier.
215
462
  * @return Success
216
463
  */
217
464
  getProductSpecification(reference: string | null, storefrontId: number, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProductSpecificationDto>;
218
465
  protected processGetProductSpecification(response: AxiosResponse): Promise<ProductSpecificationDto>;
466
+ /**
467
+ * Returns a product by storefront product reference.
468
+ * @param reference An external reference to Customer's Canvas product, e.g online store product identifier.
469
+ * @param storefrontId Storefront identifier.
470
+ * @param tenantId (optional) Tenant identifier.
471
+ * @return Success
472
+ */
473
+ getProduct(reference: string | null, storefrontId: number, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProductDto>;
474
+ protected processGetProduct(response: AxiosResponse): Promise<ProductDto>;
475
+ /**
476
+ * Returns a product summary by storefront product reference.
477
+ * @param reference An external reference to Customer's Canvas product, e.g online store product identifier.
478
+ * @param storefrontId Storefront identifier.
479
+ * @param productVariantId (optional) Product variant identifier.
480
+ * @param sku (optional) Product variant SKU.
481
+ * @param tenantId (optional) Tenant identifier.
482
+ * @return Success
483
+ */
484
+ getProductSummary(reference: string | null, storefrontId: number, productVariantId?: number | null | undefined, sku?: string | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProductSummaryDto>;
485
+ protected processGetProductSummary(response: AxiosResponse): Promise<ProductSummaryDto>;
486
+ /**
487
+ * Returns a product link by storefront product reference.
488
+ * @param reference An external reference to Customer's Canvas product, e.g online store product identifier.
489
+ * @param storefrontId Storefront identifier.
490
+ * @param tenantId (optional) Tenant identifier.
491
+ * @return Success
492
+ */
493
+ getProductLink(reference: string | null, storefrontId: number, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProductLinkDto>;
494
+ protected processGetProductLink(response: AxiosResponse): Promise<ProductLinkDto>;
219
495
  /**
220
496
  * Returns a product cost details from ecommerce system.
221
- * @param reference Product reference - external reference to Customer's Canvas product product specification, e.g online store product identifier.
497
+ * @param reference An external reference to Customer's Canvas product, e.g online store product identifier.
222
498
  * @param sku Product SKU.
223
499
  * @param storefrontId Storefront identifier.
224
500
  * @param storefrontUserId (optional) Storefront user identifier.
@@ -230,8 +506,8 @@ export declare class ProductReferencesApiClient extends ApiClientBase implements
230
506
  getProductCostDetails(reference: string | null, sku: string, storefrontId: number, storefrontUserId?: string | null | undefined, currencyCode?: string | null | undefined, quantity?: number | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProductCostDetailsDto>;
231
507
  protected processGetProductCostDetails(response: AxiosResponse): Promise<ProductCostDetailsDto>;
232
508
  /**
233
- * Returns a product personalization workflow description by product specification identifier.
234
- * @param reference Product reference - external reference to Customer's Canvas product specification, e.g online store product identifier.
509
+ * Returns a product personalization workflow.
510
+ * @param reference An external reference to Customer's Canvas product, e.g online store product identifier.
235
511
  * @param storefrontId (optional) Storefront identifier.
236
512
  * @param tenantId (optional) Tenant identifier.
237
513
  * @return Success
@@ -240,7 +516,7 @@ export declare class ProductReferencesApiClient extends ApiClientBase implements
240
516
  protected processGetPersonalizationWorkflow(response: AxiosResponse): Promise<PersonalizationWorkflowDto>;
241
517
  /**
242
518
  * Returns a product personalization workflow configuration by storefront product reference.
243
- * @param reference Product reference - external reference to Customer's Canvas product specification, e.g online store product identifier.
519
+ * @param reference An external reference to Customer's Canvas product, e.g online store product identifier.
244
520
  * @param storefrontId Storefront identifier.
245
521
  * @param tenantId (optional) Tenant identifier.
246
522
  * @return Success
@@ -249,6 +525,386 @@ export declare class ProductReferencesApiClient extends ApiClientBase implements
249
525
  getProductConfig(reference: string | null, storefrontId: number, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<string>;
250
526
  protected processGetProductConfig(response: AxiosResponse): Promise<string>;
251
527
  }
528
+ export interface IProductsApiClient {
529
+ /**
530
+ * Returns all products, relevant to the specified query parameters.
531
+ * @param skip (optional) Defines page start offset from beginning of sorted result list.
532
+ * @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
533
+ * @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC".
534
+ * @param search (optional) Search string for partial match.
535
+ * @param sku (optional) SKU of linked ecommerce product.
536
+ * @param tags (optional) List of tags that product should have.
537
+ * @param customFields (optional) Serialized custom fields dictionary filter. For example: {"public":"true","name":"my item"}.
538
+ * @param tenantId (optional) Tenant identifier.
539
+ * @return Success
540
+ */
541
+ getAllProducts(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>;
542
+ /**
543
+ * Returns a product by identifier.
544
+ * @param id Product identifier.
545
+ * @param productVersionId (optional) Product version identifier.
546
+ * @param tenantId (optional) Tenant identifier.
547
+ * @return Success
548
+ */
549
+ getProduct(id: number, productVersionId?: number | null | undefined, tenantId?: number | null | undefined): Promise<ProductDto>;
550
+ /**
551
+ * Returns a product summary by product identifier.
552
+ * @param id Product identifier.
553
+ * @param productVersionId (optional) Product version identifier.
554
+ * @param productLinkId (optional) Product link identifier.
555
+ * @param productVariantId (optional) Product variant identifier.
556
+ * @param sku (optional) Product variant SKU.
557
+ * @param tenantId (optional) Tenant identifier.
558
+ * @return Success
559
+ */
560
+ getProductSummary(id: number, productVersionId?: number | null | undefined, productLinkId?: number | null | undefined, productVariantId?: number | null | undefined, sku?: string | null | undefined, tenantId?: number | null | undefined): Promise<ProductSummaryDto>;
561
+ /**
562
+ * Returns a list of product options.
563
+ * @param id Product identifier.
564
+ * @param productVersionId (optional) Product version identifier.
565
+ * @param tenantId (optional) Tenant identifier.
566
+ * @return Success
567
+ */
568
+ getProductOptions(id: number, productVersionId?: number | null | undefined, tenantId?: number | null | undefined): Promise<PagedOfProductOptionDto>;
569
+ /**
570
+ * Returns a list of product options for all products.
571
+ * @param tenantId (optional) Tenant identifier.
572
+ * @return Success
573
+ */
574
+ getAllProductOptions(tenantId?: number | null | undefined): Promise<PagedOfProductOptionDto>;
575
+ /**
576
+ * Returns a list of product links.
577
+ * @param id Product identifier.
578
+ * @param productVersionId (optional)
579
+ * @param skip (optional) Defines page start offset from beginning of sorted result list.
580
+ * @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
581
+ * @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC".
582
+ * @param search (optional) Search string for partial match.
583
+ * @param tenantId (optional) Tenant identifier.
584
+ * @return Success
585
+ */
586
+ getProductLinks(id: number, productVersionId?: number | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, tenantId?: number | null | undefined): Promise<PagedOfProductLinkDto>;
587
+ /**
588
+ * Returns a product link.
589
+ * @param id Product identifier.
590
+ * @param productLinkId Product link identifier.
591
+ * @param productVersionId (optional)
592
+ * @param tenantId (optional) Tenant identifier.
593
+ * @return Success
594
+ */
595
+ getProductLink(id: number, productLinkId: number, productVersionId?: number | null | undefined, tenantId?: number | null | undefined): Promise<ProductLinkDto>;
596
+ /**
597
+ * Returns a list of product variants.
598
+ * @param id Product identifier.
599
+ * @param productVersionId (optional) Product version identifier.
600
+ * @param skip (optional) Defines page start offset from beginning of sorted result list.
601
+ * @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
602
+ * @param options (optional) Defines options filter e.g.: "{ "opt1_id": "opt1_val1_id, opt1_val2_id", "opt2_id": "opt2_val1_id" }".
603
+ * @param productFilterId (optional) Defines special filter based on product filter with specified identifier.
604
+ * @param takeAvailableOnly (optional) Defines special filter for available product variants.
605
+ * @param sku (optional) SKU of linked ecommerce product.
606
+ * @param tenantId (optional) Tenant identifier.
607
+ * @return Success
608
+ */
609
+ getProductVariants(id: number, productVersionId?: number | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, options?: string | null | undefined, productFilterId?: number | null | undefined, takeAvailableOnly?: boolean | null | undefined, sku?: string | null | undefined, tenantId?: number | null | undefined): Promise<PagedOfProductVariantDto>;
610
+ /**
611
+ * Returns a product variant.
612
+ * @param id Product identifier.
613
+ * @param productVariantId Product variant identifier.
614
+ * @param productVersionId (optional) Product version identifier.
615
+ * @param tenantId (optional) Tenant identifier.
616
+ * @return Success
617
+ */
618
+ getProductVariant(id: number, productVariantId: number, productVersionId?: number | null | undefined, tenantId?: number | null | undefined): Promise<ProductVariantDto>;
619
+ /**
620
+ * Returns a list of product variant designs.
621
+ * @param id Product identifier.
622
+ * @param productVersionId (optional) Product version identifier.
623
+ * @param productVariantId (optional) Product variant identifier.
624
+ * @param search (optional) Search string for design name partial match.
625
+ * @param designCustomFields (optional) Custom attributes dictionary filter for designs. For example: {"public":"true","name":"my item"}
626
+ * @param designPath (optional) Path filter for designs. Subfolders included by default.
627
+ * @param skip (optional) Defines page start offset from beginning of sorted result list.
628
+ * @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
629
+ * @param options (optional) Defines options filter e.g.: "{ "opt1_id": "opt1_val1_id, opt1_val2_id", "opt2_id": "opt2_val1_id" }".
630
+ * @param productFilterId (optional) Defines special filter based on product filter with specified identifier.
631
+ * @param takeAvailableOnly (optional) Defines special filter for available product variants.
632
+ * @param sku (optional) SKU of linked ecommerce product.
633
+ * @param tenantId (optional) Tenant identifier.
634
+ * @return Success
635
+ */
636
+ getProductVariantDesigns(id: number, productVersionId?: number | null | undefined, productVariantId?: number | null | undefined, search?: string | null | undefined, designCustomFields?: string | null | undefined, designPath?: string | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, options?: string | null | undefined, productFilterId?: number | null | undefined, takeAvailableOnly?: boolean | null | undefined, sku?: string | null | undefined, tenantId?: number | null | undefined): Promise<PagedOfProductVariantDesignDto>;
637
+ /**
638
+ * Returns a list of product variant mockups.
639
+ * @param id Product identifier.
640
+ * @param productVersionId (optional) Product version identifier.
641
+ * @param productVariantId (optional) Product variant identifier.
642
+ * @param search (optional) Search string for design name partial match.
643
+ * @param mockupCustomFields (optional) Custom attributes dictionary filter for mockups. For example: {"public":"true","name":"my item"}
644
+ * @param mockupPath (optional) Path filter for mockups. Subfolders included by default.
645
+ * @param skip (optional) Defines page start offset from beginning of sorted result list.
646
+ * @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
647
+ * @param options (optional) Defines options filter e.g.: "{ "opt1_id": "opt1_val1_id, opt1_val2_id", "opt2_id": "opt2_val1_id" }".
648
+ * @param productFilterId (optional) Defines special filter based on product filter with specified identifier.
649
+ * @param takeAvailableOnly (optional) Defines special filter for available product variants.
650
+ * @param sku (optional) SKU of linked ecommerce product.
651
+ * @param tenantId (optional) Tenant identifier.
652
+ * @return Success
653
+ */
654
+ getProductVariantMockups(id: number, productVersionId?: number | null | undefined, productVariantId?: number | null | undefined, search?: string | null | undefined, mockupCustomFields?: string | null | undefined, mockupPath?: string | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, options?: string | null | undefined, productFilterId?: number | null | undefined, takeAvailableOnly?: boolean | null | undefined, sku?: string | null | undefined, tenantId?: number | null | undefined): Promise<PagedOfProductVariantMockupDto>;
655
+ /**
656
+ * Returns a list of product variant documents.
657
+ * @param id Product identifier.
658
+ * @param productVersionId (optional) Product version identifier.
659
+ * @param productVariantId (optional) Product variant identifier.
660
+ * @param search (optional) Search string for document name partial match.
661
+ * @param documentCustomFields (optional) Custom attributes dictionary filter for documents. For example: {"public":"true","name":"my item"}
662
+ * @param documentPath (optional) Path filter for documents. Subfolders included by default.
663
+ * @param skip (optional) Defines page start offset from beginning of sorted result list.
664
+ * @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
665
+ * @param options (optional) Defines options filter e.g.: "{ "opt1_id": "opt1_val1_id, opt1_val2_id", "opt2_id": "opt2_val1_id" }".
666
+ * @param productFilterId (optional) Defines special filter based on product filter with specified identifier.
667
+ * @param takeAvailableOnly (optional) Defines special filter for available product variants.
668
+ * @param sku (optional) SKU of linked ecommerce product.
669
+ * @param tenantId (optional) Tenant identifier.
670
+ * @return Success
671
+ */
672
+ getProductVariantDocuments(id: number, productVersionId?: number | null | undefined, productVariantId?: number | null | undefined, search?: string | null | undefined, documentCustomFields?: string | null | undefined, documentPath?: string | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, options?: string | null | undefined, productFilterId?: number | null | undefined, takeAvailableOnly?: boolean | null | undefined, sku?: string | null | undefined, tenantId?: number | null | undefined): Promise<PagedOfProductVariantDocumentDto>;
673
+ /**
674
+ * Updates product variant resources.
675
+ * @param id Product identifier.
676
+ * @param productVersionId (optional) Product version identifier.
677
+ * @param tenantId (optional) Tenant identifier.
678
+ * @return Success
679
+ */
680
+ updateProductVariantResources(id: number, productVersionId?: number | null | undefined, tenantId?: number | null | undefined): Promise<void>;
681
+ /**
682
+ * Set product variant price.
683
+ * @param id Product identifier.
684
+ * @param productVersionId (optional) Product version identifier.
685
+ * @param tenantId (optional) Tenant identifier.
686
+ * @param body (optional) Set product variant price operation parameters.
687
+ * @return Success
688
+ */
689
+ setProductVariantPrice(id: number, productVersionId?: number | null | undefined, tenantId?: number | null | undefined, body?: SetProductVariantPriceDto[] | null | undefined): Promise<void>;
690
+ /**
691
+ * Returns a list of all available product tags.
692
+ * @param search (optional) Search string for partial match.
693
+ * @param tenantId (optional) Tenant identifier.
694
+ * @return Success
695
+ */
696
+ getAvailableProductTags(search?: string | null | undefined, tenantId?: number | null | undefined): Promise<string[]>;
697
+ /**
698
+ * Returns a product personalization workflow description by product identifier.
699
+ * @param id Product identifier.
700
+ * @param productVersionId (optional) Product version identifier.
701
+ * @param productLinkId (optional) Product link identifier.
702
+ * @param productFilterId (optional) Product filter identifier.
703
+ * @param tenantId (optional) Tenant identifier.
704
+ * @return Success
705
+ */
706
+ getPersonalizationWorkflow(id: number, productVersionId?: number | null | undefined, productLinkId?: number | null | undefined, productFilterId?: number | null | undefined, tenantId?: number | null | undefined): Promise<PersonalizationWorkflowDto>;
707
+ }
708
+ export declare class ProductsApiClient extends ApiClientBase implements IProductsApiClient {
709
+ private instance;
710
+ private baseUrl;
711
+ protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
712
+ constructor(configuration: ApiClientConfiguration, baseUrl?: string, instance?: AxiosInstance);
713
+ /**
714
+ * Returns all products, relevant to the specified query parameters.
715
+ * @param skip (optional) Defines page start offset from beginning of sorted result list.
716
+ * @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
717
+ * @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC".
718
+ * @param search (optional) Search string for partial match.
719
+ * @param sku (optional) SKU of linked ecommerce product.
720
+ * @param tags (optional) List of tags that product should have.
721
+ * @param customFields (optional) Serialized custom fields dictionary filter. For example: {"public":"true","name":"my item"}.
722
+ * @param tenantId (optional) Tenant identifier.
723
+ * @return Success
724
+ */
725
+ getAllProducts(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>;
726
+ protected processGetAllProducts(response: AxiosResponse): Promise<PagedOfProductDto>;
727
+ /**
728
+ * Returns a product by identifier.
729
+ * @param id Product identifier.
730
+ * @param productVersionId (optional) Product version identifier.
731
+ * @param tenantId (optional) Tenant identifier.
732
+ * @return Success
733
+ */
734
+ getProduct(id: number, productVersionId?: number | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProductDto>;
735
+ protected processGetProduct(response: AxiosResponse): Promise<ProductDto>;
736
+ /**
737
+ * Returns a product summary by product identifier.
738
+ * @param id Product identifier.
739
+ * @param productVersionId (optional) Product version identifier.
740
+ * @param productLinkId (optional) Product link identifier.
741
+ * @param productVariantId (optional) Product variant identifier.
742
+ * @param sku (optional) Product variant SKU.
743
+ * @param tenantId (optional) Tenant identifier.
744
+ * @return Success
745
+ */
746
+ getProductSummary(id: number, productVersionId?: number | null | undefined, productLinkId?: number | null | undefined, productVariantId?: number | null | undefined, sku?: string | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProductSummaryDto>;
747
+ protected processGetProductSummary(response: AxiosResponse): Promise<ProductSummaryDto>;
748
+ /**
749
+ * Returns a list of product options.
750
+ * @param id Product identifier.
751
+ * @param productVersionId (optional) Product version identifier.
752
+ * @param tenantId (optional) Tenant identifier.
753
+ * @return Success
754
+ */
755
+ getProductOptions(id: number, productVersionId?: number | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfProductOptionDto>;
756
+ protected processGetProductOptions(response: AxiosResponse): Promise<PagedOfProductOptionDto>;
757
+ /**
758
+ * Returns a list of product options for all products.
759
+ * @param tenantId (optional) Tenant identifier.
760
+ * @return Success
761
+ */
762
+ getAllProductOptions(tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfProductOptionDto>;
763
+ protected processGetAllProductOptions(response: AxiosResponse): Promise<PagedOfProductOptionDto>;
764
+ /**
765
+ * Returns a list of product links.
766
+ * @param id Product identifier.
767
+ * @param productVersionId (optional)
768
+ * @param skip (optional) Defines page start offset from beginning of sorted result list.
769
+ * @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
770
+ * @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC".
771
+ * @param search (optional) Search string for partial match.
772
+ * @param tenantId (optional) Tenant identifier.
773
+ * @return Success
774
+ */
775
+ getProductLinks(id: number, productVersionId?: number | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfProductLinkDto>;
776
+ protected processGetProductLinks(response: AxiosResponse): Promise<PagedOfProductLinkDto>;
777
+ /**
778
+ * Returns a product link.
779
+ * @param id Product identifier.
780
+ * @param productLinkId Product link identifier.
781
+ * @param productVersionId (optional)
782
+ * @param tenantId (optional) Tenant identifier.
783
+ * @return Success
784
+ */
785
+ getProductLink(id: number, productLinkId: number, productVersionId?: number | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProductLinkDto>;
786
+ protected processGetProductLink(response: AxiosResponse): Promise<ProductLinkDto>;
787
+ /**
788
+ * Returns a list of product variants.
789
+ * @param id Product identifier.
790
+ * @param productVersionId (optional) Product version identifier.
791
+ * @param skip (optional) Defines page start offset from beginning of sorted result list.
792
+ * @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
793
+ * @param options (optional) Defines options filter e.g.: "{ "opt1_id": "opt1_val1_id, opt1_val2_id", "opt2_id": "opt2_val1_id" }".
794
+ * @param productFilterId (optional) Defines special filter based on product filter with specified identifier.
795
+ * @param takeAvailableOnly (optional) Defines special filter for available product variants.
796
+ * @param sku (optional) SKU of linked ecommerce product.
797
+ * @param tenantId (optional) Tenant identifier.
798
+ * @return Success
799
+ */
800
+ getProductVariants(id: number, productVersionId?: number | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, options?: string | null | undefined, productFilterId?: number | null | undefined, takeAvailableOnly?: boolean | null | undefined, sku?: string | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfProductVariantDto>;
801
+ protected processGetProductVariants(response: AxiosResponse): Promise<PagedOfProductVariantDto>;
802
+ /**
803
+ * Returns a product variant.
804
+ * @param id Product identifier.
805
+ * @param productVariantId Product variant identifier.
806
+ * @param productVersionId (optional) Product version identifier.
807
+ * @param tenantId (optional) Tenant identifier.
808
+ * @return Success
809
+ */
810
+ getProductVariant(id: number, productVariantId: number, productVersionId?: number | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProductVariantDto>;
811
+ protected processGetProductVariant(response: AxiosResponse): Promise<ProductVariantDto>;
812
+ /**
813
+ * Returns a list of product variant designs.
814
+ * @param id Product identifier.
815
+ * @param productVersionId (optional) Product version identifier.
816
+ * @param productVariantId (optional) Product variant identifier.
817
+ * @param search (optional) Search string for design name partial match.
818
+ * @param designCustomFields (optional) Custom attributes dictionary filter for designs. For example: {"public":"true","name":"my item"}
819
+ * @param designPath (optional) Path filter for designs. Subfolders included by default.
820
+ * @param skip (optional) Defines page start offset from beginning of sorted result list.
821
+ * @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
822
+ * @param options (optional) Defines options filter e.g.: "{ "opt1_id": "opt1_val1_id, opt1_val2_id", "opt2_id": "opt2_val1_id" }".
823
+ * @param productFilterId (optional) Defines special filter based on product filter with specified identifier.
824
+ * @param takeAvailableOnly (optional) Defines special filter for available product variants.
825
+ * @param sku (optional) SKU of linked ecommerce product.
826
+ * @param tenantId (optional) Tenant identifier.
827
+ * @return Success
828
+ */
829
+ getProductVariantDesigns(id: number, productVersionId?: number | null | undefined, productVariantId?: number | null | undefined, search?: string | null | undefined, designCustomFields?: string | null | undefined, designPath?: string | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, options?: string | null | undefined, productFilterId?: number | null | undefined, takeAvailableOnly?: boolean | null | undefined, sku?: string | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfProductVariantDesignDto>;
830
+ protected processGetProductVariantDesigns(response: AxiosResponse): Promise<PagedOfProductVariantDesignDto>;
831
+ /**
832
+ * Returns a list of product variant mockups.
833
+ * @param id Product identifier.
834
+ * @param productVersionId (optional) Product version identifier.
835
+ * @param productVariantId (optional) Product variant identifier.
836
+ * @param search (optional) Search string for design name partial match.
837
+ * @param mockupCustomFields (optional) Custom attributes dictionary filter for mockups. For example: {"public":"true","name":"my item"}
838
+ * @param mockupPath (optional) Path filter for mockups. Subfolders included by default.
839
+ * @param skip (optional) Defines page start offset from beginning of sorted result list.
840
+ * @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
841
+ * @param options (optional) Defines options filter e.g.: "{ "opt1_id": "opt1_val1_id, opt1_val2_id", "opt2_id": "opt2_val1_id" }".
842
+ * @param productFilterId (optional) Defines special filter based on product filter with specified identifier.
843
+ * @param takeAvailableOnly (optional) Defines special filter for available product variants.
844
+ * @param sku (optional) SKU of linked ecommerce product.
845
+ * @param tenantId (optional) Tenant identifier.
846
+ * @return Success
847
+ */
848
+ getProductVariantMockups(id: number, productVersionId?: number | null | undefined, productVariantId?: number | null | undefined, search?: string | null | undefined, mockupCustomFields?: string | null | undefined, mockupPath?: string | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, options?: string | null | undefined, productFilterId?: number | null | undefined, takeAvailableOnly?: boolean | null | undefined, sku?: string | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfProductVariantMockupDto>;
849
+ protected processGetProductVariantMockups(response: AxiosResponse): Promise<PagedOfProductVariantMockupDto>;
850
+ /**
851
+ * Returns a list of product variant documents.
852
+ * @param id Product identifier.
853
+ * @param productVersionId (optional) Product version identifier.
854
+ * @param productVariantId (optional) Product variant identifier.
855
+ * @param search (optional) Search string for document name partial match.
856
+ * @param documentCustomFields (optional) Custom attributes dictionary filter for documents. For example: {"public":"true","name":"my item"}
857
+ * @param documentPath (optional) Path filter for documents. Subfolders included by default.
858
+ * @param skip (optional) Defines page start offset from beginning of sorted result list.
859
+ * @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
860
+ * @param options (optional) Defines options filter e.g.: "{ "opt1_id": "opt1_val1_id, opt1_val2_id", "opt2_id": "opt2_val1_id" }".
861
+ * @param productFilterId (optional) Defines special filter based on product filter with specified identifier.
862
+ * @param takeAvailableOnly (optional) Defines special filter for available product variants.
863
+ * @param sku (optional) SKU of linked ecommerce product.
864
+ * @param tenantId (optional) Tenant identifier.
865
+ * @return Success
866
+ */
867
+ getProductVariantDocuments(id: number, productVersionId?: number | null | undefined, productVariantId?: number | null | undefined, search?: string | null | undefined, documentCustomFields?: string | null | undefined, documentPath?: string | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, options?: string | null | undefined, productFilterId?: number | null | undefined, takeAvailableOnly?: boolean | null | undefined, sku?: string | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfProductVariantDocumentDto>;
868
+ protected processGetProductVariantDocuments(response: AxiosResponse): Promise<PagedOfProductVariantDocumentDto>;
869
+ /**
870
+ * Updates product variant resources.
871
+ * @param id Product identifier.
872
+ * @param productVersionId (optional) Product version identifier.
873
+ * @param tenantId (optional) Tenant identifier.
874
+ * @return Success
875
+ */
876
+ updateProductVariantResources(id: number, productVersionId?: number | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<void>;
877
+ protected processUpdateProductVariantResources(response: AxiosResponse): Promise<void>;
878
+ /**
879
+ * Set product variant price.
880
+ * @param id Product identifier.
881
+ * @param productVersionId (optional) Product version identifier.
882
+ * @param tenantId (optional) Tenant identifier.
883
+ * @param body (optional) Set product variant price operation parameters.
884
+ * @return Success
885
+ */
886
+ setProductVariantPrice(id: number, productVersionId?: number | null | undefined, tenantId?: number | null | undefined, body?: SetProductVariantPriceDto[] | null | undefined, cancelToken?: CancelToken | undefined): Promise<void>;
887
+ protected processSetProductVariantPrice(response: AxiosResponse): Promise<void>;
888
+ /**
889
+ * Returns a list of all available product tags.
890
+ * @param search (optional) Search string for partial match.
891
+ * @param tenantId (optional) Tenant identifier.
892
+ * @return Success
893
+ */
894
+ getAvailableProductTags(search?: string | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<string[]>;
895
+ protected processGetAvailableProductTags(response: AxiosResponse): Promise<string[]>;
896
+ /**
897
+ * Returns a product personalization workflow description by product identifier.
898
+ * @param id Product identifier.
899
+ * @param productVersionId (optional) Product version identifier.
900
+ * @param productLinkId (optional) Product link identifier.
901
+ * @param productFilterId (optional) Product filter identifier.
902
+ * @param tenantId (optional) Tenant identifier.
903
+ * @return Success
904
+ */
905
+ getPersonalizationWorkflow(id: number, productVersionId?: number | null | undefined, productLinkId?: number | null | undefined, productFilterId?: number | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PersonalizationWorkflowDto>;
906
+ protected processGetPersonalizationWorkflow(response: AxiosResponse): Promise<PersonalizationWorkflowDto>;
907
+ }
252
908
  export interface IProductSpecificationsApiClient {
253
909
  /**
254
910
  * Returns all product specifications, relevant to the specified query parameters.
@@ -338,11 +994,12 @@ export interface IProjectsApiClient {
338
994
  * @param search (optional) Search string for partial match.
339
995
  * @param orderId (optional) Identifier of corresponding order.
340
996
  * @param processingStatus (optional) Project processing status filter.
997
+ * @param includeObsolete (optional) Indicates if obsolete projects prepared to be removed should be included to result.
341
998
  * @param storefrontId (optional) Storefront identifier.
342
999
  * @param tenantId (optional) Tenant identifier.
343
1000
  * @return Success
344
1001
  */
345
- getAll(ownerId?: string | null | undefined, productReference?: string | null | undefined, status?: number | null | undefined, datePeriod?: DatePeriod | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, orderId?: string | null | undefined, processingStatus?: ProjectProcessingStatus | null | undefined, storefrontId?: number | null | undefined, tenantId?: number | null | undefined): Promise<PagedOfProjectDto>;
1002
+ getAll(ownerId?: string | null | undefined, productReference?: string | null | undefined, status?: number | null | undefined, datePeriod?: DatePeriod | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, orderId?: string | null | undefined, processingStatus?: ProjectProcessingStatus | null | undefined, includeObsolete?: boolean | undefined, storefrontId?: number | null | undefined, tenantId?: number | null | undefined): Promise<PagedOfProjectDto>;
346
1003
  /**
347
1004
  * Returns a project by identifier.
348
1005
  * @param id Project identifier.
@@ -426,6 +1083,14 @@ export interface IProjectsApiClient {
426
1083
  * @return Success
427
1084
  */
428
1085
  forceStatus(id: number, status: number, tenantId?: number | null | undefined): Promise<ProjectStatusDto>;
1086
+ /**
1087
+ * Deletes specified projects.
1088
+ These projects will be hide from projects list immediately, but complete projects data cleaning will take some additional time.
1089
+ * @param tenantId (optional) Tenant identifier.
1090
+ * @param body (optional) Operation parameters.
1091
+ * @return Success
1092
+ */
1093
+ batchDelete(tenantId?: number | null | undefined, body?: BatchDeleteProjectsInput | null | undefined): Promise<PagedOfProjectStatusDto>;
429
1094
  /**
430
1095
  * Returns a list of all existing project statuses.
431
1096
  * @param tenantId (optional) Tenant identifier.
@@ -493,7 +1158,7 @@ export interface IProjectsApiClient {
493
1158
  /**
494
1159
  * Attachs the specified data to the project's order in ecommerce system.
495
1160
  * @param id Project identifier.
496
- * @param itemId (optional)
1161
+ * @param itemId (optional) Project item identifier.
497
1162
  * @param tenantId (optional) Tenant identifier.
498
1163
  * @param body (optional) A list of data items, which should be attached to project's order.
499
1164
  * @return Success
@@ -517,11 +1182,12 @@ export declare class ProjectsApiClient extends ApiClientBase implements IProject
517
1182
  * @param search (optional) Search string for partial match.
518
1183
  * @param orderId (optional) Identifier of corresponding order.
519
1184
  * @param processingStatus (optional) Project processing status filter.
1185
+ * @param includeObsolete (optional) Indicates if obsolete projects prepared to be removed should be included to result.
520
1186
  * @param storefrontId (optional) Storefront identifier.
521
1187
  * @param tenantId (optional) Tenant identifier.
522
1188
  * @return Success
523
1189
  */
524
- getAll(ownerId?: string | null | undefined, productReference?: string | null | undefined, status?: number | null | undefined, datePeriod?: DatePeriod | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, orderId?: string | null | undefined, processingStatus?: ProjectProcessingStatus | null | undefined, storefrontId?: number | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfProjectDto>;
1190
+ getAll(ownerId?: string | null | undefined, productReference?: string | null | undefined, status?: number | null | undefined, datePeriod?: DatePeriod | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, orderId?: string | null | undefined, processingStatus?: ProjectProcessingStatus | null | undefined, includeObsolete?: boolean | undefined, storefrontId?: number | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfProjectDto>;
525
1191
  protected processGetAll(response: AxiosResponse): Promise<PagedOfProjectDto>;
526
1192
  /**
527
1193
  * Returns a project by identifier.
@@ -617,6 +1283,15 @@ export declare class ProjectsApiClient extends ApiClientBase implements IProject
617
1283
  */
618
1284
  forceStatus(id: number, status: number, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProjectStatusDto>;
619
1285
  protected processForceStatus(response: AxiosResponse): Promise<ProjectStatusDto>;
1286
+ /**
1287
+ * Deletes specified projects.
1288
+ These projects will be hide from projects list immediately, but complete projects data cleaning will take some additional time.
1289
+ * @param tenantId (optional) Tenant identifier.
1290
+ * @param body (optional) Operation parameters.
1291
+ * @return Success
1292
+ */
1293
+ batchDelete(tenantId?: number | null | undefined, body?: BatchDeleteProjectsInput | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfProjectStatusDto>;
1294
+ protected processBatchDelete(response: AxiosResponse): Promise<PagedOfProjectStatusDto>;
620
1295
  /**
621
1296
  * Returns a list of all existing project statuses.
622
1297
  * @param tenantId (optional) Tenant identifier.
@@ -692,7 +1367,7 @@ export declare class ProjectsApiClient extends ApiClientBase implements IProject
692
1367
  /**
693
1368
  * Attachs the specified data to the project's order in ecommerce system.
694
1369
  * @param id Project identifier.
695
- * @param itemId (optional)
1370
+ * @param itemId (optional) Project item identifier.
696
1371
  * @param tenantId (optional) Tenant identifier.
697
1372
  * @param body (optional) A list of data items, which should be attached to project's order.
698
1373
  * @return Success
@@ -958,12 +1633,246 @@ export interface ProblemDetails {
958
1633
  detail?: string | null;
959
1634
  instance?: string | null;
960
1635
  }
961
- /** Dto class, containing information about storefront product reference. */
1636
+ /** DTO class, containing information about a product resource of type image. */
1637
+ export interface ImageInfo {
1638
+ /** Product resource identifier. */
1639
+ resourceId?: string | null;
1640
+ /** Product Resource URL. */
1641
+ url?: string | null;
1642
+ }
1643
+ /** Available option types. */
1644
+ export declare enum OptionType {
1645
+ Simple = "Simple",
1646
+ Size = "Size",
1647
+ PageCount = "PageCount"
1648
+ }
1649
+ /** DTO class, containing information about a product filter option. */
1650
+ export interface ProductFilterOptionDto {
1651
+ /** Product option identifier. */
1652
+ productOptionId?: number | null;
1653
+ /** Product option value identifier. */
1654
+ productOptionValueId?: number | null;
1655
+ /** Product option type ('Simple' / 'Size' / 'PageCount'). */
1656
+ productOptionType?: OptionType;
1657
+ /** Product option traits. */
1658
+ productOptionTraits?: string[] | null;
1659
+ /** Product option title. */
1660
+ productOptionTitle?: string | null;
1661
+ /** Product option value title. */
1662
+ productOptionValueTitle?: string | null;
1663
+ /** Indicates if option value should be used as a default value for corresponding option. */
1664
+ isDefault?: boolean;
1665
+ }
1666
+ /** DTO class, containing information about a product link. */
1667
+ export interface ProductLinkDto {
1668
+ /** Product link identifier. */
1669
+ id?: number;
1670
+ /** Product link version identifier. */
1671
+ productLinkVersionId?: number;
1672
+ /** Linked product identifier. */
1673
+ productId?: number;
1674
+ /** Linked product version identifier. */
1675
+ productVersionId?: number;
1676
+ /** Tenant identifier. */
1677
+ tenantId?: number;
1678
+ /** Product link name. */
1679
+ name?: string | null;
1680
+ /** Product link description. */
1681
+ description?: string | null;
1682
+ /** Product filter identifier. */
1683
+ productFilterId?: number;
1684
+ /** Product link image info. */
1685
+ image?: ImageInfo | null;
1686
+ /** Product link creation time. */
1687
+ created?: string;
1688
+ /** Product link modification time. */
1689
+ lastModified?: string | null;
1690
+ /** Product filter options. */
1691
+ productFilterOptions?: ProductFilterOptionDto[] | null;
1692
+ /** Personalization workflow identifier. */
1693
+ personalizationWorkflowId?: number | null;
1694
+ /** Processing pipeline identifier. */
1695
+ processingPipelineId?: number | null;
1696
+ /** Default storefront identifier. */
1697
+ storefrontId?: number | null;
1698
+ /** Default storefront product identifier. */
1699
+ storefrontProductId?: string | null;
1700
+ /** Default storefront product name. */
1701
+ storefrontProductName?: string | null;
1702
+ }
1703
+ /** Paged list of items. */
1704
+ export interface PagedOfProductLinkDto {
1705
+ /** Items count. */
1706
+ total?: number;
1707
+ /** Items list. */
1708
+ items?: ProductLinkDto[] | null;
1709
+ }
1710
+ /** Conflict types. */
1711
+ export declare enum ConflictType {
1712
+ NameConflict = "NameConflict",
1713
+ FolderOverwriteConflict = "FolderOverwriteConflict",
1714
+ IdConflict = "IdConflict",
1715
+ GeneralConflict = "GeneralConflict"
1716
+ }
1717
+ /** Information about operation conflict. */
1718
+ export interface GeneralConflictDto {
1719
+ /** Problem description. */
1720
+ description?: string | null;
1721
+ /** Coflict type. */
1722
+ type?: ConflictType;
1723
+ }
1724
+ /** Available appearance types. */
1725
+ export declare enum AppearanceDataType {
1726
+ Radio = "Radio",
1727
+ Dropdown = "Dropdown",
1728
+ Chips = "Chips",
1729
+ ColorGrid = "ColorGrid",
1730
+ ColorList = "ColorList",
1731
+ ImageGrid = "ImageGrid",
1732
+ ImageList = "ImageList"
1733
+ }
1734
+ /** DTO class, containing information about a product option appearance item. */
1735
+ export interface AppearanceDataItemDto {
1736
+ /** Appearance item key. */
1737
+ key?: string | null;
1738
+ /** Appearance item value. */
1739
+ value?: string | null;
1740
+ }
1741
+ /** DTO class, containing information about a product option appearance. */
1742
+ export interface AppearanceDataDto {
1743
+ /** Appearance type. */
1744
+ type?: AppearanceDataType;
1745
+ /** Appearance items. */
1746
+ items?: AppearanceDataItemDto[] | null;
1747
+ }
1748
+ /** Option values for product summary model. */
1749
+ export interface ProductSummaryOptionValueDto {
1750
+ /** Option value identifier. */
1751
+ id?: number;
1752
+ /** Option value identifying tag. */
1753
+ tag?: string | null;
1754
+ /** Option value title. */
1755
+ title?: string | null;
1756
+ /** Option value value. */
1757
+ value?: string | null;
1758
+ /** Indicates if option value is used as a default value. */
1759
+ isDefault?: boolean;
1760
+ /** Option value description. */
1761
+ description?: string | null;
1762
+ /** Option value colors. */
1763
+ colors?: string[] | null;
1764
+ /** Option value image. */
1765
+ image?: ImageInfo | null;
1766
+ }
1767
+ /** Options for product summary model. */
1768
+ export interface ProductSummaryOptionDto {
1769
+ /** Option identifier. */
1770
+ id?: number;
1771
+ /** Option identifying tag. */
1772
+ tag?: string | null;
1773
+ /** Option title. */
1774
+ title?: string | null;
1775
+ /** Option description. */
1776
+ description?: string | null;
1777
+ /** Option tooltip. */
1778
+ tooltip?: string | null;
1779
+ /** Option sort index. */
1780
+ sortIndex?: number;
1781
+ /** Option traits. */
1782
+ traits?: string[] | null;
1783
+ /** Indicates if option is used to bind designs to product. */
1784
+ useForDesignBinding?: boolean;
1785
+ /** Indicates if option is used to bind mockups to product. */
1786
+ useForMockupBinding?: boolean;
1787
+ /** Indicates if option is used to bind documents to product. */
1788
+ useForDocumentBinding?: boolean;
1789
+ /** Option appearance. */
1790
+ appearanceData?: AppearanceDataDto | null;
1791
+ /** Option image info. */
1792
+ image?: ImageInfo | null;
1793
+ /** Option values. */
1794
+ productOptionValues?: ProductSummaryOptionValueDto[] | null;
1795
+ }
1796
+ /** General information about product that editors need to begin personalization process. */
1797
+ export interface ProductSummaryDto {
1798
+ /** Product identifier. */
1799
+ productId?: number;
1800
+ /** Product version identifier. If product variant is not specified, active version identifier should be used. */
1801
+ productVersionId?: number;
1802
+ /** Product link identifier. If product link is not specified, should be null. */
1803
+ productLinkId?: number | null;
1804
+ /** Product link version identifier. If product link is not specified, should be null. */
1805
+ productLinkVersionId?: number | null;
1806
+ /** Product filter identifier for product link. If product link is not specified, should be null. */
1807
+ productFilterId?: number | null;
1808
+ /** Product variant identifier. If product variant is not specified, should be null. */
1809
+ productVariantId?: number | null;
1810
+ /** Product variant SKU. If product variant is not specified, should be null. */
1811
+ productVariantSku?: string | null;
1812
+ /** Product variant price. If product variant is not specified, should be null. */
1813
+ productVariantPrice?: number | null;
1814
+ /** Product variant availability. If product variant is not specified, should be null. */
1815
+ isProductVariantAvailable?: boolean | null;
1816
+ /** Product name. If product link is specified, name of link will be used. */
1817
+ name?: string | null;
1818
+ /** Product description. If product link is specified, description of link will be used. */
1819
+ description?: string | null;
1820
+ /** Product image info. */
1821
+ image?: ImageInfo | null;
1822
+ /** Tenant identifier. */
1823
+ tenantId?: number;
1824
+ /** Personalization workflow identifier. */
1825
+ personalizationWorkflowId?: number | null;
1826
+ /** Processing pipeline identifier. */
1827
+ processingPipelineId?: number | null;
1828
+ /** Product tags. */
1829
+ tags?: string[] | null;
1830
+ /** Product custom fields. */
1831
+ customFields?: {
1832
+ [key: string]: string;
1833
+ } | null;
1834
+ /** Product options summary.
1835
+ If product link or variant is specified, product options will be filtered by link or variant options. */
1836
+ options?: ProductSummaryOptionDto[] | null;
1837
+ }
1838
+ /** Type of editor that should be configured by workflow. */
1839
+ export declare enum WorkflowType {
1840
+ UIFramework = "UIFramework",
1841
+ SimpleEditor = "SimpleEditor",
1842
+ DesignEditor = "DesignEditor",
1843
+ WorkflowElements = "WorkflowElements"
1844
+ }
1845
+ /** Personalization workflow description DTO. */
1846
+ export interface PersonalizationWorkflowDto {
1847
+ /** Workflow identifier. */
1848
+ id?: number;
1849
+ /** Processed workflow JSON. */
1850
+ content?: string | null;
1851
+ /** Workflow type. */
1852
+ workflowType?: WorkflowType;
1853
+ }
1854
+ /** Available product reference target types. */
1855
+ export declare enum ProductReferenceType {
1856
+ ProductSpecification = "ProductSpecification",
1857
+ Product = "Product",
1858
+ ProductLink = "ProductLink"
1859
+ }
1860
+ /** DTO class, containing information about storefront product reference. */
962
1861
  export interface ProductReferenceDto {
963
- /** Product reference is an external reference to Customer's Canvas product specification, e.g online store product identifier. */
1862
+ /** Product reference is an external reference to Customer's Canvas product, e.g online store product identifier. */
964
1863
  productReference?: string | null;
1864
+ /** Product reference target type. */
1865
+ productReferenceType?: ProductReferenceType;
1866
+ /** Product reference name, e.g. online store product name. */
1867
+ productReferenceName?: string | null;
965
1868
  /** Customer's Canvas product specification identifier. */
966
1869
  productSpecificationId?: number;
1870
+ /** Customer's Canvas product identifier. */
1871
+ productId?: number;
1872
+ /** Customer's Canvas product version identifier. */
1873
+ productVersionId?: number;
1874
+ /** Customer's Canvas product link identifier. */
1875
+ productLinkId?: number;
967
1876
  /** Storefront identifier. */
968
1877
  storefrontId?: number;
969
1878
  /** Tenant identifier. */
@@ -980,10 +1889,44 @@ export interface PagedOfProductReferenceDto {
980
1889
  }
981
1890
  /** Dto class, containing create operation parameters for storefront product reference. */
982
1891
  export interface CreateProductReferenceDto {
983
- /** Product reference is an external reference to Customer's Canvas product specification, e.g online store product identifier. */
1892
+ /** Product reference is an external reference to Customer's Canvas product, e.g online store product identifier. */
984
1893
  productReference: string;
1894
+ /** Product reference target type. */
1895
+ productReferenceType?: ProductReferenceType;
1896
+ /** Product reference name, e.g. online store product name. */
1897
+ productReferenceName?: string | null;
1898
+ /** Customer's Canvas product specification identifier. */
1899
+ productSpecificationId?: number | null;
1900
+ /** Customer's Canvas product identifier. */
1901
+ productId?: number | null;
1902
+ /** Customer's Canvas product link identifier. */
1903
+ productLinkId?: number | null;
1904
+ }
1905
+ /** DTO class, containing information about storefront product reference. */
1906
+ export interface ProductReferenceInfo {
1907
+ /** Product reference is an external reference to Customer's Canvas product, e.g online store product identifier. */
1908
+ productReference?: string | null;
1909
+ /** Product reference target type. */
1910
+ productReferenceType?: ProductReferenceType;
1911
+ /** Product reference name, e.g. online store product name. */
1912
+ productReferenceName?: string | null;
985
1913
  /** Customer's Canvas product specification identifier. */
986
- productSpecificationId: number;
1914
+ productSpecificationId?: number;
1915
+ /** Customer's Canvas product identifier. */
1916
+ productId?: number;
1917
+ /** Customer's Canvas product link identifier. */
1918
+ productLinkId?: number;
1919
+ /** Storefront identifier. */
1920
+ storefrontId?: number;
1921
+ }
1922
+ /** DTO class, containing information about storefront product reference creation conflict. */
1923
+ export interface ProductReferenceCreationConflictDto {
1924
+ /** List of storefront product references, which are already exist. */
1925
+ existingReferences?: ProductReferenceInfo[] | null;
1926
+ /** Problem description. */
1927
+ description?: string | null;
1928
+ /** Coflict type. */
1929
+ type?: ConflictType;
987
1930
  }
988
1931
  /** Dto class, containing information about product attribute. */
989
1932
  export interface ProductAttributeDto {
@@ -1013,6 +1956,55 @@ export interface ProductSpecificationDto {
1013
1956
  /** Processing pipeline identifier. */
1014
1957
  processingPipelineId?: number;
1015
1958
  }
1959
+ /** Paged list of items. */
1960
+ export interface PagedOfProductSpecificationDto {
1961
+ /** Items count. */
1962
+ total?: number;
1963
+ /** Items list. */
1964
+ items?: ProductSpecificationDto[] | null;
1965
+ }
1966
+ /** DTO class, containing information about a product. */
1967
+ export interface ProductDto {
1968
+ /** Product identifier. */
1969
+ id?: number;
1970
+ /** Product version identifier. */
1971
+ productVersionId?: number;
1972
+ /** Tenant identifier. */
1973
+ tenantId?: number;
1974
+ /** Product name. */
1975
+ name?: string | null;
1976
+ /** Product description. */
1977
+ description?: string | null;
1978
+ /** Product image info. */
1979
+ image?: ImageInfo | null;
1980
+ /** Product creation time. */
1981
+ created?: string;
1982
+ /** Product modification time. */
1983
+ lastModified?: string | null;
1984
+ /** Product tags. */
1985
+ tags?: string[] | null;
1986
+ /** Product custom fields. */
1987
+ customFields?: {
1988
+ [key: string]: string;
1989
+ } | null;
1990
+ /** Personalization workflow identifier. */
1991
+ personalizationWorkflowId?: number;
1992
+ /** Processing pipeline identifier. */
1993
+ processingPipelineId?: number;
1994
+ /** Default storefront identifier. */
1995
+ storefrontId?: number | null;
1996
+ /** Default storefront product identifier. */
1997
+ storefrontProductId?: string | null;
1998
+ /** Default storefront product name. */
1999
+ storefrontProductName?: string | null;
2000
+ }
2001
+ /** Paged list of items. */
2002
+ export interface PagedOfProductDto {
2003
+ /** Items count. */
2004
+ total?: number;
2005
+ /** Items list. */
2006
+ items?: ProductDto[] | null;
2007
+ }
1016
2008
  /** Dto class, containing information about storefront product cost details. */
1017
2009
  export interface ProductCostDetailsDto {
1018
2010
  /** Product reference is an external reference to Customer's Canvas product specification, e.g online store product identifier. */
@@ -1032,28 +2024,277 @@ export interface ProductCostDetailsDto {
1032
2024
  /** Tenant identifier. */
1033
2025
  tenantId?: number;
1034
2026
  }
1035
- /** Type of editor that should be configured by workflow. */
1036
- export declare enum WorkflowType {
1037
- UIFramework = "UIFramework",
1038
- SimpleEditor = "SimpleEditor",
1039
- DesignEditor = "DesignEditor",
1040
- WorkflowElements = "WorkflowElements"
2027
+ /** Option value description for 'Simple' option type. */
2028
+ export interface SimpleOptionValue {
2029
+ /** String Value. */
2030
+ value?: string | null;
1041
2031
  }
1042
- /** Personalization workflow description DTO. */
1043
- export interface PersonalizationWorkflowDto {
1044
- /** Workflow identifier. */
2032
+ /** DTO class, containing information about a product option value. */
2033
+ export interface ProductOptionValueDto {
2034
+ /** Product option value identifier. */
1045
2035
  id?: number;
1046
- /** Processed workflow JSON. */
1047
- content?: string | null;
1048
- /** Workflow type. */
1049
- workflowType?: WorkflowType;
2036
+ /** Product option value title. */
2037
+ title?: string | null;
2038
+ /** Product option value sort index. */
2039
+ sortIndex?: number;
2040
+ /** Indicates if product option value is used as a default value. */
2041
+ isDefault?: boolean;
2042
+ /** Product option value identifying tag. */
2043
+ tag?: string | null;
2044
+ /** Product option value description for 'Simple' option type. */
2045
+ simpleOptionValue?: SimpleOptionValue | null;
2046
+ /** Product option value description. */
2047
+ description?: string | null;
2048
+ /** Product option value colors. */
2049
+ colors?: string[] | null;
2050
+ /** Product option value image. */
2051
+ image?: ImageInfo | null;
2052
+ }
2053
+ /** DTO class, containing information about a product option. */
2054
+ export interface ProductOptionDto {
2055
+ /** Product option identifier. */
2056
+ id?: number;
2057
+ /** Product version identifier */
2058
+ productVersionId?: number;
2059
+ /** Product identifier. */
2060
+ productId?: number;
2061
+ /** Tenant identifier. */
2062
+ tenantId?: number;
2063
+ /** Option type ('Simple' / 'Size' / 'PageCount'). */
2064
+ type?: OptionType;
2065
+ /** Option traits. */
2066
+ traits?: string[] | null;
2067
+ /** Product option title. */
2068
+ title?: string | null;
2069
+ /** Product option sort index. */
2070
+ sortIndex?: number;
2071
+ /** Product option identifying tag. */
2072
+ tag?: string | null;
2073
+ /** Specifies if the option is used for design binding. */
2074
+ useForDesignBinding?: boolean;
2075
+ /** Specifies if the option is used for mockup binding. */
2076
+ useForMockupBinding?: boolean;
2077
+ /** Specifies if the option is used for document binding. */
2078
+ useForDocumentBinding?: boolean;
2079
+ /** Product option description. */
2080
+ description?: string | null;
2081
+ /** Product option tooltip. */
2082
+ tooltip?: string | null;
2083
+ /** Product option appearance. */
2084
+ appearanceData?: AppearanceDataDto | null;
2085
+ /** Product option image info. */
2086
+ image?: ImageInfo | null;
2087
+ /** A list of product option values. */
2088
+ productOptionValues?: ProductOptionValueDto[] | null;
1050
2089
  }
1051
2090
  /** Paged list of items. */
1052
- export interface PagedOfProductSpecificationDto {
2091
+ export interface PagedOfProductOptionDto {
1053
2092
  /** Items count. */
1054
2093
  total?: number;
1055
2094
  /** Items list. */
1056
- items?: ProductSpecificationDto[] | null;
2095
+ items?: ProductOptionDto[] | null;
2096
+ }
2097
+ /** DTO class, containing information about a product variant option. */
2098
+ export interface ProductVariantOptionDto {
2099
+ /** Product option identifier. */
2100
+ productOptionId?: number | null;
2101
+ /** Product option value identifier. */
2102
+ productOptionValueId?: number | null;
2103
+ /** Product option type ('Simple' / 'Size' / 'PageCount'). */
2104
+ productOptionType?: OptionType;
2105
+ /** Product option traits. */
2106
+ productOptionTraits?: string[] | null;
2107
+ /** Product option title. */
2108
+ productOptionTitle?: string | null;
2109
+ /** Product option value title. */
2110
+ productOptionValueTitle?: string | null;
2111
+ /** Product option value description for 'Simple' option type. */
2112
+ simpleOptionValue?: SimpleOptionValue | null;
2113
+ }
2114
+ /** DTO class, containing information about a product variant. */
2115
+ export interface ProductVariantDto {
2116
+ /** Product variant identifier. */
2117
+ id?: number;
2118
+ /** Product version identifier. */
2119
+ productVersionId?: number;
2120
+ /** Product identifier. */
2121
+ productId?: number;
2122
+ /** Tenant identifier. */
2123
+ tenantId?: number;
2124
+ /** Product variant available. */
2125
+ isAvailable?: boolean;
2126
+ /** Product variant price. */
2127
+ price?: number | null;
2128
+ /** Product variant sort index. */
2129
+ sortIndex?: number;
2130
+ /** Product variant identifier (usually SKU) in storefront / online store. */
2131
+ storefrontProductVariantId?: string | null;
2132
+ /** A list of product variant options. */
2133
+ productVariantOptions?: ProductVariantOptionDto[] | null;
2134
+ }
2135
+ /** Paged list of items. */
2136
+ export interface PagedOfProductVariantDto {
2137
+ /** Items count. */
2138
+ total?: number;
2139
+ /** Items list. */
2140
+ items?: ProductVariantDto[] | null;
2141
+ }
2142
+ /** Available product variant resource types. */
2143
+ export declare enum ProductVariantResourceType {
2144
+ Preview = "Preview",
2145
+ EditorModel = "EditorModel",
2146
+ Custom = "Custom"
2147
+ }
2148
+ /** Product variant resource description for 'Preview' resource type. */
2149
+ export interface ProductVariantResourcePreview {
2150
+ /** Preview with in pixels. */
2151
+ width?: number | null;
2152
+ /** Preview heigth in pixels. */
2153
+ height?: number | null;
2154
+ /** Mockup which is used to create preview. */
2155
+ mockupId?: string | null;
2156
+ /** Design surface index which is used to create preivew. */
2157
+ surfaceIndex?: number | null;
2158
+ }
2159
+ /** DTO class, containing information about a product variant resource. */
2160
+ export interface ProductVariantResourceDto {
2161
+ /** Resource identifier. */
2162
+ resourceId?: string | null;
2163
+ /** Resource name. */
2164
+ name?: string | null;
2165
+ /** Resource url. */
2166
+ url?: string | null;
2167
+ /** Resource type. */
2168
+ type?: ProductVariantResourceType;
2169
+ /** Product variant resource description for 'Preview' resource type. */
2170
+ resourcePreview?: ProductVariantResourcePreview | null;
2171
+ }
2172
+ /** DTO class, containing information about a product variant design. */
2173
+ export interface ProductVariantDesignDto {
2174
+ /** Product variant identifier. */
2175
+ productVariantId?: number;
2176
+ /** Product version identifier. */
2177
+ productVersionId?: number;
2178
+ /** Product identifier. */
2179
+ productId?: number;
2180
+ /** Tenant identifier. */
2181
+ tenantId?: number;
2182
+ /** Product variant available. */
2183
+ isAvailable?: boolean;
2184
+ /** Product variant price. */
2185
+ price?: number | null;
2186
+ /** Product variant sort index. */
2187
+ sortIndex?: number;
2188
+ /** Product variant identifier (usually SKU) in storefront / online store. */
2189
+ storefrontProductVariantId?: string | null;
2190
+ /** Design identifier. */
2191
+ designId?: string | null;
2192
+ /** Design name. */
2193
+ designName?: string | null;
2194
+ /** Design grouping tag. */
2195
+ designGroup?: string | null;
2196
+ /** Design data schema tag. Indicates if design has data schema. */
2197
+ designHasDataSchema?: boolean;
2198
+ /** Design toggle set tag. Indicated if design has toggle set. */
2199
+ designHasToggleSet?: boolean;
2200
+ /** A list of product variant options. */
2201
+ productVariantOptions?: ProductVariantOptionDto[] | null;
2202
+ /** A list of product variant resources. */
2203
+ productVariantResources?: ProductVariantResourceDto[] | null;
2204
+ }
2205
+ /** Paged list of items. */
2206
+ export interface PagedOfProductVariantDesignDto {
2207
+ /** Items count. */
2208
+ total?: number;
2209
+ /** Items list. */
2210
+ items?: ProductVariantDesignDto[] | null;
2211
+ }
2212
+ /** Available mockup types. */
2213
+ export declare enum ProductVariantMockupType {
2214
+ Thumbnail = "Thumbnail",
2215
+ Editor = "Editor",
2216
+ Preview = "Preview"
2217
+ }
2218
+ /** Available surface usage types. */
2219
+ export declare enum SurfaceUsageType {
2220
+ Individual = "Individual",
2221
+ Custom = "Custom",
2222
+ All = "All"
2223
+ }
2224
+ /** Dto class, containing information about a product variant mockup. */
2225
+ export interface ProductVariantMockupDto {
2226
+ /** Product variant identifier. */
2227
+ productVariantId?: number;
2228
+ /** Product version identifier. */
2229
+ productVersionId?: number;
2230
+ /** Product identifier. */
2231
+ productId?: number;
2232
+ /** Tenant identifier. */
2233
+ tenantId?: number | null;
2234
+ /** Product variant identifier in online store (usually SKU). */
2235
+ storefrontProductVariantId?: string | null;
2236
+ /** Mockup identifier. */
2237
+ mockupId?: string | null;
2238
+ /** Mockup name. */
2239
+ mockupName?: string | null;
2240
+ /** Mockup type. */
2241
+ mockupType?: ProductVariantMockupType;
2242
+ /** Surface index indicates a surface of a design to which mockup should be applied. */
2243
+ surfaceIndex?: number | null;
2244
+ /** Surface usage type defines a scheme for applying mockup to design surfaces. */
2245
+ surfaceUsageType?: SurfaceUsageType;
2246
+ /** A list of product variant options. */
2247
+ productVariantOptions?: ProductVariantOptionDto[] | null;
2248
+ }
2249
+ /** Paged list of items. */
2250
+ export interface PagedOfProductVariantMockupDto {
2251
+ /** Items count. */
2252
+ total?: number;
2253
+ /** Items list. */
2254
+ items?: ProductVariantMockupDto[] | null;
2255
+ }
2256
+ /** DTO class, containing information about a product variant document. */
2257
+ export interface ProductVariantDocumentDto {
2258
+ /** Product variant identifier. */
2259
+ productVariantId?: number;
2260
+ /** Product version identifier. */
2261
+ productVersionId?: number;
2262
+ /** Product identifier. */
2263
+ productId?: number;
2264
+ /** Tenant identifier. */
2265
+ tenantId?: number;
2266
+ /** Product variant available. */
2267
+ isAvailable?: boolean;
2268
+ /** Product variant price. */
2269
+ price?: number | null;
2270
+ /** Product variant sort index. */
2271
+ sortIndex?: number;
2272
+ /** Product variant identifier (usually SKU) in storefront / online store. */
2273
+ storefrontProductVariantId?: string | null;
2274
+ /** Document identifier. */
2275
+ documentId?: string | null;
2276
+ /** Document name. */
2277
+ documentName?: string | null;
2278
+ /** Document grouping tag. */
2279
+ documentGroup?: string | null;
2280
+ /** A list of product variant options. */
2281
+ productVariantOptions?: ProductVariantOptionDto[] | null;
2282
+ /** A list of product variant resources. */
2283
+ productVariantResources?: ProductVariantResourceDto[] | null;
2284
+ }
2285
+ /** Paged list of items. */
2286
+ export interface PagedOfProductVariantDocumentDto {
2287
+ /** Items count. */
2288
+ total?: number;
2289
+ /** Items list. */
2290
+ items?: ProductVariantDocumentDto[] | null;
2291
+ }
2292
+ /** Parameters for setting product variants price. */
2293
+ export interface SetProductVariantPriceDto {
2294
+ /** Price. */
2295
+ price?: number | null;
2296
+ /** Identifiers of variants for price setting. */
2297
+ variantIds?: number[] | null;
1057
2298
  }
1058
2299
  /** Defines all available date period filter values for queries. */
1059
2300
  export declare enum DatePeriod {
@@ -1280,6 +2521,13 @@ export declare enum RenderHiResScenarioOutputFlipMode {
1280
2521
  Vertical = "Vertical",
1281
2522
  Both = "Both"
1282
2523
  }
2524
+ export declare enum RenderHiResScenarioOutputRotateMode {
2525
+ None = "None",
2526
+ Rotate90 = "Rotate90",
2527
+ Rotate180 = "Rotate180",
2528
+ Rotate270 = "Rotate270",
2529
+ Auto = "Auto"
2530
+ }
1283
2531
  /** Dto class, containing 'RenderHiRes' scenario parameters. */
1284
2532
  export interface RenderHiResScenarioDto {
1285
2533
  /** Private design identifier. */
@@ -1294,6 +2542,8 @@ export interface RenderHiResScenarioDto {
1294
2542
  colorSpace?: RenderHiResScenarioOutputColorSpace | null;
1295
2543
  /** Output file flip mode. */
1296
2544
  flipMode?: RenderHiResScenarioOutputFlipMode | null;
2545
+ /** Output file rotate mode. */
2546
+ rotateMode?: RenderHiResScenarioOutputRotateMode | null;
1297
2547
  /** Output file access mode. */
1298
2548
  anonymousAccess?: boolean | null;
1299
2549
  }
@@ -1360,11 +2610,6 @@ export interface PagedOfProjectTransitionDto {
1360
2610
  /** Items list. */
1361
2611
  items?: ProjectTransitionDto[] | null;
1362
2612
  }
1363
- /** Dto class, containing information about the project transition conflict. */
1364
- export interface ProjectTransitionConflictDto {
1365
- /** A list of all available status transitions for the project. */
1366
- availableTransitions?: ProjectTransitionDto[] | null;
1367
- }
1368
2613
  /** Dto class, containing the information about project status. */
1369
2614
  export interface ProjectStatusDto {
1370
2615
  /** Status code. */
@@ -1372,6 +2617,20 @@ export interface ProjectStatusDto {
1372
2617
  /** Status display name. */
1373
2618
  displayName?: string | null;
1374
2619
  }
2620
+ /** Dto class, containing information about the project transition conflict. */
2621
+ export interface ProjectTransitionConflictDto {
2622
+ /** A list of all available status transitions for the project. */
2623
+ availableTransitions?: ProjectTransitionDto[] | null;
2624
+ /** Problem description. */
2625
+ description?: string | null;
2626
+ /** Coflict type. */
2627
+ type?: ConflictType;
2628
+ }
2629
+ /** Dto class, containing parameters for the 'projects batch delete' operation. */
2630
+ export interface BatchDeleteProjectsInput {
2631
+ /** Identifiers of projects that should be deleted. */
2632
+ ids?: number[] | null;
2633
+ }
1375
2634
  /** Paged list of items. */
1376
2635
  export interface PagedOfProjectStatusDto {
1377
2636
  /** Items count. */