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