@aurigma/axios-backoffice-api-client 2.54.43
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/LICENSE.md +9 -0
- package/README.md +96 -0
- package/dist/cjs/backoffice-api-client.d.ts +1903 -0
- package/dist/cjs/backoffice-api-client.js +3883 -0
- package/dist/cjs/backoffice-api-client.js.map +1 -0
- package/dist/esm/backoffice-api-client.d.ts +1903 -0
- package/dist/esm/backoffice-api-client.js +3880 -0
- package/dist/esm/backoffice-api-client.js.map +1 -0
- package/package.json +46 -0
|
@@ -0,0 +1,1903 @@
|
|
|
1
|
+
import { AxiosInstance, AxiosRequestConfig, AxiosResponse, CancelToken } from 'axios';
|
|
2
|
+
export declare module BackOfficeApiClient {
|
|
3
|
+
class ApiClientConfiguration {
|
|
4
|
+
apiUrl: string;
|
|
5
|
+
apiKey: string;
|
|
6
|
+
private authorizationToken;
|
|
7
|
+
getAuthorizationToken(): Promise<string>;
|
|
8
|
+
setAuthorizationToken(token: string): void;
|
|
9
|
+
}
|
|
10
|
+
class ApiClientBase {
|
|
11
|
+
private configuration;
|
|
12
|
+
constructor(configuration: ApiClientConfiguration);
|
|
13
|
+
protected transformOptions(options: AxiosRequestConfig): Promise<AxiosRequestConfig>;
|
|
14
|
+
protected getBaseUrl(defultUrl: string): string;
|
|
15
|
+
protected transformResult(url: string, res: AxiosResponse, cb: (res: AxiosResponse) => Promise<any>): Promise<any>;
|
|
16
|
+
}
|
|
17
|
+
interface IBuildInfoApiClient {
|
|
18
|
+
/**
|
|
19
|
+
* Returns assembly build info.
|
|
20
|
+
* @return Success
|
|
21
|
+
*/
|
|
22
|
+
headInfo(): Promise<void>;
|
|
23
|
+
/**
|
|
24
|
+
* Returns assembly build info.
|
|
25
|
+
* @return Success
|
|
26
|
+
*/
|
|
27
|
+
getInfo(): Promise<BuildInfoModel>;
|
|
28
|
+
}
|
|
29
|
+
class BuildInfoApiClient extends ApiClientBase implements IBuildInfoApiClient {
|
|
30
|
+
private instance;
|
|
31
|
+
private baseUrl;
|
|
32
|
+
protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
|
|
33
|
+
constructor(configuration: ApiClientConfiguration, baseUrl?: string, instance?: AxiosInstance);
|
|
34
|
+
/**
|
|
35
|
+
* Returns assembly build info.
|
|
36
|
+
* @return Success
|
|
37
|
+
*/
|
|
38
|
+
headInfo(cancelToken?: CancelToken | undefined): Promise<void>;
|
|
39
|
+
protected processHeadInfo(response: AxiosResponse): Promise<void>;
|
|
40
|
+
/**
|
|
41
|
+
* Returns assembly build info.
|
|
42
|
+
* @return Success
|
|
43
|
+
*/
|
|
44
|
+
getInfo(cancelToken?: CancelToken | undefined): Promise<BuildInfoModel>;
|
|
45
|
+
protected processGetInfo(response: AxiosResponse): Promise<BuildInfoModel>;
|
|
46
|
+
}
|
|
47
|
+
interface IProductReferencesManagementApiClient {
|
|
48
|
+
/**
|
|
49
|
+
* Returns all storefront product references relevant to the specified query parameters.
|
|
50
|
+
* @param storefrontId Storefront identifier.
|
|
51
|
+
* @param productReference (optional) Product reference filter.
|
|
52
|
+
Product reference is an external reference to Customer's Canvas product, e.g online store product identifier.
|
|
53
|
+
* @param productSpecificationId (optional) Customer's Canvas product specification filter.
|
|
54
|
+
* @param productId (optional) Customer's Canvas product filter.
|
|
55
|
+
* @param productLinkId (optional) Customer's Canvas product link filter.
|
|
56
|
+
* @param skip (optional) Defines page start offset from beginning of sorted result list.
|
|
57
|
+
* @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
|
|
58
|
+
* @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC".
|
|
59
|
+
* @param search (optional) Search string for partial match.
|
|
60
|
+
* @param sku (optional) SKU filter.
|
|
61
|
+
* @param tags (optional) List of tags that product should have.
|
|
62
|
+
* @param customFields (optional) Serialized custom fields dictionary filter. For example: {"public":"true","name":"my item"}.
|
|
63
|
+
* @param tenantId (optional) Tenant identifier.
|
|
64
|
+
* @return Success
|
|
65
|
+
*/
|
|
66
|
+
getAll(storefrontId: number, productReference?: string | null | undefined, productSpecificationId?: number | null | undefined, productId?: number | null | undefined, productLinkId?: number | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, sku?: string | null | undefined, tags?: string[] | null | undefined, customFields?: string | null | undefined, tenantId?: number | null | undefined): Promise<PagedOfProductReferenceDto>;
|
|
67
|
+
/**
|
|
68
|
+
* Creates a new storefront product reference.
|
|
69
|
+
* @param storefrontId Storefront identifier.
|
|
70
|
+
* @param tenantId (optional) Tenant identifier.
|
|
71
|
+
* @param body (optional) Create operation parameters.
|
|
72
|
+
* @return Success
|
|
73
|
+
*/
|
|
74
|
+
create(storefrontId: number, tenantId?: number | null | undefined, body?: CreateProductReferenceDto | null | undefined): Promise<ProductReferenceDto>;
|
|
75
|
+
/**
|
|
76
|
+
* Returns a storefront product reference.
|
|
77
|
+
* @param reference An external reference to Customer's Canvas product, e.g online store product identifier.
|
|
78
|
+
* @param storefrontId Storefront identifier.
|
|
79
|
+
* @param tenantId (optional) Tenant identifier.
|
|
80
|
+
* @return Success
|
|
81
|
+
*/
|
|
82
|
+
get(reference: string | null, storefrontId: number, tenantId?: number | null | undefined): Promise<ProductReferenceDto>;
|
|
83
|
+
/**
|
|
84
|
+
* Deletes the storefront product reference.
|
|
85
|
+
* @param reference Product reference - external reference to Customer's Canvas product specification, e.g online store product identifier.
|
|
86
|
+
* @param storefrontId Storefront identifier.
|
|
87
|
+
* @param tenantId (optional) Tenant identifier.
|
|
88
|
+
* @return Success
|
|
89
|
+
*/
|
|
90
|
+
delete(reference: string | null, storefrontId: number, tenantId?: number | null | undefined): Promise<ProductReferenceDto>;
|
|
91
|
+
}
|
|
92
|
+
class ProductReferencesManagementApiClient extends ApiClientBase implements IProductReferencesManagementApiClient {
|
|
93
|
+
private instance;
|
|
94
|
+
private baseUrl;
|
|
95
|
+
protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
|
|
96
|
+
constructor(configuration: ApiClientConfiguration, baseUrl?: string, instance?: AxiosInstance);
|
|
97
|
+
/**
|
|
98
|
+
* Returns all storefront product references relevant to the specified query parameters.
|
|
99
|
+
* @param storefrontId Storefront identifier.
|
|
100
|
+
* @param productReference (optional) Product reference filter.
|
|
101
|
+
Product reference is an external reference to Customer's Canvas product, e.g online store product identifier.
|
|
102
|
+
* @param productSpecificationId (optional) Customer's Canvas product specification filter.
|
|
103
|
+
* @param productId (optional) Customer's Canvas product filter.
|
|
104
|
+
* @param productLinkId (optional) Customer's Canvas product link filter.
|
|
105
|
+
* @param skip (optional) Defines page start offset from beginning of sorted result list.
|
|
106
|
+
* @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
|
|
107
|
+
* @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC".
|
|
108
|
+
* @param search (optional) Search string for partial match.
|
|
109
|
+
* @param sku (optional) SKU filter.
|
|
110
|
+
* @param tags (optional) List of tags that product should have.
|
|
111
|
+
* @param customFields (optional) Serialized custom fields dictionary filter. For example: {"public":"true","name":"my item"}.
|
|
112
|
+
* @param tenantId (optional) Tenant identifier.
|
|
113
|
+
* @return Success
|
|
114
|
+
*/
|
|
115
|
+
getAll(storefrontId: number, productReference?: string | null | undefined, productSpecificationId?: number | null | undefined, productId?: number | null | undefined, productLinkId?: number | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, sku?: string | null | undefined, tags?: string[] | null | undefined, customFields?: string | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfProductReferenceDto>;
|
|
116
|
+
protected processGetAll(response: AxiosResponse): Promise<PagedOfProductReferenceDto>;
|
|
117
|
+
/**
|
|
118
|
+
* Creates a new storefront product reference.
|
|
119
|
+
* @param storefrontId Storefront identifier.
|
|
120
|
+
* @param tenantId (optional) Tenant identifier.
|
|
121
|
+
* @param body (optional) Create operation parameters.
|
|
122
|
+
* @return Success
|
|
123
|
+
*/
|
|
124
|
+
create(storefrontId: number, tenantId?: number | null | undefined, body?: CreateProductReferenceDto | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProductReferenceDto>;
|
|
125
|
+
protected processCreate(response: AxiosResponse): Promise<ProductReferenceDto>;
|
|
126
|
+
/**
|
|
127
|
+
* Returns a storefront product reference.
|
|
128
|
+
* @param reference An external reference to Customer's Canvas product, e.g online store product identifier.
|
|
129
|
+
* @param storefrontId Storefront identifier.
|
|
130
|
+
* @param tenantId (optional) Tenant identifier.
|
|
131
|
+
* @return Success
|
|
132
|
+
*/
|
|
133
|
+
get(reference: string | null, storefrontId: number, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProductReferenceDto>;
|
|
134
|
+
protected processGet(response: AxiosResponse): Promise<ProductReferenceDto>;
|
|
135
|
+
/**
|
|
136
|
+
* Deletes the storefront product reference.
|
|
137
|
+
* @param reference Product reference - external reference to Customer's Canvas product specification, e.g online store product identifier.
|
|
138
|
+
* @param storefrontId Storefront identifier.
|
|
139
|
+
* @param tenantId (optional) Tenant identifier.
|
|
140
|
+
* @return Success
|
|
141
|
+
*/
|
|
142
|
+
delete(reference: string | null, storefrontId: number, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProductReferenceDto>;
|
|
143
|
+
protected processDelete(response: AxiosResponse): Promise<ProductReferenceDto>;
|
|
144
|
+
}
|
|
145
|
+
interface IProductsManagementApiClient {
|
|
146
|
+
/**
|
|
147
|
+
* Returns all products, relevant to the specified query parameters.
|
|
148
|
+
* @param skip (optional) Defines page start offset from beginning of sorted result list.
|
|
149
|
+
* @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
|
|
150
|
+
* @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC".
|
|
151
|
+
* @param search (optional) Search string for partial match.
|
|
152
|
+
* @param sku (optional) SKU of linked ecommerce product.
|
|
153
|
+
* @param tags (optional) List of tags that product should have.
|
|
154
|
+
* @param customFields (optional) Serialized custom fields dictionary filter. For example: {"public":"true","name":"my item"}.
|
|
155
|
+
* @param tenantId (optional) Tenant identifier.
|
|
156
|
+
* @return Success
|
|
157
|
+
*/
|
|
158
|
+
getAllProducts(skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, sku?: string | null | undefined, tags?: string[] | null | undefined, customFields?: string | null | undefined, tenantId?: number | null | undefined): Promise<PagedOfProductDto>;
|
|
159
|
+
/**
|
|
160
|
+
* Creates a new product and returns its description.
|
|
161
|
+
* @param tenantId (optional) Tenant identifier.
|
|
162
|
+
* @param body (optional)
|
|
163
|
+
* @return Success
|
|
164
|
+
*/
|
|
165
|
+
createProduct(tenantId?: number | null | undefined, body?: CreateProductDto | null | undefined): Promise<ProductDto>;
|
|
166
|
+
/**
|
|
167
|
+
* Returns a product by its identifier.
|
|
168
|
+
* @param id Product identifier.
|
|
169
|
+
* @param productVersionId (optional) Product version identifier.
|
|
170
|
+
* @param tenantId (optional) Tenant identifier.
|
|
171
|
+
* @return Success
|
|
172
|
+
*/
|
|
173
|
+
getProduct(id: number, productVersionId?: number | null | undefined, tenantId?: number | null | undefined): Promise<ProductDto>;
|
|
174
|
+
/**
|
|
175
|
+
* Deletes a product by its identifier.
|
|
176
|
+
* @param id Product identifier.
|
|
177
|
+
* @param tenantId (optional) Tenant identifier.
|
|
178
|
+
* @return Success
|
|
179
|
+
*/
|
|
180
|
+
deleteProduct(id: number, tenantId?: number | null | undefined): Promise<void>;
|
|
181
|
+
/**
|
|
182
|
+
* Returns a list of product options.
|
|
183
|
+
* @param id Product identifier.
|
|
184
|
+
* @param productVersionId (optional) Product version identifier.
|
|
185
|
+
* @param tenantId (optional) Tenant identifier.
|
|
186
|
+
* @return Success
|
|
187
|
+
*/
|
|
188
|
+
getProductOptions(id: number, productVersionId?: number | null | undefined, tenantId?: number | null | undefined): Promise<PagedOfProductOptionDto>;
|
|
189
|
+
/**
|
|
190
|
+
* Returns a list of product variants.
|
|
191
|
+
* @param id Product identifier.
|
|
192
|
+
* @param productVersionId (optional) Product version identifier.
|
|
193
|
+
* @param skip (optional) Defines page start offset from beginning of sorted result list.
|
|
194
|
+
* @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
|
|
195
|
+
* @param options (optional) Defines options filter e.g.: "{ "opt1_id": "opt1_val1_id, opt1_val2_id", "opt2_id": "opt2_val1_id" }".
|
|
196
|
+
* @param productFilterId (optional) Defines special filter based on product filter with specified identifier.
|
|
197
|
+
* @param takeAvailableOnly (optional) Defines special filter for available product variants.
|
|
198
|
+
* @param sku (optional) SKU of linked ecommerce product.
|
|
199
|
+
* @param tenantId (optional) Tenant identifier.
|
|
200
|
+
* @return Success
|
|
201
|
+
*/
|
|
202
|
+
getProductVariants(id: number, productVersionId?: number | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, options?: string | null | undefined, productFilterId?: number | null | undefined, takeAvailableOnly?: boolean | null | undefined, sku?: string | null | undefined, tenantId?: number | null | undefined): Promise<PagedOfProductVariantDto>;
|
|
203
|
+
/**
|
|
204
|
+
* Returns a product variant.
|
|
205
|
+
* @param id Product identifier.
|
|
206
|
+
* @param productVariantId Product variant identifier.
|
|
207
|
+
* @param productVersionId (optional) Product version identifier.
|
|
208
|
+
* @param tenantId (optional) Tenant identifier.
|
|
209
|
+
* @return Success
|
|
210
|
+
*/
|
|
211
|
+
getProductVariant(id: number, productVariantId: number, productVersionId?: number | null | undefined, tenantId?: number | null | undefined): Promise<ProductVariantDto>;
|
|
212
|
+
/**
|
|
213
|
+
* Returns a list of product variant designs.
|
|
214
|
+
* @param id Product identifier.
|
|
215
|
+
* @param productVersionId (optional) Product version identifier.
|
|
216
|
+
* @param productVariantId (optional) Product variant identifier.
|
|
217
|
+
* @param search (optional) Search string for design name partial match.
|
|
218
|
+
* @param designCustomFields (optional) Custom attributes dictionary filter for designs. For example: {"public":"true","name":"my item"}
|
|
219
|
+
* @param designPath (optional) Path filter for designs. Subfolders included by default.
|
|
220
|
+
* @param skip (optional) Defines page start offset from beginning of sorted result list.
|
|
221
|
+
* @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
|
|
222
|
+
* @param options (optional) Defines options filter e.g.: "{ "opt1_id": "opt1_val1_id, opt1_val2_id", "opt2_id": "opt2_val1_id" }".
|
|
223
|
+
* @param productFilterId (optional) Defines special filter based on product filter with specified identifier.
|
|
224
|
+
* @param takeAvailableOnly (optional) Defines special filter for available product variants.
|
|
225
|
+
* @param sku (optional) SKU of linked ecommerce product.
|
|
226
|
+
* @param tenantId (optional) Tenant identifier.
|
|
227
|
+
* @return Success
|
|
228
|
+
*/
|
|
229
|
+
getProductVariantDesigns(id: number, productVersionId?: number | null | undefined, productVariantId?: number | null | undefined, search?: string | null | undefined, designCustomFields?: string | null | undefined, designPath?: string | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, options?: string | null | undefined, productFilterId?: number | null | undefined, takeAvailableOnly?: boolean | null | undefined, sku?: string | null | undefined, tenantId?: number | null | undefined): Promise<PagedOfProductVariantDesignDto>;
|
|
230
|
+
/**
|
|
231
|
+
* Returns a list of product variant mockups.
|
|
232
|
+
* @param id Product identifier.
|
|
233
|
+
* @param productVersionId (optional) Product version identifier.
|
|
234
|
+
* @param productVariantId (optional) Product variant identifier.
|
|
235
|
+
* @param search (optional) Search string for design name partial match.
|
|
236
|
+
* @param mockupCustomFields (optional) Custom attributes dictionary filter for mockups. For example: {"public":"true","name":"my item"}
|
|
237
|
+
* @param mockupPath (optional) Path filter for mockups. Subfolders included by default.
|
|
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 options (optional) Defines options filter e.g.: "{ "opt1_id": "opt1_val1_id, opt1_val2_id", "opt2_id": "opt2_val1_id" }".
|
|
241
|
+
* @param productFilterId (optional) Defines special filter based on product filter with specified identifier.
|
|
242
|
+
* @param takeAvailableOnly (optional) Defines special filter for available product variants.
|
|
243
|
+
* @param sku (optional) SKU of linked ecommerce product.
|
|
244
|
+
* @param tenantId (optional) Tenant identifier.
|
|
245
|
+
* @return Success
|
|
246
|
+
*/
|
|
247
|
+
getProductVariantMockups(id: number, productVersionId?: number | null | undefined, productVariantId?: number | null | undefined, search?: string | null | undefined, mockupCustomFields?: string | null | undefined, mockupPath?: string | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, options?: string | null | undefined, productFilterId?: number | null | undefined, takeAvailableOnly?: boolean | null | undefined, sku?: string | null | undefined, tenantId?: number | null | undefined): Promise<PagedOfProductVariantMockupDto>;
|
|
248
|
+
/**
|
|
249
|
+
* Returns a list of product variant documents.
|
|
250
|
+
* @param id Product identifier.
|
|
251
|
+
* @param productVersionId (optional) Product version identifier.
|
|
252
|
+
* @param productVariantId (optional) Product variant identifier.
|
|
253
|
+
* @param search (optional) Search string for document name partial match.
|
|
254
|
+
* @param documentCustomFields (optional) Custom attributes dictionary filter for documents. For example: {"public":"true","name":"my item"}
|
|
255
|
+
* @param documentPath (optional) Path filter for documents. Subfolders included by default.
|
|
256
|
+
* @param skip (optional) Defines page start offset from beginning of sorted result list.
|
|
257
|
+
* @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
|
|
258
|
+
* @param options (optional) Defines options filter e.g.: "{ "opt1_id": "opt1_val1_id, opt1_val2_id", "opt2_id": "opt2_val1_id" }".
|
|
259
|
+
* @param productFilterId (optional) Defines special filter based on product filter with specified identifier.
|
|
260
|
+
* @param takeAvailableOnly (optional) Defines special filter for available product variants.
|
|
261
|
+
* @param sku (optional) SKU of linked ecommerce product.
|
|
262
|
+
* @param tenantId (optional) Tenant identifier.
|
|
263
|
+
* @return Success
|
|
264
|
+
*/
|
|
265
|
+
getProductVariantDocuments(id: number, productVersionId?: number | null | undefined, productVariantId?: number | null | undefined, search?: string | null | undefined, documentCustomFields?: string | null | undefined, documentPath?: string | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, options?: string | null | undefined, productFilterId?: number | null | undefined, takeAvailableOnly?: boolean | null | undefined, sku?: string | null | undefined, tenantId?: number | null | undefined): Promise<PagedOfProductVariantDocumentDto>;
|
|
266
|
+
/**
|
|
267
|
+
* Set product variants price. Variants identifiers will be changed.
|
|
268
|
+
* @param id Product identifier.
|
|
269
|
+
* @param productVersionId (optional) Product version identifier.
|
|
270
|
+
* @param tenantId (optional) Tenant identifier.
|
|
271
|
+
* @param body (optional) Set product variants price operation parameters.
|
|
272
|
+
* @return Success
|
|
273
|
+
*/
|
|
274
|
+
setProductVariantPrice(id: number, productVersionId?: number | null | undefined, tenantId?: number | null | undefined, body?: SetProductVariantPriceDto | null | undefined): Promise<void>;
|
|
275
|
+
/**
|
|
276
|
+
* Set product variants availability. Variants identifiers will be changed.
|
|
277
|
+
* @param id Product identifier.
|
|
278
|
+
* @param productVersionId (optional) Product version identifier.
|
|
279
|
+
* @param tenantId (optional) Tenant identifier.
|
|
280
|
+
* @param body (optional) Set product variants availability operation parameters.
|
|
281
|
+
* @return Success
|
|
282
|
+
*/
|
|
283
|
+
setProductVariantAvailability(id: number, productVersionId?: number | null | undefined, tenantId?: number | null | undefined, body?: SetProductVariantAvailabilityDto | null | undefined): Promise<void>;
|
|
284
|
+
/**
|
|
285
|
+
* Set product variants SKU. Variants identifiers will be changed.
|
|
286
|
+
* @param id Product identifier.
|
|
287
|
+
* @param productVersionId (optional) Product version identifier.
|
|
288
|
+
* @param tenantId (optional) Tenant identifier.
|
|
289
|
+
* @param body (optional) Set product variants SKU operation parameters.
|
|
290
|
+
* @return Success
|
|
291
|
+
*/
|
|
292
|
+
setProductVariantSku(id: number, productVersionId?: number | null | undefined, tenantId?: number | null | undefined, body?: SetProductVariantSkuDto | null | undefined): Promise<void>;
|
|
293
|
+
/**
|
|
294
|
+
* Imports products from a specific CSV file and returns a list of imported products descriptions.
|
|
295
|
+
* @param tenantId (optional) Tenant identifier.
|
|
296
|
+
* @param file (optional)
|
|
297
|
+
* @return Success
|
|
298
|
+
*/
|
|
299
|
+
importProducts(tenantId?: number | null | undefined, file?: FileParameter | null | undefined): Promise<PagedOfProductDto>;
|
|
300
|
+
/**
|
|
301
|
+
* Creates new designs connections for a specified product.
|
|
302
|
+
* @param id Product identifier.
|
|
303
|
+
* @param tenantId (optional) Tenant identifier.
|
|
304
|
+
* @param body (optional) Product designs connections creation parameters.
|
|
305
|
+
* @return Success
|
|
306
|
+
*/
|
|
307
|
+
createDesignsConnections(id: number, tenantId?: number | null | undefined, body?: CreateProductDesignConnectionsDto | null | undefined): Promise<void>;
|
|
308
|
+
/**
|
|
309
|
+
* Removes designs connections for a specified product.
|
|
310
|
+
* @param id Product identifier.
|
|
311
|
+
* @param tenantId (optional) Tenant identifier.
|
|
312
|
+
* @param body (optional) Product designs connections creation parameters.
|
|
313
|
+
* @return Success
|
|
314
|
+
*/
|
|
315
|
+
removeDesignsConnections(id: number, tenantId?: number | null | undefined, body?: RemoveProductDesignConnectionsDto | null | undefined): Promise<void>;
|
|
316
|
+
/**
|
|
317
|
+
* Creates new mockups connections for a specified product.
|
|
318
|
+
* @param id Product identifier.
|
|
319
|
+
* @param tenantId (optional) Tenant identifier.
|
|
320
|
+
* @param body (optional) Product mockups connections creation parameters.
|
|
321
|
+
* @return Success
|
|
322
|
+
*/
|
|
323
|
+
createMockupsConnections(id: number, tenantId?: number | null | undefined, body?: CreateProductMockupConnectionsDto | null | undefined): Promise<void>;
|
|
324
|
+
/**
|
|
325
|
+
* Removes mockups connections for a specified product.
|
|
326
|
+
* @param id Product identifier.
|
|
327
|
+
* @param tenantId (optional) Tenant identifier.
|
|
328
|
+
* @param body (optional) Product mockups connections creation parameters.
|
|
329
|
+
* @return Success
|
|
330
|
+
*/
|
|
331
|
+
removeMockupsConnections(id: number, tenantId?: number | null | undefined, body?: RemoveProductMockupConnectionsDto | null | undefined): Promise<void>;
|
|
332
|
+
/**
|
|
333
|
+
* Creates new documents connections for a specified product.
|
|
334
|
+
* @param id Product identifier.
|
|
335
|
+
* @param tenantId (optional) Tenant identifier.
|
|
336
|
+
* @param body (optional) Product documents connections creation parameters.
|
|
337
|
+
* @return Success
|
|
338
|
+
*/
|
|
339
|
+
createDocumentsConnections(id: number, tenantId?: number | null | undefined, body?: CreateProductDocumentConnectionsDto | null | undefined): Promise<void>;
|
|
340
|
+
/**
|
|
341
|
+
* Removes documents connections for a specified product.
|
|
342
|
+
* @param id Product identifier.
|
|
343
|
+
* @param tenantId (optional) Tenant identifier.
|
|
344
|
+
* @param body (optional) Product documents connections creation parameters.
|
|
345
|
+
* @return Success
|
|
346
|
+
*/
|
|
347
|
+
removeDocumentsConnections(id: number, tenantId?: number | null | undefined, body?: RemoveProductDocumentConnectionsDto | null | undefined): Promise<void>;
|
|
348
|
+
/**
|
|
349
|
+
* Returns all available product personalization workflows.
|
|
350
|
+
* @param skip (optional) Defines page start offset from beginning of sorted result list.
|
|
351
|
+
* @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
|
|
352
|
+
* @param search (optional) Search string for partial by personalization workflow name.
|
|
353
|
+
* @param tenantId (optional) Tenant identifier.
|
|
354
|
+
* @return Success
|
|
355
|
+
*/
|
|
356
|
+
getAvailablePersonalizationWorkflows(skip?: number | null | undefined, take?: number | null | undefined, search?: string | null | undefined, tenantId?: number | null | undefined): Promise<PagedOfPersonalizationWorkflowDto>;
|
|
357
|
+
/**
|
|
358
|
+
* Returns all available product processing pipelines.
|
|
359
|
+
* @param skip (optional) Defines page start offset from beginning of sorted result list.
|
|
360
|
+
* @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
|
|
361
|
+
* @param search (optional) Search string for partial by processing pipeline name.
|
|
362
|
+
* @param tenantId (optional) Tenant identifier.
|
|
363
|
+
* @return Success
|
|
364
|
+
*/
|
|
365
|
+
getAvailableProcessingPipelines(skip?: number | null | undefined, take?: number | null | undefined, search?: string | null | undefined, tenantId?: number | null | undefined): Promise<PagedOfProcessingPipelineDto>;
|
|
366
|
+
}
|
|
367
|
+
class ProductsManagementApiClient extends ApiClientBase implements IProductsManagementApiClient {
|
|
368
|
+
private instance;
|
|
369
|
+
private baseUrl;
|
|
370
|
+
protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
|
|
371
|
+
constructor(configuration: ApiClientConfiguration, baseUrl?: string, instance?: AxiosInstance);
|
|
372
|
+
/**
|
|
373
|
+
* Returns all products, relevant to the specified query parameters.
|
|
374
|
+
* @param skip (optional) Defines page start offset from beginning of sorted result list.
|
|
375
|
+
* @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
|
|
376
|
+
* @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC".
|
|
377
|
+
* @param search (optional) Search string for partial match.
|
|
378
|
+
* @param sku (optional) SKU of linked ecommerce product.
|
|
379
|
+
* @param tags (optional) List of tags that product should have.
|
|
380
|
+
* @param customFields (optional) Serialized custom fields dictionary filter. For example: {"public":"true","name":"my item"}.
|
|
381
|
+
* @param tenantId (optional) Tenant identifier.
|
|
382
|
+
* @return Success
|
|
383
|
+
*/
|
|
384
|
+
getAllProducts(skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, sku?: string | null | undefined, tags?: string[] | null | undefined, customFields?: string | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfProductDto>;
|
|
385
|
+
protected processGetAllProducts(response: AxiosResponse): Promise<PagedOfProductDto>;
|
|
386
|
+
/**
|
|
387
|
+
* Creates a new product and returns its description.
|
|
388
|
+
* @param tenantId (optional) Tenant identifier.
|
|
389
|
+
* @param body (optional)
|
|
390
|
+
* @return Success
|
|
391
|
+
*/
|
|
392
|
+
createProduct(tenantId?: number | null | undefined, body?: CreateProductDto | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProductDto>;
|
|
393
|
+
protected processCreateProduct(response: AxiosResponse): Promise<ProductDto>;
|
|
394
|
+
/**
|
|
395
|
+
* Returns a product by its identifier.
|
|
396
|
+
* @param id Product identifier.
|
|
397
|
+
* @param productVersionId (optional) Product version identifier.
|
|
398
|
+
* @param tenantId (optional) Tenant identifier.
|
|
399
|
+
* @return Success
|
|
400
|
+
*/
|
|
401
|
+
getProduct(id: number, productVersionId?: number | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProductDto>;
|
|
402
|
+
protected processGetProduct(response: AxiosResponse): Promise<ProductDto>;
|
|
403
|
+
/**
|
|
404
|
+
* Deletes a product by its identifier.
|
|
405
|
+
* @param id Product identifier.
|
|
406
|
+
* @param tenantId (optional) Tenant identifier.
|
|
407
|
+
* @return Success
|
|
408
|
+
*/
|
|
409
|
+
deleteProduct(id: number, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<void>;
|
|
410
|
+
protected processDeleteProduct(response: AxiosResponse): Promise<void>;
|
|
411
|
+
/**
|
|
412
|
+
* Returns a list of product options.
|
|
413
|
+
* @param id Product identifier.
|
|
414
|
+
* @param productVersionId (optional) Product version identifier.
|
|
415
|
+
* @param tenantId (optional) Tenant identifier.
|
|
416
|
+
* @return Success
|
|
417
|
+
*/
|
|
418
|
+
getProductOptions(id: number, productVersionId?: number | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfProductOptionDto>;
|
|
419
|
+
protected processGetProductOptions(response: AxiosResponse): Promise<PagedOfProductOptionDto>;
|
|
420
|
+
/**
|
|
421
|
+
* Returns a list of product variants.
|
|
422
|
+
* @param id Product identifier.
|
|
423
|
+
* @param productVersionId (optional) Product version identifier.
|
|
424
|
+
* @param skip (optional) Defines page start offset from beginning of sorted result list.
|
|
425
|
+
* @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
|
|
426
|
+
* @param options (optional) Defines options filter e.g.: "{ "opt1_id": "opt1_val1_id, opt1_val2_id", "opt2_id": "opt2_val1_id" }".
|
|
427
|
+
* @param productFilterId (optional) Defines special filter based on product filter with specified identifier.
|
|
428
|
+
* @param takeAvailableOnly (optional) Defines special filter for available product variants.
|
|
429
|
+
* @param sku (optional) SKU of linked ecommerce product.
|
|
430
|
+
* @param tenantId (optional) Tenant identifier.
|
|
431
|
+
* @return Success
|
|
432
|
+
*/
|
|
433
|
+
getProductVariants(id: number, productVersionId?: number | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, options?: string | null | undefined, productFilterId?: number | null | undefined, takeAvailableOnly?: boolean | null | undefined, sku?: string | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfProductVariantDto>;
|
|
434
|
+
protected processGetProductVariants(response: AxiosResponse): Promise<PagedOfProductVariantDto>;
|
|
435
|
+
/**
|
|
436
|
+
* Returns a product variant.
|
|
437
|
+
* @param id Product identifier.
|
|
438
|
+
* @param productVariantId Product variant identifier.
|
|
439
|
+
* @param productVersionId (optional) Product version identifier.
|
|
440
|
+
* @param tenantId (optional) Tenant identifier.
|
|
441
|
+
* @return Success
|
|
442
|
+
*/
|
|
443
|
+
getProductVariant(id: number, productVariantId: number, productVersionId?: number | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProductVariantDto>;
|
|
444
|
+
protected processGetProductVariant(response: AxiosResponse): Promise<ProductVariantDto>;
|
|
445
|
+
/**
|
|
446
|
+
* Returns a list of product variant designs.
|
|
447
|
+
* @param id Product identifier.
|
|
448
|
+
* @param productVersionId (optional) Product version identifier.
|
|
449
|
+
* @param productVariantId (optional) Product variant identifier.
|
|
450
|
+
* @param search (optional) Search string for design name partial match.
|
|
451
|
+
* @param designCustomFields (optional) Custom attributes dictionary filter for designs. For example: {"public":"true","name":"my item"}
|
|
452
|
+
* @param designPath (optional) Path filter for designs. Subfolders included by default.
|
|
453
|
+
* @param skip (optional) Defines page start offset from beginning of sorted result list.
|
|
454
|
+
* @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
|
|
455
|
+
* @param options (optional) Defines options filter e.g.: "{ "opt1_id": "opt1_val1_id, opt1_val2_id", "opt2_id": "opt2_val1_id" }".
|
|
456
|
+
* @param productFilterId (optional) Defines special filter based on product filter with specified identifier.
|
|
457
|
+
* @param takeAvailableOnly (optional) Defines special filter for available product variants.
|
|
458
|
+
* @param sku (optional) SKU of linked ecommerce product.
|
|
459
|
+
* @param tenantId (optional) Tenant identifier.
|
|
460
|
+
* @return Success
|
|
461
|
+
*/
|
|
462
|
+
getProductVariantDesigns(id: number, productVersionId?: number | null | undefined, productVariantId?: number | null | undefined, search?: string | null | undefined, designCustomFields?: string | null | undefined, designPath?: string | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, options?: string | null | undefined, productFilterId?: number | null | undefined, takeAvailableOnly?: boolean | null | undefined, sku?: string | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfProductVariantDesignDto>;
|
|
463
|
+
protected processGetProductVariantDesigns(response: AxiosResponse): Promise<PagedOfProductVariantDesignDto>;
|
|
464
|
+
/**
|
|
465
|
+
* Returns a list of product variant mockups.
|
|
466
|
+
* @param id Product identifier.
|
|
467
|
+
* @param productVersionId (optional) Product version identifier.
|
|
468
|
+
* @param productVariantId (optional) Product variant identifier.
|
|
469
|
+
* @param search (optional) Search string for design name partial match.
|
|
470
|
+
* @param mockupCustomFields (optional) Custom attributes dictionary filter for mockups. For example: {"public":"true","name":"my item"}
|
|
471
|
+
* @param mockupPath (optional) Path filter for mockups. Subfolders included by default.
|
|
472
|
+
* @param skip (optional) Defines page start offset from beginning of sorted result list.
|
|
473
|
+
* @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
|
|
474
|
+
* @param options (optional) Defines options filter e.g.: "{ "opt1_id": "opt1_val1_id, opt1_val2_id", "opt2_id": "opt2_val1_id" }".
|
|
475
|
+
* @param productFilterId (optional) Defines special filter based on product filter with specified identifier.
|
|
476
|
+
* @param takeAvailableOnly (optional) Defines special filter for available product variants.
|
|
477
|
+
* @param sku (optional) SKU of linked ecommerce product.
|
|
478
|
+
* @param tenantId (optional) Tenant identifier.
|
|
479
|
+
* @return Success
|
|
480
|
+
*/
|
|
481
|
+
getProductVariantMockups(id: number, productVersionId?: number | null | undefined, productVariantId?: number | null | undefined, search?: string | null | undefined, mockupCustomFields?: string | null | undefined, mockupPath?: string | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, options?: string | null | undefined, productFilterId?: number | null | undefined, takeAvailableOnly?: boolean | null | undefined, sku?: string | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfProductVariantMockupDto>;
|
|
482
|
+
protected processGetProductVariantMockups(response: AxiosResponse): Promise<PagedOfProductVariantMockupDto>;
|
|
483
|
+
/**
|
|
484
|
+
* Returns a list of product variant documents.
|
|
485
|
+
* @param id Product identifier.
|
|
486
|
+
* @param productVersionId (optional) Product version identifier.
|
|
487
|
+
* @param productVariantId (optional) Product variant identifier.
|
|
488
|
+
* @param search (optional) Search string for document name partial match.
|
|
489
|
+
* @param documentCustomFields (optional) Custom attributes dictionary filter for documents. For example: {"public":"true","name":"my item"}
|
|
490
|
+
* @param documentPath (optional) Path filter for documents. Subfolders included by default.
|
|
491
|
+
* @param skip (optional) Defines page start offset from beginning of sorted result list.
|
|
492
|
+
* @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
|
|
493
|
+
* @param options (optional) Defines options filter e.g.: "{ "opt1_id": "opt1_val1_id, opt1_val2_id", "opt2_id": "opt2_val1_id" }".
|
|
494
|
+
* @param productFilterId (optional) Defines special filter based on product filter with specified identifier.
|
|
495
|
+
* @param takeAvailableOnly (optional) Defines special filter for available product variants.
|
|
496
|
+
* @param sku (optional) SKU of linked ecommerce product.
|
|
497
|
+
* @param tenantId (optional) Tenant identifier.
|
|
498
|
+
* @return Success
|
|
499
|
+
*/
|
|
500
|
+
getProductVariantDocuments(id: number, productVersionId?: number | null | undefined, productVariantId?: number | null | undefined, search?: string | null | undefined, documentCustomFields?: string | null | undefined, documentPath?: string | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, options?: string | null | undefined, productFilterId?: number | null | undefined, takeAvailableOnly?: boolean | null | undefined, sku?: string | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfProductVariantDocumentDto>;
|
|
501
|
+
protected processGetProductVariantDocuments(response: AxiosResponse): Promise<PagedOfProductVariantDocumentDto>;
|
|
502
|
+
/**
|
|
503
|
+
* Set product variants price. Variants identifiers will be changed.
|
|
504
|
+
* @param id Product identifier.
|
|
505
|
+
* @param productVersionId (optional) Product version identifier.
|
|
506
|
+
* @param tenantId (optional) Tenant identifier.
|
|
507
|
+
* @param body (optional) Set product variants price operation parameters.
|
|
508
|
+
* @return Success
|
|
509
|
+
*/
|
|
510
|
+
setProductVariantPrice(id: number, productVersionId?: number | null | undefined, tenantId?: number | null | undefined, body?: SetProductVariantPriceDto | null | undefined, cancelToken?: CancelToken | undefined): Promise<void>;
|
|
511
|
+
protected processSetProductVariantPrice(response: AxiosResponse): Promise<void>;
|
|
512
|
+
/**
|
|
513
|
+
* Set product variants availability. Variants identifiers will be changed.
|
|
514
|
+
* @param id Product identifier.
|
|
515
|
+
* @param productVersionId (optional) Product version identifier.
|
|
516
|
+
* @param tenantId (optional) Tenant identifier.
|
|
517
|
+
* @param body (optional) Set product variants availability operation parameters.
|
|
518
|
+
* @return Success
|
|
519
|
+
*/
|
|
520
|
+
setProductVariantAvailability(id: number, productVersionId?: number | null | undefined, tenantId?: number | null | undefined, body?: SetProductVariantAvailabilityDto | null | undefined, cancelToken?: CancelToken | undefined): Promise<void>;
|
|
521
|
+
protected processSetProductVariantAvailability(response: AxiosResponse): Promise<void>;
|
|
522
|
+
/**
|
|
523
|
+
* Set product variants SKU. Variants identifiers will be changed.
|
|
524
|
+
* @param id Product identifier.
|
|
525
|
+
* @param productVersionId (optional) Product version identifier.
|
|
526
|
+
* @param tenantId (optional) Tenant identifier.
|
|
527
|
+
* @param body (optional) Set product variants SKU operation parameters.
|
|
528
|
+
* @return Success
|
|
529
|
+
*/
|
|
530
|
+
setProductVariantSku(id: number, productVersionId?: number | null | undefined, tenantId?: number | null | undefined, body?: SetProductVariantSkuDto | null | undefined, cancelToken?: CancelToken | undefined): Promise<void>;
|
|
531
|
+
protected processSetProductVariantSku(response: AxiosResponse): Promise<void>;
|
|
532
|
+
/**
|
|
533
|
+
* Imports products from a specific CSV file and returns a list of imported products descriptions.
|
|
534
|
+
* @param tenantId (optional) Tenant identifier.
|
|
535
|
+
* @param file (optional)
|
|
536
|
+
* @return Success
|
|
537
|
+
*/
|
|
538
|
+
importProducts(tenantId?: number | null | undefined, file?: FileParameter | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfProductDto>;
|
|
539
|
+
protected processImportProducts(response: AxiosResponse): Promise<PagedOfProductDto>;
|
|
540
|
+
/**
|
|
541
|
+
* Creates new designs connections for a specified product.
|
|
542
|
+
* @param id Product identifier.
|
|
543
|
+
* @param tenantId (optional) Tenant identifier.
|
|
544
|
+
* @param body (optional) Product designs connections creation parameters.
|
|
545
|
+
* @return Success
|
|
546
|
+
*/
|
|
547
|
+
createDesignsConnections(id: number, tenantId?: number | null | undefined, body?: CreateProductDesignConnectionsDto | null | undefined, cancelToken?: CancelToken | undefined): Promise<void>;
|
|
548
|
+
protected processCreateDesignsConnections(response: AxiosResponse): Promise<void>;
|
|
549
|
+
/**
|
|
550
|
+
* Removes designs connections for a specified product.
|
|
551
|
+
* @param id Product identifier.
|
|
552
|
+
* @param tenantId (optional) Tenant identifier.
|
|
553
|
+
* @param body (optional) Product designs connections creation parameters.
|
|
554
|
+
* @return Success
|
|
555
|
+
*/
|
|
556
|
+
removeDesignsConnections(id: number, tenantId?: number | null | undefined, body?: RemoveProductDesignConnectionsDto | null | undefined, cancelToken?: CancelToken | undefined): Promise<void>;
|
|
557
|
+
protected processRemoveDesignsConnections(response: AxiosResponse): Promise<void>;
|
|
558
|
+
/**
|
|
559
|
+
* Creates new mockups connections for a specified product.
|
|
560
|
+
* @param id Product identifier.
|
|
561
|
+
* @param tenantId (optional) Tenant identifier.
|
|
562
|
+
* @param body (optional) Product mockups connections creation parameters.
|
|
563
|
+
* @return Success
|
|
564
|
+
*/
|
|
565
|
+
createMockupsConnections(id: number, tenantId?: number | null | undefined, body?: CreateProductMockupConnectionsDto | null | undefined, cancelToken?: CancelToken | undefined): Promise<void>;
|
|
566
|
+
protected processCreateMockupsConnections(response: AxiosResponse): Promise<void>;
|
|
567
|
+
/**
|
|
568
|
+
* Removes mockups connections for a specified product.
|
|
569
|
+
* @param id Product identifier.
|
|
570
|
+
* @param tenantId (optional) Tenant identifier.
|
|
571
|
+
* @param body (optional) Product mockups connections creation parameters.
|
|
572
|
+
* @return Success
|
|
573
|
+
*/
|
|
574
|
+
removeMockupsConnections(id: number, tenantId?: number | null | undefined, body?: RemoveProductMockupConnectionsDto | null | undefined, cancelToken?: CancelToken | undefined): Promise<void>;
|
|
575
|
+
protected processRemoveMockupsConnections(response: AxiosResponse): Promise<void>;
|
|
576
|
+
/**
|
|
577
|
+
* Creates new documents connections for a specified product.
|
|
578
|
+
* @param id Product identifier.
|
|
579
|
+
* @param tenantId (optional) Tenant identifier.
|
|
580
|
+
* @param body (optional) Product documents connections creation parameters.
|
|
581
|
+
* @return Success
|
|
582
|
+
*/
|
|
583
|
+
createDocumentsConnections(id: number, tenantId?: number | null | undefined, body?: CreateProductDocumentConnectionsDto | null | undefined, cancelToken?: CancelToken | undefined): Promise<void>;
|
|
584
|
+
protected processCreateDocumentsConnections(response: AxiosResponse): Promise<void>;
|
|
585
|
+
/**
|
|
586
|
+
* Removes documents connections for a specified product.
|
|
587
|
+
* @param id Product identifier.
|
|
588
|
+
* @param tenantId (optional) Tenant identifier.
|
|
589
|
+
* @param body (optional) Product documents connections creation parameters.
|
|
590
|
+
* @return Success
|
|
591
|
+
*/
|
|
592
|
+
removeDocumentsConnections(id: number, tenantId?: number | null | undefined, body?: RemoveProductDocumentConnectionsDto | null | undefined, cancelToken?: CancelToken | undefined): Promise<void>;
|
|
593
|
+
protected processRemoveDocumentsConnections(response: AxiosResponse): Promise<void>;
|
|
594
|
+
/**
|
|
595
|
+
* Returns all available product personalization workflows.
|
|
596
|
+
* @param skip (optional) Defines page start offset from beginning of sorted result list.
|
|
597
|
+
* @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
|
|
598
|
+
* @param search (optional) Search string for partial by personalization workflow name.
|
|
599
|
+
* @param tenantId (optional) Tenant identifier.
|
|
600
|
+
* @return Success
|
|
601
|
+
*/
|
|
602
|
+
getAvailablePersonalizationWorkflows(skip?: number | null | undefined, take?: number | null | undefined, search?: string | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfPersonalizationWorkflowDto>;
|
|
603
|
+
protected processGetAvailablePersonalizationWorkflows(response: AxiosResponse): Promise<PagedOfPersonalizationWorkflowDto>;
|
|
604
|
+
/**
|
|
605
|
+
* Returns all available product processing pipelines.
|
|
606
|
+
* @param skip (optional) Defines page start offset from beginning of sorted result list.
|
|
607
|
+
* @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
|
|
608
|
+
* @param search (optional) Search string for partial by processing pipeline name.
|
|
609
|
+
* @param tenantId (optional) Tenant identifier.
|
|
610
|
+
* @return Success
|
|
611
|
+
*/
|
|
612
|
+
getAvailableProcessingPipelines(skip?: number | null | undefined, take?: number | null | undefined, search?: string | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfProcessingPipelineDto>;
|
|
613
|
+
protected processGetAvailableProcessingPipelines(response: AxiosResponse): Promise<PagedOfProcessingPipelineDto>;
|
|
614
|
+
}
|
|
615
|
+
interface IStorefrontsManagementApiClient {
|
|
616
|
+
/**
|
|
617
|
+
* Returns all storefronts, relevant to the specified query parameters.
|
|
618
|
+
* @param types (optional) Storefront type filter.
|
|
619
|
+
* @param skip (optional) Defines page start offset from beginning of sorted result list.
|
|
620
|
+
* @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
|
|
621
|
+
* @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC".
|
|
622
|
+
* @param search (optional) Search string for partial match.
|
|
623
|
+
* @param tenantId (optional) Tenant identifier.
|
|
624
|
+
* @return Success
|
|
625
|
+
*/
|
|
626
|
+
getAll(types?: StorefrontType[] | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, tenantId?: number | null | undefined): Promise<PagedOfStorefrontDto>;
|
|
627
|
+
/**
|
|
628
|
+
* Returns a storefront by identifier.
|
|
629
|
+
* @param id Storefront identifier.
|
|
630
|
+
* @param tenantId (optional) Tenant identifier.
|
|
631
|
+
* @return Success
|
|
632
|
+
*/
|
|
633
|
+
get(id: number, tenantId?: number | null | undefined): Promise<StorefrontDto>;
|
|
634
|
+
/**
|
|
635
|
+
* Deletes an existing storefront by its identifier.
|
|
636
|
+
* @param id Storefront identifier.
|
|
637
|
+
* @param tenantId (optional) Tenant identifier.
|
|
638
|
+
* @return Success
|
|
639
|
+
*/
|
|
640
|
+
delete(id: number, tenantId?: number | null | undefined): Promise<StorefrontDto>;
|
|
641
|
+
/**
|
|
642
|
+
* Creates new custom storefront.
|
|
643
|
+
* @param tenantId (optional) Tenant identifier.
|
|
644
|
+
* @param body (optional) Custom storefront creation model.
|
|
645
|
+
* @return Success
|
|
646
|
+
*/
|
|
647
|
+
createCustomStorefront(tenantId?: number | null | undefined, body?: CreateCustomStorefrontDto | null | undefined): Promise<CustomStorefrontDto>;
|
|
648
|
+
/**
|
|
649
|
+
* Returns extended information about custom storefront.
|
|
650
|
+
* @param id Storefront identifier.
|
|
651
|
+
* @param tenantId (optional) Tenant identifier.
|
|
652
|
+
* @return Success
|
|
653
|
+
*/
|
|
654
|
+
getCustomStorefront(id: number, tenantId?: number | null | undefined): Promise<CustomStorefrontDto>;
|
|
655
|
+
/**
|
|
656
|
+
* Creates new NopCommerce storefront.
|
|
657
|
+
* @param tenantId (optional) Tenant identifier.
|
|
658
|
+
* @param body (optional) NopCommerce storefront creation model.
|
|
659
|
+
* @return Success
|
|
660
|
+
*/
|
|
661
|
+
createNopCommerceStorefront(tenantId?: number | null | undefined, body?: CreateNopCommerceStorefrontDto | null | undefined): Promise<NopCommerceStorefrontDto>;
|
|
662
|
+
/**
|
|
663
|
+
* Returns extended information about NopCommerce storefront.
|
|
664
|
+
* @param id Storefront identifier.
|
|
665
|
+
* @param tenantId (optional) Tenant identifier.
|
|
666
|
+
* @return Success
|
|
667
|
+
*/
|
|
668
|
+
getNopCommerceStorefront(id: number, tenantId?: number | null | undefined): Promise<NopCommerceStorefrontDto>;
|
|
669
|
+
/**
|
|
670
|
+
* Creates new WooCommerce storefront.
|
|
671
|
+
* @param tenantId (optional) Tenant identifier.
|
|
672
|
+
* @param body (optional) WooCommerce storefront creation model.
|
|
673
|
+
* @return Success
|
|
674
|
+
*/
|
|
675
|
+
createWooCommerceStorefront(tenantId?: number | null | undefined, body?: CreateWooCommerceStorefrontDto | null | undefined): Promise<WooCommerceStorefrontDto>;
|
|
676
|
+
/**
|
|
677
|
+
* Returns extended information about WooCommerce storefront.
|
|
678
|
+
* @param id Storefront identifier.
|
|
679
|
+
* @param tenantId (optional) Tenant identifier.
|
|
680
|
+
* @return Success
|
|
681
|
+
*/
|
|
682
|
+
getWooCommerceStorefront(id: number, tenantId?: number | null | undefined): Promise<WooCommerceStorefrontDto>;
|
|
683
|
+
/**
|
|
684
|
+
* Creates new Magento storefront.
|
|
685
|
+
* @param tenantId (optional) Tenant identifier.
|
|
686
|
+
* @param body (optional) Magento storefront creation model.
|
|
687
|
+
* @return Success
|
|
688
|
+
*/
|
|
689
|
+
createMagentoStorefront(tenantId?: number | null | undefined, body?: CreateMagentoStorefrontDto | null | undefined): Promise<MagentoStorefrontDto>;
|
|
690
|
+
/**
|
|
691
|
+
* Returns extended information about Magento storefront.
|
|
692
|
+
* @param id Storefront identifier.
|
|
693
|
+
* @param tenantId (optional) Tenant identifier.
|
|
694
|
+
* @return Success
|
|
695
|
+
*/
|
|
696
|
+
getMagentoStorefront(id: number, tenantId?: number | null | undefined): Promise<MagentoStorefrontDto>;
|
|
697
|
+
/**
|
|
698
|
+
* Creates new BigCommerce storefront.
|
|
699
|
+
* @param tenantId (optional) Tenant identifier.
|
|
700
|
+
* @param body (optional) BigCommerce storefront creation model.
|
|
701
|
+
* @return Success
|
|
702
|
+
*/
|
|
703
|
+
createBigCommerceStorefront(tenantId?: number | null | undefined, body?: CreateBigCommerceStorefrontDto | null | undefined): Promise<BigCommerceStorefrontDto>;
|
|
704
|
+
/**
|
|
705
|
+
* Returns extended information about BigCommerce storefront.
|
|
706
|
+
* @param id Storefront identifier.
|
|
707
|
+
* @param tenantId (optional) Tenant identifier.
|
|
708
|
+
* @return Success
|
|
709
|
+
*/
|
|
710
|
+
getBigCommerceStorefront(id: number, tenantId?: number | null | undefined): Promise<MagentoStorefrontDto>;
|
|
711
|
+
}
|
|
712
|
+
class StorefrontsManagementApiClient extends ApiClientBase implements IStorefrontsManagementApiClient {
|
|
713
|
+
private instance;
|
|
714
|
+
private baseUrl;
|
|
715
|
+
protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
|
|
716
|
+
constructor(configuration: ApiClientConfiguration, baseUrl?: string, instance?: AxiosInstance);
|
|
717
|
+
/**
|
|
718
|
+
* Returns all storefronts, relevant to the specified query parameters.
|
|
719
|
+
* @param types (optional) Storefront type filter.
|
|
720
|
+
* @param skip (optional) Defines page start offset from beginning of sorted result list.
|
|
721
|
+
* @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
|
|
722
|
+
* @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC".
|
|
723
|
+
* @param search (optional) Search string for partial match.
|
|
724
|
+
* @param tenantId (optional) Tenant identifier.
|
|
725
|
+
* @return Success
|
|
726
|
+
*/
|
|
727
|
+
getAll(types?: StorefrontType[] | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfStorefrontDto>;
|
|
728
|
+
protected processGetAll(response: AxiosResponse): Promise<PagedOfStorefrontDto>;
|
|
729
|
+
/**
|
|
730
|
+
* Returns a storefront by identifier.
|
|
731
|
+
* @param id Storefront identifier.
|
|
732
|
+
* @param tenantId (optional) Tenant identifier.
|
|
733
|
+
* @return Success
|
|
734
|
+
*/
|
|
735
|
+
get(id: number, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<StorefrontDto>;
|
|
736
|
+
protected processGet(response: AxiosResponse): Promise<StorefrontDto>;
|
|
737
|
+
/**
|
|
738
|
+
* Deletes an existing storefront by its identifier.
|
|
739
|
+
* @param id Storefront identifier.
|
|
740
|
+
* @param tenantId (optional) Tenant identifier.
|
|
741
|
+
* @return Success
|
|
742
|
+
*/
|
|
743
|
+
delete(id: number, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<StorefrontDto>;
|
|
744
|
+
protected processDelete(response: AxiosResponse): Promise<StorefrontDto>;
|
|
745
|
+
/**
|
|
746
|
+
* Creates new custom storefront.
|
|
747
|
+
* @param tenantId (optional) Tenant identifier.
|
|
748
|
+
* @param body (optional) Custom storefront creation model.
|
|
749
|
+
* @return Success
|
|
750
|
+
*/
|
|
751
|
+
createCustomStorefront(tenantId?: number | null | undefined, body?: CreateCustomStorefrontDto | null | undefined, cancelToken?: CancelToken | undefined): Promise<CustomStorefrontDto>;
|
|
752
|
+
protected processCreateCustomStorefront(response: AxiosResponse): Promise<CustomStorefrontDto>;
|
|
753
|
+
/**
|
|
754
|
+
* Returns extended information about custom storefront.
|
|
755
|
+
* @param id Storefront identifier.
|
|
756
|
+
* @param tenantId (optional) Tenant identifier.
|
|
757
|
+
* @return Success
|
|
758
|
+
*/
|
|
759
|
+
getCustomStorefront(id: number, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<CustomStorefrontDto>;
|
|
760
|
+
protected processGetCustomStorefront(response: AxiosResponse): Promise<CustomStorefrontDto>;
|
|
761
|
+
/**
|
|
762
|
+
* Creates new NopCommerce storefront.
|
|
763
|
+
* @param tenantId (optional) Tenant identifier.
|
|
764
|
+
* @param body (optional) NopCommerce storefront creation model.
|
|
765
|
+
* @return Success
|
|
766
|
+
*/
|
|
767
|
+
createNopCommerceStorefront(tenantId?: number | null | undefined, body?: CreateNopCommerceStorefrontDto | null | undefined, cancelToken?: CancelToken | undefined): Promise<NopCommerceStorefrontDto>;
|
|
768
|
+
protected processCreateNopCommerceStorefront(response: AxiosResponse): Promise<NopCommerceStorefrontDto>;
|
|
769
|
+
/**
|
|
770
|
+
* Returns extended information about NopCommerce storefront.
|
|
771
|
+
* @param id Storefront identifier.
|
|
772
|
+
* @param tenantId (optional) Tenant identifier.
|
|
773
|
+
* @return Success
|
|
774
|
+
*/
|
|
775
|
+
getNopCommerceStorefront(id: number, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<NopCommerceStorefrontDto>;
|
|
776
|
+
protected processGetNopCommerceStorefront(response: AxiosResponse): Promise<NopCommerceStorefrontDto>;
|
|
777
|
+
/**
|
|
778
|
+
* Creates new WooCommerce storefront.
|
|
779
|
+
* @param tenantId (optional) Tenant identifier.
|
|
780
|
+
* @param body (optional) WooCommerce storefront creation model.
|
|
781
|
+
* @return Success
|
|
782
|
+
*/
|
|
783
|
+
createWooCommerceStorefront(tenantId?: number | null | undefined, body?: CreateWooCommerceStorefrontDto | null | undefined, cancelToken?: CancelToken | undefined): Promise<WooCommerceStorefrontDto>;
|
|
784
|
+
protected processCreateWooCommerceStorefront(response: AxiosResponse): Promise<WooCommerceStorefrontDto>;
|
|
785
|
+
/**
|
|
786
|
+
* Returns extended information about WooCommerce storefront.
|
|
787
|
+
* @param id Storefront identifier.
|
|
788
|
+
* @param tenantId (optional) Tenant identifier.
|
|
789
|
+
* @return Success
|
|
790
|
+
*/
|
|
791
|
+
getWooCommerceStorefront(id: number, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<WooCommerceStorefrontDto>;
|
|
792
|
+
protected processGetWooCommerceStorefront(response: AxiosResponse): Promise<WooCommerceStorefrontDto>;
|
|
793
|
+
/**
|
|
794
|
+
* Creates new Magento storefront.
|
|
795
|
+
* @param tenantId (optional) Tenant identifier.
|
|
796
|
+
* @param body (optional) Magento storefront creation model.
|
|
797
|
+
* @return Success
|
|
798
|
+
*/
|
|
799
|
+
createMagentoStorefront(tenantId?: number | null | undefined, body?: CreateMagentoStorefrontDto | null | undefined, cancelToken?: CancelToken | undefined): Promise<MagentoStorefrontDto>;
|
|
800
|
+
protected processCreateMagentoStorefront(response: AxiosResponse): Promise<MagentoStorefrontDto>;
|
|
801
|
+
/**
|
|
802
|
+
* Returns extended information about Magento storefront.
|
|
803
|
+
* @param id Storefront identifier.
|
|
804
|
+
* @param tenantId (optional) Tenant identifier.
|
|
805
|
+
* @return Success
|
|
806
|
+
*/
|
|
807
|
+
getMagentoStorefront(id: number, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<MagentoStorefrontDto>;
|
|
808
|
+
protected processGetMagentoStorefront(response: AxiosResponse): Promise<MagentoStorefrontDto>;
|
|
809
|
+
/**
|
|
810
|
+
* Creates new BigCommerce storefront.
|
|
811
|
+
* @param tenantId (optional) Tenant identifier.
|
|
812
|
+
* @param body (optional) BigCommerce storefront creation model.
|
|
813
|
+
* @return Success
|
|
814
|
+
*/
|
|
815
|
+
createBigCommerceStorefront(tenantId?: number | null | undefined, body?: CreateBigCommerceStorefrontDto | null | undefined, cancelToken?: CancelToken | undefined): Promise<BigCommerceStorefrontDto>;
|
|
816
|
+
protected processCreateBigCommerceStorefront(response: AxiosResponse): Promise<BigCommerceStorefrontDto>;
|
|
817
|
+
/**
|
|
818
|
+
* Returns extended information about BigCommerce storefront.
|
|
819
|
+
* @param id Storefront identifier.
|
|
820
|
+
* @param tenantId (optional) Tenant identifier.
|
|
821
|
+
* @return Success
|
|
822
|
+
*/
|
|
823
|
+
getBigCommerceStorefront(id: number, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<MagentoStorefrontDto>;
|
|
824
|
+
protected processGetBigCommerceStorefront(response: AxiosResponse): Promise<MagentoStorefrontDto>;
|
|
825
|
+
}
|
|
826
|
+
interface IUsersManagementApiClient {
|
|
827
|
+
/**
|
|
828
|
+
* Returns a tenant users list.
|
|
829
|
+
* @param tenantId (optional) Tenant identifier.
|
|
830
|
+
* @return Success
|
|
831
|
+
*/
|
|
832
|
+
getAll(tenantId?: number | null | undefined): Promise<PagedOfTenantUserDto>;
|
|
833
|
+
/**
|
|
834
|
+
* Creates a new tenant user.
|
|
835
|
+
* @param tenantId (optional) Tenant identifier.
|
|
836
|
+
* @param body (optional) User creation model.
|
|
837
|
+
* @return Success
|
|
838
|
+
*/
|
|
839
|
+
create(tenantId?: number | null | undefined, body?: CreateTenantUserDto | null | undefined): Promise<TenantUserDto>;
|
|
840
|
+
/**
|
|
841
|
+
* Returns a tenant user by user identifier.
|
|
842
|
+
* @param id User identifier.
|
|
843
|
+
* @param tenantId (optional) Tenant identifier.
|
|
844
|
+
* @return Success
|
|
845
|
+
*/
|
|
846
|
+
get(id: number, tenantId?: number | null | undefined): Promise<TenantUserDto>;
|
|
847
|
+
/**
|
|
848
|
+
* Deletes an existing tenant user.
|
|
849
|
+
* @param id User identifier.
|
|
850
|
+
* @param tenantId (optional) Tenant identifier.
|
|
851
|
+
* @return Success
|
|
852
|
+
*/
|
|
853
|
+
delete(id: number, tenantId?: number | null | undefined): Promise<void>;
|
|
854
|
+
/**
|
|
855
|
+
* Returns all tenant user roles, relevant to the specified query parameters.
|
|
856
|
+
* @param search (optional) Search string for partial match.
|
|
857
|
+
* @param skip (optional) Defines page start offset from beginning of sorted result list.
|
|
858
|
+
* @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
|
|
859
|
+
* @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC".
|
|
860
|
+
* @param tenantId (optional) Tenant identifier.
|
|
861
|
+
* @return Success
|
|
862
|
+
*/
|
|
863
|
+
getAllRoles(search?: string | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, tenantId?: number | null | undefined): Promise<PagedOfTenantUserRoleDto>;
|
|
864
|
+
}
|
|
865
|
+
class UsersManagementApiClient extends ApiClientBase implements IUsersManagementApiClient {
|
|
866
|
+
private instance;
|
|
867
|
+
private baseUrl;
|
|
868
|
+
protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
|
|
869
|
+
constructor(configuration: ApiClientConfiguration, baseUrl?: string, instance?: AxiosInstance);
|
|
870
|
+
/**
|
|
871
|
+
* Returns a tenant users list.
|
|
872
|
+
* @param tenantId (optional) Tenant identifier.
|
|
873
|
+
* @return Success
|
|
874
|
+
*/
|
|
875
|
+
getAll(tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfTenantUserDto>;
|
|
876
|
+
protected processGetAll(response: AxiosResponse): Promise<PagedOfTenantUserDto>;
|
|
877
|
+
/**
|
|
878
|
+
* Creates a new tenant user.
|
|
879
|
+
* @param tenantId (optional) Tenant identifier.
|
|
880
|
+
* @param body (optional) User creation model.
|
|
881
|
+
* @return Success
|
|
882
|
+
*/
|
|
883
|
+
create(tenantId?: number | null | undefined, body?: CreateTenantUserDto | null | undefined, cancelToken?: CancelToken | undefined): Promise<TenantUserDto>;
|
|
884
|
+
protected processCreate(response: AxiosResponse): Promise<TenantUserDto>;
|
|
885
|
+
/**
|
|
886
|
+
* Returns a tenant user by user identifier.
|
|
887
|
+
* @param id User identifier.
|
|
888
|
+
* @param tenantId (optional) Tenant identifier.
|
|
889
|
+
* @return Success
|
|
890
|
+
*/
|
|
891
|
+
get(id: number, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<TenantUserDto>;
|
|
892
|
+
protected processGet(response: AxiosResponse): Promise<TenantUserDto>;
|
|
893
|
+
/**
|
|
894
|
+
* Deletes an existing tenant user.
|
|
895
|
+
* @param id User identifier.
|
|
896
|
+
* @param tenantId (optional) Tenant identifier.
|
|
897
|
+
* @return Success
|
|
898
|
+
*/
|
|
899
|
+
delete(id: number, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<void>;
|
|
900
|
+
protected processDelete(response: AxiosResponse): Promise<void>;
|
|
901
|
+
/**
|
|
902
|
+
* Returns all tenant user roles, relevant to the specified query parameters.
|
|
903
|
+
* @param search (optional) Search string for partial match.
|
|
904
|
+
* @param skip (optional) Defines page start offset from beginning of sorted result list.
|
|
905
|
+
* @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
|
|
906
|
+
* @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC".
|
|
907
|
+
* @param tenantId (optional) Tenant identifier.
|
|
908
|
+
* @return Success
|
|
909
|
+
*/
|
|
910
|
+
getAllRoles(search?: string | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfTenantUserRoleDto>;
|
|
911
|
+
protected processGetAllRoles(response: AxiosResponse): Promise<PagedOfTenantUserRoleDto>;
|
|
912
|
+
}
|
|
913
|
+
/** Information about a service. */
|
|
914
|
+
interface BuildInfoModel {
|
|
915
|
+
/** Version number. */
|
|
916
|
+
version?: string | null;
|
|
917
|
+
/** Build date (UTC). */
|
|
918
|
+
buildDate?: string | null;
|
|
919
|
+
/** Build configuration (Debug | Release). */
|
|
920
|
+
configuration?: string | null;
|
|
921
|
+
/** Service name. */
|
|
922
|
+
appName?: string | null;
|
|
923
|
+
}
|
|
924
|
+
/** Available product reference target types. */
|
|
925
|
+
enum ProductReferenceType {
|
|
926
|
+
ProductSpecification = "ProductSpecification",
|
|
927
|
+
Product = "Product",
|
|
928
|
+
ProductLink = "ProductLink"
|
|
929
|
+
}
|
|
930
|
+
/** DTO class, containing information about storefront product reference. */
|
|
931
|
+
interface ProductReferenceDto {
|
|
932
|
+
/** Product reference is an external reference to Customer's Canvas product, e.g online store product identifier. */
|
|
933
|
+
productReference?: string | null;
|
|
934
|
+
/** Product reference target type. */
|
|
935
|
+
productReferenceType?: ProductReferenceType;
|
|
936
|
+
/** Product reference name, e.g. online store product name. */
|
|
937
|
+
productReferenceName?: string | null;
|
|
938
|
+
/** Customer's Canvas product specification identifier. */
|
|
939
|
+
productSpecificationId?: number;
|
|
940
|
+
/** Customer's Canvas product identifier. */
|
|
941
|
+
productId?: number;
|
|
942
|
+
/** Customer's Canvas product version identifier. */
|
|
943
|
+
productVersionId?: number;
|
|
944
|
+
/** Customer's Canvas product link identifier. */
|
|
945
|
+
productLinkId?: number;
|
|
946
|
+
/** Storefront identifier. */
|
|
947
|
+
storefrontId?: number;
|
|
948
|
+
/** Tenant identifier. */
|
|
949
|
+
tenantId?: number;
|
|
950
|
+
/** Storefront product reference creation date and time. */
|
|
951
|
+
created?: string;
|
|
952
|
+
}
|
|
953
|
+
/** DTO, containing results of paged query. */
|
|
954
|
+
interface PagedOfProductReferenceDto {
|
|
955
|
+
total?: number;
|
|
956
|
+
items?: ProductReferenceDto[] | null;
|
|
957
|
+
}
|
|
958
|
+
/** Conflict types. */
|
|
959
|
+
enum ConflictType {
|
|
960
|
+
NameConflict = "NameConflict",
|
|
961
|
+
FolderOverwriteConflict = "FolderOverwriteConflict",
|
|
962
|
+
IdConflict = "IdConflict",
|
|
963
|
+
GeneralConflict = "GeneralConflict"
|
|
964
|
+
}
|
|
965
|
+
/** Information about operation conflict. */
|
|
966
|
+
interface GeneralConflictDto {
|
|
967
|
+
/** Problem description. */
|
|
968
|
+
description?: string | null;
|
|
969
|
+
/** Coflict type. */
|
|
970
|
+
type?: ConflictType;
|
|
971
|
+
}
|
|
972
|
+
/** Dto class, containing create operation parameters for storefront product reference. */
|
|
973
|
+
interface CreateProductReferenceDto {
|
|
974
|
+
/** Product reference is an external reference to Customer's Canvas product, e.g online store product identifier. */
|
|
975
|
+
productReference: string;
|
|
976
|
+
/** Product reference target type. */
|
|
977
|
+
productReferenceType?: ProductReferenceType;
|
|
978
|
+
/** Product reference name, e.g. online store product name. */
|
|
979
|
+
productReferenceName?: string | null;
|
|
980
|
+
/** Customer's Canvas product specification identifier. */
|
|
981
|
+
productSpecificationId?: number | null;
|
|
982
|
+
/** Customer's Canvas product identifier. */
|
|
983
|
+
productId?: number | null;
|
|
984
|
+
/** Customer's Canvas product link identifier. */
|
|
985
|
+
productLinkId?: number | null;
|
|
986
|
+
}
|
|
987
|
+
interface ProblemDetails {
|
|
988
|
+
type?: string | null;
|
|
989
|
+
title?: string | null;
|
|
990
|
+
status?: number | null;
|
|
991
|
+
detail?: string | null;
|
|
992
|
+
instance?: string | null;
|
|
993
|
+
}
|
|
994
|
+
/** DTO class, containing information about storefront product reference. */
|
|
995
|
+
interface ProductReferenceInfo {
|
|
996
|
+
/** Product reference is an external reference to Customer's Canvas product, e.g online store product identifier. */
|
|
997
|
+
productReference?: string | null;
|
|
998
|
+
/** Product reference target type. */
|
|
999
|
+
productReferenceType?: ProductReferenceType;
|
|
1000
|
+
/** Product reference name, e.g. online store product name. */
|
|
1001
|
+
productReferenceName?: string | null;
|
|
1002
|
+
/** Customer's Canvas product specification identifier. */
|
|
1003
|
+
productSpecificationId?: number;
|
|
1004
|
+
/** Customer's Canvas product identifier. */
|
|
1005
|
+
productId?: number;
|
|
1006
|
+
/** Customer's Canvas product link identifier. */
|
|
1007
|
+
productLinkId?: number;
|
|
1008
|
+
/** Storefront identifier. */
|
|
1009
|
+
storefrontId?: number;
|
|
1010
|
+
}
|
|
1011
|
+
/** DTO class, containing information about storefront product reference creation conflict. */
|
|
1012
|
+
interface ProductReferenceCreationConflictDto {
|
|
1013
|
+
/** List of storefront product references, which are already exist. */
|
|
1014
|
+
existingReferences?: ProductReferenceInfo[] | null;
|
|
1015
|
+
/** Problem description. */
|
|
1016
|
+
description?: string | null;
|
|
1017
|
+
/** Coflict type. */
|
|
1018
|
+
type?: ConflictType;
|
|
1019
|
+
}
|
|
1020
|
+
/** Dto class, containing information about a product resource of type image. */
|
|
1021
|
+
interface ImageInfo {
|
|
1022
|
+
/** Product resource identifier. */
|
|
1023
|
+
resourceId?: string | null;
|
|
1024
|
+
/** Product Resource URL. */
|
|
1025
|
+
url?: string | null;
|
|
1026
|
+
}
|
|
1027
|
+
/** Dto class, containing information about a product. */
|
|
1028
|
+
interface ProductDto {
|
|
1029
|
+
/** Product identifier. */
|
|
1030
|
+
id?: number;
|
|
1031
|
+
/** Product version identifier. */
|
|
1032
|
+
productVersionId?: number;
|
|
1033
|
+
/** Tenant identifier. */
|
|
1034
|
+
tenantId?: number;
|
|
1035
|
+
/** Product name. */
|
|
1036
|
+
name?: string | null;
|
|
1037
|
+
/** Product description. */
|
|
1038
|
+
description?: string | null;
|
|
1039
|
+
/** Product image info. */
|
|
1040
|
+
image?: ImageInfo | null;
|
|
1041
|
+
/** Product creation time. */
|
|
1042
|
+
created?: string;
|
|
1043
|
+
/** Product modification time. */
|
|
1044
|
+
lastModified?: string | null;
|
|
1045
|
+
/** Product tags. */
|
|
1046
|
+
tags?: string[] | null;
|
|
1047
|
+
/** Product custom fields. */
|
|
1048
|
+
customFields?: {
|
|
1049
|
+
[key: string]: string;
|
|
1050
|
+
} | null;
|
|
1051
|
+
/** Personalization workflow identifier. */
|
|
1052
|
+
personalizationWorkflowId?: number;
|
|
1053
|
+
/** Processing pipeline identifier. */
|
|
1054
|
+
processingPipelineId?: number;
|
|
1055
|
+
/** Default storefront identifier. */
|
|
1056
|
+
storefrontId?: number | null;
|
|
1057
|
+
/** Default storefront product identifier. */
|
|
1058
|
+
storefrontProductId?: string | null;
|
|
1059
|
+
/** Default storefront product name. */
|
|
1060
|
+
storefrontProductName?: string | null;
|
|
1061
|
+
}
|
|
1062
|
+
/** DTO, containing results of paged query. */
|
|
1063
|
+
interface PagedOfProductDto {
|
|
1064
|
+
total?: number;
|
|
1065
|
+
items?: ProductDto[] | null;
|
|
1066
|
+
}
|
|
1067
|
+
/** Product option value creation operation parameters. */
|
|
1068
|
+
interface CreateProductOptionValueDto {
|
|
1069
|
+
/** Product option value. */
|
|
1070
|
+
value?: string | null;
|
|
1071
|
+
}
|
|
1072
|
+
/** Product option creation operation parameters. */
|
|
1073
|
+
interface CreateProductOptionDto {
|
|
1074
|
+
/** Option title. */
|
|
1075
|
+
title?: string | null;
|
|
1076
|
+
/** Option traits. */
|
|
1077
|
+
traits?: string[] | null;
|
|
1078
|
+
/** Product option values. */
|
|
1079
|
+
values?: CreateProductOptionValueDto[] | null;
|
|
1080
|
+
/** Flag that indicates if option can be used for product design connections creation. */
|
|
1081
|
+
useForDesignBinding?: boolean;
|
|
1082
|
+
/** Flag that indicates if option can be used for product mockup connections creation. */
|
|
1083
|
+
useForMockupBinding?: boolean;
|
|
1084
|
+
/** Flag that indicates if option can be used for product document connections creation. */
|
|
1085
|
+
useForDocumentBinding?: boolean;
|
|
1086
|
+
}
|
|
1087
|
+
/** Product option creation operation parameters. */
|
|
1088
|
+
interface CreateProductDto {
|
|
1089
|
+
/** Product name. */
|
|
1090
|
+
name?: string | null;
|
|
1091
|
+
/** Product description. */
|
|
1092
|
+
description?: string | null;
|
|
1093
|
+
/** Personalization workflow identifier. */
|
|
1094
|
+
personalizationWorkflowId?: number;
|
|
1095
|
+
/** Processing pipeline identifier. */
|
|
1096
|
+
processingPipelineId?: number;
|
|
1097
|
+
/** Product tags. */
|
|
1098
|
+
tags?: string[] | null;
|
|
1099
|
+
/** Product custom fields. */
|
|
1100
|
+
customFields?: {
|
|
1101
|
+
[key: string]: string;
|
|
1102
|
+
} | null;
|
|
1103
|
+
/** Product options parameters. */
|
|
1104
|
+
options?: CreateProductOptionDto[] | null;
|
|
1105
|
+
}
|
|
1106
|
+
/** Available option types. */
|
|
1107
|
+
enum OptionType {
|
|
1108
|
+
Simple = "Simple",
|
|
1109
|
+
Size = "Size",
|
|
1110
|
+
PageCount = "PageCount"
|
|
1111
|
+
}
|
|
1112
|
+
/** Available appearance types. */
|
|
1113
|
+
enum AppearanceDataType {
|
|
1114
|
+
Radio = "Radio",
|
|
1115
|
+
Dropdown = "Dropdown",
|
|
1116
|
+
Chips = "Chips",
|
|
1117
|
+
ColorGrid = "ColorGrid",
|
|
1118
|
+
ColorList = "ColorList",
|
|
1119
|
+
ImageGrid = "ImageGrid",
|
|
1120
|
+
ImageList = "ImageList"
|
|
1121
|
+
}
|
|
1122
|
+
/** DTO class, containing information about a product option appearance item. */
|
|
1123
|
+
interface AppearanceDataItemDto {
|
|
1124
|
+
/** Appearance item key. */
|
|
1125
|
+
key?: string | null;
|
|
1126
|
+
/** Appearance item value. */
|
|
1127
|
+
value?: string | null;
|
|
1128
|
+
}
|
|
1129
|
+
/** DTO class, containing information about a product option appearance. */
|
|
1130
|
+
interface AppearanceDataDto {
|
|
1131
|
+
/** Appearance type. */
|
|
1132
|
+
type?: AppearanceDataType;
|
|
1133
|
+
/** Appearance items. */
|
|
1134
|
+
items?: AppearanceDataItemDto[] | null;
|
|
1135
|
+
}
|
|
1136
|
+
/** Option value description for 'Simple' option type. */
|
|
1137
|
+
interface SimpleOptionValue {
|
|
1138
|
+
/** String Value. */
|
|
1139
|
+
value?: string | null;
|
|
1140
|
+
}
|
|
1141
|
+
/** DTO class, containing information about a product option value. */
|
|
1142
|
+
interface ProductOptionValueDto {
|
|
1143
|
+
/** Product option value identifier. */
|
|
1144
|
+
id?: number;
|
|
1145
|
+
/** Product option value title. */
|
|
1146
|
+
title?: string | null;
|
|
1147
|
+
/** Product option value sort index. */
|
|
1148
|
+
sortIndex?: number;
|
|
1149
|
+
/** Indicates if product option value is used as a default value. */
|
|
1150
|
+
isDefault?: boolean;
|
|
1151
|
+
/** Product option value identifying tag. */
|
|
1152
|
+
tag?: string | null;
|
|
1153
|
+
/** Product option value description for 'Simple' option type. */
|
|
1154
|
+
simpleOptionValue?: SimpleOptionValue | null;
|
|
1155
|
+
/** Product option value description. */
|
|
1156
|
+
description?: string | null;
|
|
1157
|
+
/** Product option value colors. */
|
|
1158
|
+
colors?: string[] | null;
|
|
1159
|
+
/** Product option value image. */
|
|
1160
|
+
image?: ImageInfo | null;
|
|
1161
|
+
}
|
|
1162
|
+
/** DTO class, containing information about a product option. */
|
|
1163
|
+
interface ProductOptionDto {
|
|
1164
|
+
/** Product option identifier. */
|
|
1165
|
+
id?: number;
|
|
1166
|
+
/** Product version identifier */
|
|
1167
|
+
productVersionId?: number;
|
|
1168
|
+
/** Product identifier. */
|
|
1169
|
+
productId?: number;
|
|
1170
|
+
/** Tenant identifier. */
|
|
1171
|
+
tenantId?: number;
|
|
1172
|
+
/** Option type ('Simple' / 'Size' / 'PageCount'). */
|
|
1173
|
+
type?: OptionType;
|
|
1174
|
+
/** Option traits. */
|
|
1175
|
+
traits?: string[] | null;
|
|
1176
|
+
/** Product option title. */
|
|
1177
|
+
title?: string | null;
|
|
1178
|
+
/** Product option sort index. */
|
|
1179
|
+
sortIndex?: number;
|
|
1180
|
+
/** Product option identifying tag. */
|
|
1181
|
+
tag?: string | null;
|
|
1182
|
+
/** Specifies if the option is used for design binding. */
|
|
1183
|
+
useForDesignBinding?: boolean;
|
|
1184
|
+
/** Specifies if the option is used for mockup binding. */
|
|
1185
|
+
useForMockupBinding?: boolean;
|
|
1186
|
+
/** Specifies if the option is used for document binding. */
|
|
1187
|
+
useForDocumentBinding?: boolean;
|
|
1188
|
+
/** Product option description. */
|
|
1189
|
+
description?: string | null;
|
|
1190
|
+
/** Product option tooltip. */
|
|
1191
|
+
tooltip?: string | null;
|
|
1192
|
+
/** Product option appearance. */
|
|
1193
|
+
appearanceData?: AppearanceDataDto | null;
|
|
1194
|
+
/** Product option image info. */
|
|
1195
|
+
image?: ImageInfo | null;
|
|
1196
|
+
/** A list of product option values. */
|
|
1197
|
+
productOptionValues?: ProductOptionValueDto[] | null;
|
|
1198
|
+
}
|
|
1199
|
+
/** DTO, containing results of paged query. */
|
|
1200
|
+
interface PagedOfProductOptionDto {
|
|
1201
|
+
total?: number;
|
|
1202
|
+
items?: ProductOptionDto[] | null;
|
|
1203
|
+
}
|
|
1204
|
+
/** Dto class, containing information about a product variant option. */
|
|
1205
|
+
interface ProductVariantOptionDto {
|
|
1206
|
+
/** Product option identifier. */
|
|
1207
|
+
productOptionId?: number | null;
|
|
1208
|
+
/** Product option value identifier. */
|
|
1209
|
+
productOptionValueId?: number | null;
|
|
1210
|
+
/** Product option type ('Simple' / 'Size' / 'PageCount'). */
|
|
1211
|
+
productOptionType?: OptionType;
|
|
1212
|
+
/** Product option traits. */
|
|
1213
|
+
productOptionTraits?: string[] | null;
|
|
1214
|
+
/** Product option title. */
|
|
1215
|
+
productOptionTitle?: string | null;
|
|
1216
|
+
/** Product option value title. */
|
|
1217
|
+
productOptionValueTitle?: string | null;
|
|
1218
|
+
/** Product option value description for 'Simple' option type. */
|
|
1219
|
+
simpleOptionValue?: SimpleOptionValue | null;
|
|
1220
|
+
}
|
|
1221
|
+
/** DTO class, containing information about a product variant. */
|
|
1222
|
+
interface ProductVariantDto {
|
|
1223
|
+
/** Product variant identifier. */
|
|
1224
|
+
id?: number;
|
|
1225
|
+
/** Product variant unique identifier. */
|
|
1226
|
+
uid?: string | null;
|
|
1227
|
+
/** Product version identifier. */
|
|
1228
|
+
productVersionId?: number;
|
|
1229
|
+
/** Product identifier. */
|
|
1230
|
+
productId?: number;
|
|
1231
|
+
/** Tenant identifier. */
|
|
1232
|
+
tenantId?: number;
|
|
1233
|
+
/** Product variant available. */
|
|
1234
|
+
isAvailable?: boolean;
|
|
1235
|
+
/** Product variant price. */
|
|
1236
|
+
price?: number | null;
|
|
1237
|
+
/** Product variant sort index. */
|
|
1238
|
+
sortIndex?: number;
|
|
1239
|
+
/** Product variant identifier (usually SKU) in storefront / online store. */
|
|
1240
|
+
storefrontProductVariantId?: string | null;
|
|
1241
|
+
/** Product variant SKU. */
|
|
1242
|
+
sku?: string | null;
|
|
1243
|
+
/** A list of product variant options. */
|
|
1244
|
+
productVariantOptions?: ProductVariantOptionDto[] | null;
|
|
1245
|
+
}
|
|
1246
|
+
/** DTO, containing results of paged query. */
|
|
1247
|
+
interface PagedOfProductVariantDto {
|
|
1248
|
+
total?: number;
|
|
1249
|
+
items?: ProductVariantDto[] | null;
|
|
1250
|
+
}
|
|
1251
|
+
/** Available product variant resource types. */
|
|
1252
|
+
enum ProductVariantResourceType {
|
|
1253
|
+
Preview = "Preview",
|
|
1254
|
+
EditorModel = "EditorModel",
|
|
1255
|
+
Custom = "Custom"
|
|
1256
|
+
}
|
|
1257
|
+
/** Product variant resource description for 'Preview' resource type. */
|
|
1258
|
+
interface ProductVariantResourcePreview {
|
|
1259
|
+
/** Preview with in pixels. */
|
|
1260
|
+
width?: number | null;
|
|
1261
|
+
/** Preview height in pixels. */
|
|
1262
|
+
height?: number | null;
|
|
1263
|
+
/** Mockup which is used to create preview. */
|
|
1264
|
+
mockupId?: string | null;
|
|
1265
|
+
/** Design surface index which is used to create preivew. */
|
|
1266
|
+
surfaceIndex?: number | null;
|
|
1267
|
+
}
|
|
1268
|
+
/** Dto class, containing information about a product variant resource. */
|
|
1269
|
+
interface ProductVariantResourceDto {
|
|
1270
|
+
/** Resource identifier. */
|
|
1271
|
+
resourceId?: string | null;
|
|
1272
|
+
/** Resource name. */
|
|
1273
|
+
name?: string | null;
|
|
1274
|
+
/** Resource url. */
|
|
1275
|
+
url?: string | null;
|
|
1276
|
+
/** Resource type. */
|
|
1277
|
+
type?: ProductVariantResourceType;
|
|
1278
|
+
/** Product variant resource description for 'Preview' resource type. */
|
|
1279
|
+
resourcePreview?: ProductVariantResourcePreview | null;
|
|
1280
|
+
}
|
|
1281
|
+
/** Dto class, containing information about a product variant design. */
|
|
1282
|
+
interface ProductVariantDesignDto {
|
|
1283
|
+
/** Product variant identifier. */
|
|
1284
|
+
productVariantId?: number;
|
|
1285
|
+
/** Product version identifier. */
|
|
1286
|
+
productVersionId?: number;
|
|
1287
|
+
/** Product identifier. */
|
|
1288
|
+
productId?: number;
|
|
1289
|
+
/** Tenant identifier. */
|
|
1290
|
+
tenantId?: number;
|
|
1291
|
+
/** Product variant available. */
|
|
1292
|
+
isAvailable?: boolean;
|
|
1293
|
+
/** Product variant price. */
|
|
1294
|
+
price?: number | null;
|
|
1295
|
+
/** Product variant sort index. */
|
|
1296
|
+
sortIndex?: number;
|
|
1297
|
+
/** Product variant identifier (usually SKU) in storefront / online store. */
|
|
1298
|
+
storefrontProductVariantId?: string | null;
|
|
1299
|
+
/** Product variant SKU. */
|
|
1300
|
+
sku?: string | null;
|
|
1301
|
+
/** Design identifier. */
|
|
1302
|
+
designId?: string | null;
|
|
1303
|
+
/** Design name. */
|
|
1304
|
+
designName?: string | null;
|
|
1305
|
+
/** Design grouping tag. */
|
|
1306
|
+
designGroup?: string | null;
|
|
1307
|
+
/** Design data schema tag. Indicates if design has data schema. */
|
|
1308
|
+
designHasDataSchema?: boolean;
|
|
1309
|
+
/** Design toggle set tag. Indicated if design has toggle set. */
|
|
1310
|
+
designHasToggleSet?: boolean;
|
|
1311
|
+
/** A list of product variant options. */
|
|
1312
|
+
productVariantOptions?: ProductVariantOptionDto[] | null;
|
|
1313
|
+
/** A list of product variant resources. */
|
|
1314
|
+
productVariantResources?: ProductVariantResourceDto[] | null;
|
|
1315
|
+
}
|
|
1316
|
+
/** DTO, containing results of paged query. */
|
|
1317
|
+
interface PagedOfProductVariantDesignDto {
|
|
1318
|
+
total?: number;
|
|
1319
|
+
items?: ProductVariantDesignDto[] | null;
|
|
1320
|
+
}
|
|
1321
|
+
/** Available mockup types. */
|
|
1322
|
+
enum ProductVariantMockupType {
|
|
1323
|
+
Thumbnail = "Thumbnail",
|
|
1324
|
+
Editor = "Editor",
|
|
1325
|
+
Preview = "Preview"
|
|
1326
|
+
}
|
|
1327
|
+
/** Available surface usage types. */
|
|
1328
|
+
enum SurfaceUsageType {
|
|
1329
|
+
Individual = "Individual",
|
|
1330
|
+
Custom = "Custom",
|
|
1331
|
+
All = "All"
|
|
1332
|
+
}
|
|
1333
|
+
/** Dto class, containing information about a product variant mockup. */
|
|
1334
|
+
interface ProductVariantMockupDto {
|
|
1335
|
+
/** Product variant identifier. */
|
|
1336
|
+
productVariantId?: number;
|
|
1337
|
+
/** Product version identifier. */
|
|
1338
|
+
productVersionId?: number;
|
|
1339
|
+
/** Product identifier. */
|
|
1340
|
+
productId?: number;
|
|
1341
|
+
/** Tenant identifier. */
|
|
1342
|
+
tenantId?: number | null;
|
|
1343
|
+
/** Product variant identifier in online store (usually SKU). */
|
|
1344
|
+
storefrontProductVariantId?: string | null;
|
|
1345
|
+
/** Product variant SKU. */
|
|
1346
|
+
sku?: string | null;
|
|
1347
|
+
/** Mockup identifier. */
|
|
1348
|
+
mockupId?: string | null;
|
|
1349
|
+
/** Mockup name. */
|
|
1350
|
+
mockupName?: string | null;
|
|
1351
|
+
/** Mockup type. */
|
|
1352
|
+
mockupType?: ProductVariantMockupType;
|
|
1353
|
+
/** Surface index indicates a surface of a design to which mockup should be applied. */
|
|
1354
|
+
surfaceIndex?: number | null;
|
|
1355
|
+
/** Surface usage type defines a scheme for applying mockup to design surfaces. */
|
|
1356
|
+
surfaceUsageType?: SurfaceUsageType;
|
|
1357
|
+
/** A list of product variant options. */
|
|
1358
|
+
productVariantOptions?: ProductVariantOptionDto[] | null;
|
|
1359
|
+
}
|
|
1360
|
+
/** DTO, containing results of paged query. */
|
|
1361
|
+
interface PagedOfProductVariantMockupDto {
|
|
1362
|
+
total?: number;
|
|
1363
|
+
items?: ProductVariantMockupDto[] | null;
|
|
1364
|
+
}
|
|
1365
|
+
/** DTO class, containing information about a product variant document. */
|
|
1366
|
+
interface ProductVariantDocumentDto {
|
|
1367
|
+
/** Product variant identifier. */
|
|
1368
|
+
productVariantId?: number;
|
|
1369
|
+
/** Product version identifier. */
|
|
1370
|
+
productVersionId?: number;
|
|
1371
|
+
/** Product identifier. */
|
|
1372
|
+
productId?: number;
|
|
1373
|
+
/** Tenant identifier. */
|
|
1374
|
+
tenantId?: number;
|
|
1375
|
+
/** Product variant available. */
|
|
1376
|
+
isAvailable?: boolean;
|
|
1377
|
+
/** Product variant price. */
|
|
1378
|
+
price?: number | null;
|
|
1379
|
+
/** Product variant sort index. */
|
|
1380
|
+
sortIndex?: number;
|
|
1381
|
+
/** Product variant identifier (usually SKU) in storefront / online store. */
|
|
1382
|
+
storefrontProductVariantId?: string | null;
|
|
1383
|
+
/** Product variant SKU. */
|
|
1384
|
+
sku?: string | null;
|
|
1385
|
+
/** Document identifier. */
|
|
1386
|
+
documentId?: string | null;
|
|
1387
|
+
/** Document name. */
|
|
1388
|
+
documentName?: string | null;
|
|
1389
|
+
/** Document grouping tag. */
|
|
1390
|
+
documentGroup?: string | null;
|
|
1391
|
+
/** A list of product variant options. */
|
|
1392
|
+
productVariantOptions?: ProductVariantOptionDto[] | null;
|
|
1393
|
+
/** A list of product variant resources. */
|
|
1394
|
+
productVariantResources?: ProductVariantResourceDto[] | null;
|
|
1395
|
+
}
|
|
1396
|
+
/** DTO, containing results of paged query. */
|
|
1397
|
+
interface PagedOfProductVariantDocumentDto {
|
|
1398
|
+
total?: number;
|
|
1399
|
+
items?: ProductVariantDocumentDto[] | null;
|
|
1400
|
+
}
|
|
1401
|
+
/** Parameters for setting product variants price. */
|
|
1402
|
+
interface ProductVariantPriceDto {
|
|
1403
|
+
/** Price. */
|
|
1404
|
+
price?: number | null;
|
|
1405
|
+
/** Identifiers of variants for price setting. */
|
|
1406
|
+
variantIds?: number[] | null;
|
|
1407
|
+
}
|
|
1408
|
+
/** Product variants price setting operation parameters. */
|
|
1409
|
+
interface SetProductVariantPriceDto {
|
|
1410
|
+
/** List of product variants grouped by price value. */
|
|
1411
|
+
items?: ProductVariantPriceDto[] | null;
|
|
1412
|
+
}
|
|
1413
|
+
/** Parameters for setting product variants availability. */
|
|
1414
|
+
interface ProductVariantAvailabilityDto {
|
|
1415
|
+
/** Availability. */
|
|
1416
|
+
availability?: boolean;
|
|
1417
|
+
/** Identifiers of variants for availability setting. */
|
|
1418
|
+
variantIds?: number[] | null;
|
|
1419
|
+
}
|
|
1420
|
+
/** Product variants availability setting operation parameters. */
|
|
1421
|
+
interface SetProductVariantAvailabilityDto {
|
|
1422
|
+
/** List of product variants grouped by availability value. */
|
|
1423
|
+
items?: ProductVariantAvailabilityDto[] | null;
|
|
1424
|
+
}
|
|
1425
|
+
/** Parameters for setting product variants SKU. */
|
|
1426
|
+
interface ProductVariantSkuDto {
|
|
1427
|
+
/** SKU. */
|
|
1428
|
+
sku?: string | null;
|
|
1429
|
+
/** Identifiers of variants for SKU setting. */
|
|
1430
|
+
variantIds?: number[] | null;
|
|
1431
|
+
}
|
|
1432
|
+
/** Product variants SKU setting operation parameters. */
|
|
1433
|
+
interface SetProductVariantSkuDto {
|
|
1434
|
+
/** List of product variants grouped by SKU value. */
|
|
1435
|
+
items?: ProductVariantSkuDto[] | null;
|
|
1436
|
+
}
|
|
1437
|
+
/** Product asset connection options description. */
|
|
1438
|
+
interface ProductAssetConnectionOptionsDto {
|
|
1439
|
+
/** Product option identifier. */
|
|
1440
|
+
optionId?: number;
|
|
1441
|
+
/** Product option values identifiers. */
|
|
1442
|
+
optionValueIds?: number[] | null;
|
|
1443
|
+
}
|
|
1444
|
+
/** Product design connection description. */
|
|
1445
|
+
interface ProductDesignConnectionDto {
|
|
1446
|
+
/** Design identifier. */
|
|
1447
|
+
designId?: string | null;
|
|
1448
|
+
/** Connection options. Set empty if design should be available for all product variants. */
|
|
1449
|
+
options?: ProductAssetConnectionOptionsDto[] | null;
|
|
1450
|
+
}
|
|
1451
|
+
/** Product designs connections creation model. */
|
|
1452
|
+
interface CreateProductDesignConnectionsDto {
|
|
1453
|
+
/** Connection parameters list. */
|
|
1454
|
+
connections?: ProductDesignConnectionDto[] | null;
|
|
1455
|
+
}
|
|
1456
|
+
/** Product asset connection removing parameters. */
|
|
1457
|
+
interface RemoveProductAssetConnectionDto {
|
|
1458
|
+
/** Asset identifier. */
|
|
1459
|
+
assetId?: string | null;
|
|
1460
|
+
/** Connection options. Set empty if all product variants connections should be removed. */
|
|
1461
|
+
options?: ProductAssetConnectionOptionsDto[] | null;
|
|
1462
|
+
}
|
|
1463
|
+
/** Product designs connections removing model. */
|
|
1464
|
+
interface RemoveProductDesignConnectionsDto {
|
|
1465
|
+
/** Connection parameters list. */
|
|
1466
|
+
connections?: RemoveProductAssetConnectionDto[] | null;
|
|
1467
|
+
}
|
|
1468
|
+
/** Product mockup type. */
|
|
1469
|
+
enum ProductMockupType {
|
|
1470
|
+
Thumbnail = "Thumbnail",
|
|
1471
|
+
Editor = "Editor",
|
|
1472
|
+
Preview = "Preview"
|
|
1473
|
+
}
|
|
1474
|
+
/** Product mockup connection description. */
|
|
1475
|
+
interface ProductMockupConnectionDto {
|
|
1476
|
+
/** Mockup identifier. */
|
|
1477
|
+
mockupId?: string | null;
|
|
1478
|
+
/** Connection options. Set empty if mockup should be available for all product variants. */
|
|
1479
|
+
options?: ProductAssetConnectionOptionsDto[] | null;
|
|
1480
|
+
/** Product mockup types. Single mockup may be used as editor, preview and thumbnail mockup at the same time. */
|
|
1481
|
+
mockupTypes?: ProductMockupType[] | null;
|
|
1482
|
+
/** Product mockup target surfaces. Comma-separated surface indexes ("1,2,3") or `all` value may be set. */
|
|
1483
|
+
surfaces?: string | null;
|
|
1484
|
+
}
|
|
1485
|
+
/** Product mockups connections creation model. */
|
|
1486
|
+
interface CreateProductMockupConnectionsDto {
|
|
1487
|
+
/** Connection parameters list. */
|
|
1488
|
+
connections?: ProductMockupConnectionDto[] | null;
|
|
1489
|
+
}
|
|
1490
|
+
/** Product mockups connections removing model. */
|
|
1491
|
+
interface RemoveProductMockupConnectionsDto {
|
|
1492
|
+
/** Connection parameters list. */
|
|
1493
|
+
connections?: RemoveProductAssetConnectionDto[] | null;
|
|
1494
|
+
}
|
|
1495
|
+
/** Product document connection description. */
|
|
1496
|
+
interface ProductDocumentConnectionDto {
|
|
1497
|
+
/** Document identifier. */
|
|
1498
|
+
documentId?: string | null;
|
|
1499
|
+
/** Connection options. Set empty if document should be available for all product variants. */
|
|
1500
|
+
options?: ProductAssetConnectionOptionsDto[] | null;
|
|
1501
|
+
}
|
|
1502
|
+
/** Product documents connections creation model. */
|
|
1503
|
+
interface CreateProductDocumentConnectionsDto {
|
|
1504
|
+
/** Connection parameters list. */
|
|
1505
|
+
connections?: ProductDocumentConnectionDto[] | null;
|
|
1506
|
+
}
|
|
1507
|
+
/** Product documents connections removing model. */
|
|
1508
|
+
interface RemoveProductDocumentConnectionsDto {
|
|
1509
|
+
/** Connection parameters list. */
|
|
1510
|
+
connections?: RemoveProductAssetConnectionDto[] | null;
|
|
1511
|
+
}
|
|
1512
|
+
/** Type of editor that should be configured by workflow. */
|
|
1513
|
+
enum WorkflowType {
|
|
1514
|
+
UIFramework = "UIFramework",
|
|
1515
|
+
SimpleEditor = "SimpleEditor",
|
|
1516
|
+
DesignEditor = "DesignEditor",
|
|
1517
|
+
WorkflowElements = "WorkflowElements"
|
|
1518
|
+
}
|
|
1519
|
+
/** Personalization workflow description DTO. */
|
|
1520
|
+
interface PersonalizationWorkflowDto {
|
|
1521
|
+
/** Workflow identifier. */
|
|
1522
|
+
id?: number;
|
|
1523
|
+
/** Workflow name. */
|
|
1524
|
+
name?: string | null;
|
|
1525
|
+
/** Workflow type. */
|
|
1526
|
+
workflowType?: WorkflowType;
|
|
1527
|
+
}
|
|
1528
|
+
/** DTO, containing results of paged query. */
|
|
1529
|
+
interface PagedOfPersonalizationWorkflowDto {
|
|
1530
|
+
total?: number;
|
|
1531
|
+
items?: PersonalizationWorkflowDto[] | null;
|
|
1532
|
+
}
|
|
1533
|
+
/** Dto class, containing information about processing pipeline details. */
|
|
1534
|
+
interface ProcessingPipelineDto {
|
|
1535
|
+
/** Processing pipeline identifier. */
|
|
1536
|
+
id?: number;
|
|
1537
|
+
/** Processing pipeline name. */
|
|
1538
|
+
name?: string | null;
|
|
1539
|
+
}
|
|
1540
|
+
/** DTO, containing results of paged query. */
|
|
1541
|
+
interface PagedOfProcessingPipelineDto {
|
|
1542
|
+
total?: number;
|
|
1543
|
+
items?: ProcessingPipelineDto[] | null;
|
|
1544
|
+
}
|
|
1545
|
+
/** Storefront types. */
|
|
1546
|
+
enum StorefrontType {
|
|
1547
|
+
Custom = "Custom",
|
|
1548
|
+
ShopifyLegacy = "ShopifyLegacy",
|
|
1549
|
+
DocketManager = "DocketManager",
|
|
1550
|
+
CustomSaml = "CustomSaml",
|
|
1551
|
+
NopCommerce = "NopCommerce",
|
|
1552
|
+
WooCommerce = "WooCommerce",
|
|
1553
|
+
Magento = "Magento",
|
|
1554
|
+
BigCommerce = "BigCommerce",
|
|
1555
|
+
Shopify = "Shopify",
|
|
1556
|
+
ShopifyCustom = "ShopifyCustom"
|
|
1557
|
+
}
|
|
1558
|
+
/** Dto class, containing information about a storefront. */
|
|
1559
|
+
interface StorefrontDto {
|
|
1560
|
+
/** Storefront identifier. */
|
|
1561
|
+
id?: number;
|
|
1562
|
+
/** Tenant identifier. */
|
|
1563
|
+
tenantId?: number;
|
|
1564
|
+
/** Storefront name. */
|
|
1565
|
+
name?: string | null;
|
|
1566
|
+
/** Status of project that should become a trigger to start project items processing automatically. */
|
|
1567
|
+
processingPipelinesTriggerProjectStatus?: number | null;
|
|
1568
|
+
/** Identifier of pipeline that should be used for post-processing for projects when all project items are processed. */
|
|
1569
|
+
postProcessingPipelineId?: number | null;
|
|
1570
|
+
/** Storefront ecommerce system type. */
|
|
1571
|
+
type?: StorefrontType;
|
|
1572
|
+
/** Storefront entity creation date and time. */
|
|
1573
|
+
created?: string;
|
|
1574
|
+
/** Connected shops URLs. */
|
|
1575
|
+
shopUrls?: string[] | null;
|
|
1576
|
+
}
|
|
1577
|
+
/** DTO, containing results of paged query. */
|
|
1578
|
+
interface PagedOfStorefrontDto {
|
|
1579
|
+
total?: number;
|
|
1580
|
+
items?: StorefrontDto[] | null;
|
|
1581
|
+
}
|
|
1582
|
+
/** Custom storefront creation model. */
|
|
1583
|
+
interface CreateCustomStorefrontDto {
|
|
1584
|
+
/** Storefront name. */
|
|
1585
|
+
name: string;
|
|
1586
|
+
/** Status of project that should become a trigger to start project items processing automatically. */
|
|
1587
|
+
processingPipelinesTriggerProjectStatus?: number | null;
|
|
1588
|
+
/** Identifier of pipeline that should be used for post-processing for projects when all project items are processed. */
|
|
1589
|
+
postProcessingPipelineId?: number | null;
|
|
1590
|
+
/** Name of header that will be used to provide API key to target storefront system. */
|
|
1591
|
+
apiKeyHeaderName?: string | null;
|
|
1592
|
+
/** API key for target storefront system. */
|
|
1593
|
+
apiKey?: string | null;
|
|
1594
|
+
/** List of storefront shops URLs. */
|
|
1595
|
+
shopUrls: string[];
|
|
1596
|
+
}
|
|
1597
|
+
/** Custom storefront description. */
|
|
1598
|
+
interface CustomStorefrontDto {
|
|
1599
|
+
/** Name of header that will be used to provide API key to target storefront system. */
|
|
1600
|
+
apiKeyHeaderName?: string | null;
|
|
1601
|
+
/** API key for target storefront system. */
|
|
1602
|
+
apiKey?: string | null;
|
|
1603
|
+
/** Storefront identifier. */
|
|
1604
|
+
id?: number;
|
|
1605
|
+
/** Tenant identifier. */
|
|
1606
|
+
tenantId?: number;
|
|
1607
|
+
/** Storefront name. */
|
|
1608
|
+
name?: string | null;
|
|
1609
|
+
/** Status of project that should become a trigger to start project items processing automatically. */
|
|
1610
|
+
processingPipelinesTriggerProjectStatus?: number | null;
|
|
1611
|
+
/** Identifier of pipeline that should be used for post-processing for projects when all project items are processed. */
|
|
1612
|
+
postProcessingPipelineId?: number | null;
|
|
1613
|
+
/** Storefront ecommerce system type. */
|
|
1614
|
+
type?: StorefrontType;
|
|
1615
|
+
/** Storefront entity creation date and time. */
|
|
1616
|
+
created?: string;
|
|
1617
|
+
/** Connected shops URLs. */
|
|
1618
|
+
shopUrls?: string[] | null;
|
|
1619
|
+
}
|
|
1620
|
+
/** NopCommerce storefront creation model. */
|
|
1621
|
+
interface CreateNopCommerceStorefrontDto {
|
|
1622
|
+
/** NopCommerce storefront name. */
|
|
1623
|
+
name: string;
|
|
1624
|
+
/** Status of project that should become a trigger to start project items processing automatically. */
|
|
1625
|
+
processingPipelinesTriggerProjectStatus?: number | null;
|
|
1626
|
+
/** Identifier of pipeline that should be used for post-processing for projects when all project items are processed. */
|
|
1627
|
+
postProcessingPipelineId?: number | null;
|
|
1628
|
+
/** List of NopCommerce shops URLs. */
|
|
1629
|
+
shopUrls: string[];
|
|
1630
|
+
/** NopCommerce back-end application URL. */
|
|
1631
|
+
backendUrl: string;
|
|
1632
|
+
}
|
|
1633
|
+
/** NopCommerce storefront settings. */
|
|
1634
|
+
interface NopCommerceSettingsDto {
|
|
1635
|
+
/** Customer's Canvas Asset Storage URL. */
|
|
1636
|
+
assetStorageUrl?: string | null;
|
|
1637
|
+
/** Customer's Canvas Asset Processor URL. */
|
|
1638
|
+
assetProcessorUrl?: string | null;
|
|
1639
|
+
/** Customer's Canvas tenant identifier. */
|
|
1640
|
+
tenantId?: number;
|
|
1641
|
+
/** Customer's Canvas storefront identifier. */
|
|
1642
|
+
storefrontId?: number;
|
|
1643
|
+
/** Customer's Canvas custom application client identifier. */
|
|
1644
|
+
clientId?: string | null;
|
|
1645
|
+
/** Customer's Canvas custom application client secret. */
|
|
1646
|
+
clientSecret?: string | null;
|
|
1647
|
+
/** NopCommerce plugin API key. */
|
|
1648
|
+
pluginApiKey?: string | null;
|
|
1649
|
+
}
|
|
1650
|
+
/** NopCommerce storefront description. */
|
|
1651
|
+
interface NopCommerceStorefrontDto {
|
|
1652
|
+
/** NopCommerce storefront settings. */
|
|
1653
|
+
settings?: NopCommerceSettingsDto | null;
|
|
1654
|
+
/** Storefront identifier. */
|
|
1655
|
+
id?: number;
|
|
1656
|
+
/** Tenant identifier. */
|
|
1657
|
+
tenantId?: number;
|
|
1658
|
+
/** Storefront name. */
|
|
1659
|
+
name?: string | null;
|
|
1660
|
+
/** Status of project that should become a trigger to start project items processing automatically. */
|
|
1661
|
+
processingPipelinesTriggerProjectStatus?: number | null;
|
|
1662
|
+
/** Identifier of pipeline that should be used for post-processing for projects when all project items are processed. */
|
|
1663
|
+
postProcessingPipelineId?: number | null;
|
|
1664
|
+
/** Storefront ecommerce system type. */
|
|
1665
|
+
type?: StorefrontType;
|
|
1666
|
+
/** Storefront entity creation date and time. */
|
|
1667
|
+
created?: string;
|
|
1668
|
+
/** Connected shops URLs. */
|
|
1669
|
+
shopUrls?: string[] | null;
|
|
1670
|
+
}
|
|
1671
|
+
/** WooCommerce storefront creation model. */
|
|
1672
|
+
interface CreateWooCommerceStorefrontDto {
|
|
1673
|
+
/** WooCommerce storefront name. */
|
|
1674
|
+
name: string;
|
|
1675
|
+
/** Status of project that should become a trigger to start project items processing automatically. */
|
|
1676
|
+
processingPipelinesTriggerProjectStatus?: number | null;
|
|
1677
|
+
/** Identifier of pipeline that should be used for post-processing for projects when all project items are processed. */
|
|
1678
|
+
postProcessingPipelineId?: number | null;
|
|
1679
|
+
/** List of WooCommerce shops URLs. */
|
|
1680
|
+
shopUrls: string[];
|
|
1681
|
+
/** WooCommerce back-end application URL. */
|
|
1682
|
+
backendUrl: string;
|
|
1683
|
+
}
|
|
1684
|
+
/** WooCommerce storefront settings. */
|
|
1685
|
+
interface WooCommerceSettingsDto {
|
|
1686
|
+
/** Customer's Canvas Asset Storage URL. */
|
|
1687
|
+
assetStorageUrl?: string | null;
|
|
1688
|
+
/** Customer's Canvas Asset Processor URL. */
|
|
1689
|
+
assetProcessorUrl?: string | null;
|
|
1690
|
+
/** Customer's Canvas tenant identifier. */
|
|
1691
|
+
tenantId?: number;
|
|
1692
|
+
/** Customer's Canvas storefront identifier. */
|
|
1693
|
+
storefrontId?: number;
|
|
1694
|
+
/** Customer's Canvas custom application client identifier. */
|
|
1695
|
+
clientId?: string | null;
|
|
1696
|
+
/** Customer's Canvas custom application client secret. */
|
|
1697
|
+
clientSecret?: string | null;
|
|
1698
|
+
/** WooCommerce plugin API key. */
|
|
1699
|
+
pluginApiKey?: string | null;
|
|
1700
|
+
}
|
|
1701
|
+
/** WooCommerce storefront description. */
|
|
1702
|
+
interface WooCommerceStorefrontDto {
|
|
1703
|
+
/** WooCommerce storefront settings. */
|
|
1704
|
+
settings?: WooCommerceSettingsDto | null;
|
|
1705
|
+
/** Storefront identifier. */
|
|
1706
|
+
id?: number;
|
|
1707
|
+
/** Tenant identifier. */
|
|
1708
|
+
tenantId?: number;
|
|
1709
|
+
/** Storefront name. */
|
|
1710
|
+
name?: string | null;
|
|
1711
|
+
/** Status of project that should become a trigger to start project items processing automatically. */
|
|
1712
|
+
processingPipelinesTriggerProjectStatus?: number | null;
|
|
1713
|
+
/** Identifier of pipeline that should be used for post-processing for projects when all project items are processed. */
|
|
1714
|
+
postProcessingPipelineId?: number | null;
|
|
1715
|
+
/** Storefront ecommerce system type. */
|
|
1716
|
+
type?: StorefrontType;
|
|
1717
|
+
/** Storefront entity creation date and time. */
|
|
1718
|
+
created?: string;
|
|
1719
|
+
/** Connected shops URLs. */
|
|
1720
|
+
shopUrls?: string[] | null;
|
|
1721
|
+
}
|
|
1722
|
+
/** Magento storefront creation model. */
|
|
1723
|
+
interface CreateMagentoStorefrontDto {
|
|
1724
|
+
/** Storefront name. */
|
|
1725
|
+
name: string;
|
|
1726
|
+
/** Status of project that should become a trigger to start project items processing automatically. */
|
|
1727
|
+
processingPipelinesTriggerProjectStatus?: number | null;
|
|
1728
|
+
/** Identifier of pipeline that should be used for post-processing for projects when all project items are processed. */
|
|
1729
|
+
postProcessingPipelineId?: number | null;
|
|
1730
|
+
/** List of Magento shops URLs. */
|
|
1731
|
+
shopUrls: string[];
|
|
1732
|
+
/** Magento back-end application URL. */
|
|
1733
|
+
backendUrl: string;
|
|
1734
|
+
/** Magento API key. */
|
|
1735
|
+
shopApiKey: string;
|
|
1736
|
+
/** Magento shop code. */
|
|
1737
|
+
shopCode?: string | null;
|
|
1738
|
+
}
|
|
1739
|
+
/** Magento storefront settings. */
|
|
1740
|
+
interface MagentoSettingsDto {
|
|
1741
|
+
/** Customer's Canvas Asset Storage URL. */
|
|
1742
|
+
assetStorageUrl?: string | null;
|
|
1743
|
+
/** Customer's Canvas Asset Processor URL. */
|
|
1744
|
+
assetProcessorUrl?: string | null;
|
|
1745
|
+
/** Customer's Canvas tenant identifier. */
|
|
1746
|
+
tenantId?: number;
|
|
1747
|
+
/** Customer's Canvas storefront identifier. */
|
|
1748
|
+
storefrontId?: number;
|
|
1749
|
+
/** Customer's Canvas custom application client identifier. */
|
|
1750
|
+
clientId?: string | null;
|
|
1751
|
+
/** Customer's Canvas custom application client secret. */
|
|
1752
|
+
clientSecret?: string | null;
|
|
1753
|
+
}
|
|
1754
|
+
/** Magento storefront description. */
|
|
1755
|
+
interface MagentoStorefrontDto {
|
|
1756
|
+
/** Magento storefront settings. */
|
|
1757
|
+
settings?: MagentoSettingsDto | null;
|
|
1758
|
+
/** Storefront identifier. */
|
|
1759
|
+
id?: number;
|
|
1760
|
+
/** Tenant identifier. */
|
|
1761
|
+
tenantId?: number;
|
|
1762
|
+
/** Storefront name. */
|
|
1763
|
+
name?: string | null;
|
|
1764
|
+
/** Status of project that should become a trigger to start project items processing automatically. */
|
|
1765
|
+
processingPipelinesTriggerProjectStatus?: number | null;
|
|
1766
|
+
/** Identifier of pipeline that should be used for post-processing for projects when all project items are processed. */
|
|
1767
|
+
postProcessingPipelineId?: number | null;
|
|
1768
|
+
/** Storefront ecommerce system type. */
|
|
1769
|
+
type?: StorefrontType;
|
|
1770
|
+
/** Storefront entity creation date and time. */
|
|
1771
|
+
created?: string;
|
|
1772
|
+
/** Connected shops URLs. */
|
|
1773
|
+
shopUrls?: string[] | null;
|
|
1774
|
+
}
|
|
1775
|
+
/** BigCommerce storefront creation model. */
|
|
1776
|
+
interface CreateBigCommerceStorefrontDto {
|
|
1777
|
+
/** Storefront name. */
|
|
1778
|
+
name: string;
|
|
1779
|
+
/** Status of project that should become a trigger to start project items processing automatically. */
|
|
1780
|
+
processingPipelinesTriggerProjectStatus?: number | null;
|
|
1781
|
+
/** Identifier of pipeline that should be used for post-processing for projects when all project items are processed. */
|
|
1782
|
+
postProcessingPipelineId?: number | null;
|
|
1783
|
+
/** List of shops URLs. */
|
|
1784
|
+
shopUrls: string[];
|
|
1785
|
+
/** BigCommerce access token. */
|
|
1786
|
+
accessToken: string;
|
|
1787
|
+
/** BigCommerce client name. */
|
|
1788
|
+
clientName: string;
|
|
1789
|
+
/** BigCommerce client identifier. */
|
|
1790
|
+
clientId: string;
|
|
1791
|
+
/** BigCommerce client secret. */
|
|
1792
|
+
clientSecret: string;
|
|
1793
|
+
/** BigCommerce integration name. */
|
|
1794
|
+
integrationName: string;
|
|
1795
|
+
/** BigCommerce API path. */
|
|
1796
|
+
apiPath: string;
|
|
1797
|
+
}
|
|
1798
|
+
/** BigCommerce storefront settings. */
|
|
1799
|
+
interface BigCommerceSettingsDto {
|
|
1800
|
+
/** BigCommerce access token. */
|
|
1801
|
+
accessToken?: string | null;
|
|
1802
|
+
/** BigCommerce client name. */
|
|
1803
|
+
bigCommerceClientName?: string | null;
|
|
1804
|
+
/** BigCommerce API path. */
|
|
1805
|
+
apiPath?: string | null;
|
|
1806
|
+
/** BigCommerce client secret. */
|
|
1807
|
+
bigCommerceClientSecret?: string | null;
|
|
1808
|
+
/** BigCommerce client identifier. */
|
|
1809
|
+
bigCommerceClientId?: string | null;
|
|
1810
|
+
/** BigCommerce integration name. */
|
|
1811
|
+
integrationName?: string | null;
|
|
1812
|
+
}
|
|
1813
|
+
/** BigCommerce storefront description. */
|
|
1814
|
+
interface BigCommerceStorefrontDto {
|
|
1815
|
+
/** BigCommerce integration settings. */
|
|
1816
|
+
settings?: BigCommerceSettingsDto | null;
|
|
1817
|
+
/** Storefront identifier. */
|
|
1818
|
+
id?: number;
|
|
1819
|
+
/** Tenant identifier. */
|
|
1820
|
+
tenantId?: number;
|
|
1821
|
+
/** Storefront name. */
|
|
1822
|
+
name?: string | null;
|
|
1823
|
+
/** Status of project that should become a trigger to start project items processing automatically. */
|
|
1824
|
+
processingPipelinesTriggerProjectStatus?: number | null;
|
|
1825
|
+
/** Identifier of pipeline that should be used for post-processing for projects when all project items are processed. */
|
|
1826
|
+
postProcessingPipelineId?: number | null;
|
|
1827
|
+
/** Storefront ecommerce system type. */
|
|
1828
|
+
type?: StorefrontType;
|
|
1829
|
+
/** Storefront entity creation date and time. */
|
|
1830
|
+
created?: string;
|
|
1831
|
+
/** Connected shops URLs. */
|
|
1832
|
+
shopUrls?: string[] | null;
|
|
1833
|
+
}
|
|
1834
|
+
/** Tenant user description. */
|
|
1835
|
+
interface TenantUserDto {
|
|
1836
|
+
/** User identifier. */
|
|
1837
|
+
id?: number;
|
|
1838
|
+
/** User login. */
|
|
1839
|
+
login?: string | null;
|
|
1840
|
+
/** User email address. */
|
|
1841
|
+
email?: string | null;
|
|
1842
|
+
/** User first name. */
|
|
1843
|
+
firstName?: string | null;
|
|
1844
|
+
/** User last name. */
|
|
1845
|
+
lastName?: string | null;
|
|
1846
|
+
/** User status. */
|
|
1847
|
+
isActive?: boolean;
|
|
1848
|
+
/** User roles. */
|
|
1849
|
+
roleNames?: string[] | null;
|
|
1850
|
+
}
|
|
1851
|
+
/** DTO, containing results of paged query. */
|
|
1852
|
+
interface PagedOfTenantUserDto {
|
|
1853
|
+
total?: number;
|
|
1854
|
+
items?: TenantUserDto[] | null;
|
|
1855
|
+
}
|
|
1856
|
+
/** Tenant user creation model. */
|
|
1857
|
+
interface CreateTenantUserDto {
|
|
1858
|
+
/** User login (up to 256 symbols). */
|
|
1859
|
+
login: string;
|
|
1860
|
+
/** User first name (up to 64 symbols). */
|
|
1861
|
+
firstName: string;
|
|
1862
|
+
/** User last name (up to 64 symbols). */
|
|
1863
|
+
lastName: string;
|
|
1864
|
+
/** User email address (up to 256 symbols). */
|
|
1865
|
+
email: string;
|
|
1866
|
+
/** User status. */
|
|
1867
|
+
isActive?: boolean;
|
|
1868
|
+
/** User roles (e.g. 'Admin', 'User'). */
|
|
1869
|
+
roleNames?: string[] | null;
|
|
1870
|
+
/** User password (up to 32 symbols). */
|
|
1871
|
+
password: string;
|
|
1872
|
+
}
|
|
1873
|
+
/** Tenant user role description. */
|
|
1874
|
+
interface TenantUserRoleDto {
|
|
1875
|
+
/** Role identifier. */
|
|
1876
|
+
id?: number;
|
|
1877
|
+
/** Role name. */
|
|
1878
|
+
name?: string | null;
|
|
1879
|
+
}
|
|
1880
|
+
/** DTO, containing results of paged query. */
|
|
1881
|
+
interface PagedOfTenantUserRoleDto {
|
|
1882
|
+
total?: number;
|
|
1883
|
+
items?: TenantUserRoleDto[] | null;
|
|
1884
|
+
}
|
|
1885
|
+
interface FileParameter {
|
|
1886
|
+
data: any;
|
|
1887
|
+
fileName: string;
|
|
1888
|
+
}
|
|
1889
|
+
class ApiException extends Error {
|
|
1890
|
+
message: string;
|
|
1891
|
+
status: number;
|
|
1892
|
+
response: string;
|
|
1893
|
+
headers: {
|
|
1894
|
+
[key: string]: any;
|
|
1895
|
+
};
|
|
1896
|
+
result: any;
|
|
1897
|
+
constructor(message: string, status: number, response: string, headers: {
|
|
1898
|
+
[key: string]: any;
|
|
1899
|
+
}, result: any);
|
|
1900
|
+
protected isApiException: boolean;
|
|
1901
|
+
static isApiException(obj: any): obj is ApiException;
|
|
1902
|
+
}
|
|
1903
|
+
}
|