@aurigma/axios-storefront-api-client 2.2.1038
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 +104 -0
- package/dist/cjs/storefront-api-client.d.ts +967 -0
- package/dist/cjs/storefront-api-client.js +2568 -0
- package/dist/cjs/storefront-api-client.js.map +1 -0
- package/dist/esm/storefront-api-client.d.ts +967 -0
- package/dist/esm/storefront-api-client.js +2555 -0
- package/dist/esm/storefront-api-client.js.map +1 -0
- package/package.json +35 -0
|
@@ -0,0 +1,967 @@
|
|
|
1
|
+
/// <reference types="node" />
|
|
2
|
+
import { AxiosInstance, AxiosRequestConfig, AxiosResponse, CancelToken } from 'axios';
|
|
3
|
+
export declare class ApiClientConfiguration {
|
|
4
|
+
apiUrl: string;
|
|
5
|
+
apiKey: string;
|
|
6
|
+
private authorizationToken;
|
|
7
|
+
getAuthorizationToken(): Promise<string>;
|
|
8
|
+
setAuthorizationToken(token: string): void;
|
|
9
|
+
}
|
|
10
|
+
export declare 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
|
+
export interface IBuildInfoApiClient {
|
|
18
|
+
/**
|
|
19
|
+
* Gets assembly build info
|
|
20
|
+
* @return Success
|
|
21
|
+
*/
|
|
22
|
+
headInfo(): Promise<void>;
|
|
23
|
+
/**
|
|
24
|
+
* Gets assembly build info
|
|
25
|
+
* @return Success
|
|
26
|
+
*/
|
|
27
|
+
getInfo(): Promise<BuildInfoModel>;
|
|
28
|
+
}
|
|
29
|
+
export declare 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
|
+
* Gets assembly build info
|
|
36
|
+
* @return Success
|
|
37
|
+
*/
|
|
38
|
+
headInfo(cancelToken?: CancelToken | undefined): Promise<void>;
|
|
39
|
+
protected processHeadInfo(response: AxiosResponse): Promise<void>;
|
|
40
|
+
/**
|
|
41
|
+
* Gets assembly build info
|
|
42
|
+
* @return Success
|
|
43
|
+
*/
|
|
44
|
+
getInfo(cancelToken?: CancelToken | undefined): Promise<BuildInfoModel>;
|
|
45
|
+
protected processGetInfo(response: AxiosResponse): Promise<BuildInfoModel>;
|
|
46
|
+
}
|
|
47
|
+
export interface IProductReferencesApiClient {
|
|
48
|
+
/**
|
|
49
|
+
* Gets all storefront product references relevant to specified query parameters
|
|
50
|
+
* @param storefrontId Storefront identifier
|
|
51
|
+
* @param productReference (optional) Product reference filter. Product reference is an external reference to Customer's Canvas product specification, e.g online store product identifier
|
|
52
|
+
* @param productSpecificationId (optional) Cusomer's Canvas product specification filter
|
|
53
|
+
* @param skip (optional) Defines page start offset from beginning of sorted result list
|
|
54
|
+
* @param take (optional) Defines page length (how much consequent items of sorted result list should be taken)
|
|
55
|
+
* @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC"
|
|
56
|
+
* @param search (optional) Search string for partial match
|
|
57
|
+
* @param tenantId (optional) Tenant identifier
|
|
58
|
+
* @param userId (optional) User identifier
|
|
59
|
+
* @return Success
|
|
60
|
+
*/
|
|
61
|
+
getAll(storefrontId: number, productReference?: string | null | undefined, productSpecificationId?: number | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, tenantId?: number | null | undefined, userId?: number | null | undefined): Promise<PagedOfProductReferenceDto>;
|
|
62
|
+
/**
|
|
63
|
+
* Creates new storefront product reference
|
|
64
|
+
* @param storefrontId Storefront identifier
|
|
65
|
+
* @param tenantId (optional) Tenant identifier
|
|
66
|
+
* @param userId (optional) User identifier
|
|
67
|
+
* @param body (optional) Create operation parameters
|
|
68
|
+
* @return Success
|
|
69
|
+
*/
|
|
70
|
+
create(storefrontId: number, tenantId?: number | null | undefined, userId?: number | null | undefined, body?: CreateProductReferenceDto | undefined): Promise<ProductReferenceDto>;
|
|
71
|
+
/**
|
|
72
|
+
* Gets storefront product reference
|
|
73
|
+
* @param reference Product reference - external reference to Customer's Canvas product specification, e.g online store product identifier
|
|
74
|
+
* @param storefrontId Storefront identifier
|
|
75
|
+
* @param tenantId (optional) Tenant identifier
|
|
76
|
+
* @param userId (optional) User identifier
|
|
77
|
+
* @return Success
|
|
78
|
+
*/
|
|
79
|
+
get(reference: string | null, storefrontId: number, tenantId?: number | null | undefined, userId?: number | null | undefined): Promise<ProductReferenceDto>;
|
|
80
|
+
/**
|
|
81
|
+
* Deletes storefront product reference
|
|
82
|
+
* @param reference Product reference - external reference to Customer's Canvas product specification, e.g online store product identifier
|
|
83
|
+
* @param storefrontId Storefront identifier
|
|
84
|
+
* @param tenantId (optional) Tenant identifier
|
|
85
|
+
* @param userId (optional) User identifier
|
|
86
|
+
* @return Success
|
|
87
|
+
*/
|
|
88
|
+
delete(reference: string | null, storefrontId: number, tenantId?: number | null | undefined, userId?: number | null | undefined): Promise<ProductReferenceDto>;
|
|
89
|
+
/**
|
|
90
|
+
* Gets product specification by storefront product reference
|
|
91
|
+
* @param reference Product reference - external reference to Customer's Canvas product specification, e.g online store product identifier
|
|
92
|
+
* @param storefrontId Storefront identifier
|
|
93
|
+
* @param tenantId (optional) Tenant identifier
|
|
94
|
+
* @param userId (optional) User identifier
|
|
95
|
+
* @return Success
|
|
96
|
+
*/
|
|
97
|
+
getProductSpecification(reference: string | null, storefrontId: number, tenantId?: number | null | undefined, userId?: number | null | undefined): Promise<ProductSpecificationDto>;
|
|
98
|
+
/**
|
|
99
|
+
* Gets product configuration information by storefront product reference
|
|
100
|
+
* @param reference Product reference - external reference to Customer's Canvas product specification, e.g online store product identifier
|
|
101
|
+
* @param storefrontId Storefront identifier
|
|
102
|
+
* @param tenantId (optional) Tenant identifier
|
|
103
|
+
* @param userId (optional) User identifier
|
|
104
|
+
* @return Success
|
|
105
|
+
*/
|
|
106
|
+
getProductConfig(reference: string | null, storefrontId: number, tenantId?: number | null | undefined, userId?: number | null | undefined): Promise<ProductReferenceDto>;
|
|
107
|
+
}
|
|
108
|
+
export declare class ProductReferencesApiClient extends ApiClientBase implements IProductReferencesApiClient {
|
|
109
|
+
private instance;
|
|
110
|
+
private baseUrl;
|
|
111
|
+
protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
|
|
112
|
+
constructor(configuration: ApiClientConfiguration, baseUrl?: string, instance?: AxiosInstance);
|
|
113
|
+
/**
|
|
114
|
+
* Gets all storefront product references relevant to specified query parameters
|
|
115
|
+
* @param storefrontId Storefront identifier
|
|
116
|
+
* @param productReference (optional) Product reference filter. Product reference is an external reference to Customer's Canvas product specification, e.g online store product identifier
|
|
117
|
+
* @param productSpecificationId (optional) Cusomer's Canvas product specification filter
|
|
118
|
+
* @param skip (optional) Defines page start offset from beginning of sorted result list
|
|
119
|
+
* @param take (optional) Defines page length (how much consequent items of sorted result list should be taken)
|
|
120
|
+
* @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC"
|
|
121
|
+
* @param search (optional) Search string for partial match
|
|
122
|
+
* @param tenantId (optional) Tenant identifier
|
|
123
|
+
* @param userId (optional) User identifier
|
|
124
|
+
* @return Success
|
|
125
|
+
*/
|
|
126
|
+
getAll(storefrontId: number, productReference?: string | null | undefined, productSpecificationId?: number | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, tenantId?: number | null | undefined, userId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfProductReferenceDto>;
|
|
127
|
+
protected processGetAll(response: AxiosResponse): Promise<PagedOfProductReferenceDto>;
|
|
128
|
+
/**
|
|
129
|
+
* Creates new storefront product reference
|
|
130
|
+
* @param storefrontId Storefront identifier
|
|
131
|
+
* @param tenantId (optional) Tenant identifier
|
|
132
|
+
* @param userId (optional) User identifier
|
|
133
|
+
* @param body (optional) Create operation parameters
|
|
134
|
+
* @return Success
|
|
135
|
+
*/
|
|
136
|
+
create(storefrontId: number, tenantId?: number | null | undefined, userId?: number | null | undefined, body?: CreateProductReferenceDto | undefined, cancelToken?: CancelToken | undefined): Promise<ProductReferenceDto>;
|
|
137
|
+
protected processCreate(response: AxiosResponse): Promise<ProductReferenceDto>;
|
|
138
|
+
/**
|
|
139
|
+
* Gets storefront product reference
|
|
140
|
+
* @param reference Product reference - external reference to Customer's Canvas product specification, e.g online store product identifier
|
|
141
|
+
* @param storefrontId Storefront identifier
|
|
142
|
+
* @param tenantId (optional) Tenant identifier
|
|
143
|
+
* @param userId (optional) User identifier
|
|
144
|
+
* @return Success
|
|
145
|
+
*/
|
|
146
|
+
get(reference: string | null, storefrontId: number, tenantId?: number | null | undefined, userId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProductReferenceDto>;
|
|
147
|
+
protected processGet(response: AxiosResponse): Promise<ProductReferenceDto>;
|
|
148
|
+
/**
|
|
149
|
+
* Deletes storefront product reference
|
|
150
|
+
* @param reference Product reference - external reference to Customer's Canvas product specification, e.g online store product identifier
|
|
151
|
+
* @param storefrontId Storefront identifier
|
|
152
|
+
* @param tenantId (optional) Tenant identifier
|
|
153
|
+
* @param userId (optional) User identifier
|
|
154
|
+
* @return Success
|
|
155
|
+
*/
|
|
156
|
+
delete(reference: string | null, storefrontId: number, tenantId?: number | null | undefined, userId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProductReferenceDto>;
|
|
157
|
+
protected processDelete(response: AxiosResponse): Promise<ProductReferenceDto>;
|
|
158
|
+
/**
|
|
159
|
+
* Gets product specification by storefront product reference
|
|
160
|
+
* @param reference Product reference - external reference to Customer's Canvas product specification, e.g online store product identifier
|
|
161
|
+
* @param storefrontId Storefront identifier
|
|
162
|
+
* @param tenantId (optional) Tenant identifier
|
|
163
|
+
* @param userId (optional) User identifier
|
|
164
|
+
* @return Success
|
|
165
|
+
*/
|
|
166
|
+
getProductSpecification(reference: string | null, storefrontId: number, tenantId?: number | null | undefined, userId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProductSpecificationDto>;
|
|
167
|
+
protected processGetProductSpecification(response: AxiosResponse): Promise<ProductSpecificationDto>;
|
|
168
|
+
/**
|
|
169
|
+
* Gets product configuration information by storefront product reference
|
|
170
|
+
* @param reference Product reference - external reference to Customer's Canvas product specification, e.g online store product identifier
|
|
171
|
+
* @param storefrontId Storefront identifier
|
|
172
|
+
* @param tenantId (optional) Tenant identifier
|
|
173
|
+
* @param userId (optional) User identifier
|
|
174
|
+
* @return Success
|
|
175
|
+
*/
|
|
176
|
+
getProductConfig(reference: string | null, storefrontId: number, tenantId?: number | null | undefined, userId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProductReferenceDto>;
|
|
177
|
+
protected processGetProductConfig(response: AxiosResponse): Promise<ProductReferenceDto>;
|
|
178
|
+
}
|
|
179
|
+
export interface IProductSpecificationsApiClient {
|
|
180
|
+
/**
|
|
181
|
+
* Gets all product specifications relevant to specified query parameters
|
|
182
|
+
* @param skip (optional) Defines page start offset from beginning of sorted result list
|
|
183
|
+
* @param take (optional) Defines page length (how much consequent items of sorted result list should be taken)
|
|
184
|
+
* @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC"
|
|
185
|
+
* @param search (optional) Search string for partial match
|
|
186
|
+
* @param tenantId (optional) Tenant identifier
|
|
187
|
+
* @param userId (optional) User identifier
|
|
188
|
+
* @return Success
|
|
189
|
+
*/
|
|
190
|
+
getAll(skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, tenantId?: number | null | undefined, userId?: number | null | undefined): Promise<PagedOfProductSpecificationDto>;
|
|
191
|
+
/**
|
|
192
|
+
* Gets product specification by id
|
|
193
|
+
* @param id Product specification identifier
|
|
194
|
+
* @param tenantId (optional) Tenant identifier
|
|
195
|
+
* @param userId (optional) User identifier
|
|
196
|
+
* @return Success
|
|
197
|
+
*/
|
|
198
|
+
get(id: number, tenantId?: number | null | undefined, userId?: number | null | undefined): Promise<ProductSpecificationDto>;
|
|
199
|
+
/**
|
|
200
|
+
* Gets product configuration description by product specification id
|
|
201
|
+
* @param id Product specification identifier
|
|
202
|
+
* @param tenantId (optional) Tenant identifier
|
|
203
|
+
* @param userId (optional) User identifier
|
|
204
|
+
* @return Success
|
|
205
|
+
*/
|
|
206
|
+
getConfiguration(id: number, tenantId?: number | null | undefined, userId?: number | null | undefined): Promise<string>;
|
|
207
|
+
}
|
|
208
|
+
export declare class ProductSpecificationsApiClient extends ApiClientBase implements IProductSpecificationsApiClient {
|
|
209
|
+
private instance;
|
|
210
|
+
private baseUrl;
|
|
211
|
+
protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
|
|
212
|
+
constructor(configuration: ApiClientConfiguration, baseUrl?: string, instance?: AxiosInstance);
|
|
213
|
+
/**
|
|
214
|
+
* Gets all product specifications relevant to specified query parameters
|
|
215
|
+
* @param skip (optional) Defines page start offset from beginning of sorted result list
|
|
216
|
+
* @param take (optional) Defines page length (how much consequent items of sorted result list should be taken)
|
|
217
|
+
* @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC"
|
|
218
|
+
* @param search (optional) Search string for partial match
|
|
219
|
+
* @param tenantId (optional) Tenant identifier
|
|
220
|
+
* @param userId (optional) User identifier
|
|
221
|
+
* @return Success
|
|
222
|
+
*/
|
|
223
|
+
getAll(skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, tenantId?: number | null | undefined, userId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfProductSpecificationDto>;
|
|
224
|
+
protected processGetAll(response: AxiosResponse): Promise<PagedOfProductSpecificationDto>;
|
|
225
|
+
/**
|
|
226
|
+
* Gets product specification by id
|
|
227
|
+
* @param id Product specification identifier
|
|
228
|
+
* @param tenantId (optional) Tenant identifier
|
|
229
|
+
* @param userId (optional) User identifier
|
|
230
|
+
* @return Success
|
|
231
|
+
*/
|
|
232
|
+
get(id: number, tenantId?: number | null | undefined, userId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProductSpecificationDto>;
|
|
233
|
+
protected processGet(response: AxiosResponse): Promise<ProductSpecificationDto>;
|
|
234
|
+
/**
|
|
235
|
+
* Gets product configuration description by product specification id
|
|
236
|
+
* @param id Product specification identifier
|
|
237
|
+
* @param tenantId (optional) Tenant identifier
|
|
238
|
+
* @param userId (optional) User identifier
|
|
239
|
+
* @return Success
|
|
240
|
+
*/
|
|
241
|
+
getConfiguration(id: number, tenantId?: number | null | undefined, userId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<string>;
|
|
242
|
+
protected processGetConfiguration(response: AxiosResponse): Promise<string>;
|
|
243
|
+
}
|
|
244
|
+
export interface IProjectsApiClient {
|
|
245
|
+
/**
|
|
246
|
+
* Gets all projects relevant to specified query parameters
|
|
247
|
+
* @param storefrontId Storefront identifier
|
|
248
|
+
* @param status (optional) Project status filter
|
|
249
|
+
* @param datePeriod (optional) Project date period filter
|
|
250
|
+
* @param skip (optional) Defines page start offset from beginning of sorted result list
|
|
251
|
+
* @param take (optional) Defines page length (how much consequent items of sorted result list should be taken)
|
|
252
|
+
* @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC"
|
|
253
|
+
* @param search (optional) Search string for partial match
|
|
254
|
+
* @param tenantId (optional) Tenant identifier
|
|
255
|
+
* @param userId (optional) User identifier
|
|
256
|
+
* @return Success
|
|
257
|
+
*/
|
|
258
|
+
getAll(storefrontId: number, status?: number | null | undefined, datePeriod?: DatePeriod | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, tenantId?: number | null | undefined, userId?: number | null | undefined): Promise<PagedOfProjectDto>;
|
|
259
|
+
/**
|
|
260
|
+
* Creates new project
|
|
261
|
+
* @param storefrontId Storefront identifier
|
|
262
|
+
* @param tenantId (optional) Tenant identifier
|
|
263
|
+
* @param userId (optional) User identifier
|
|
264
|
+
* @param body (optional) Create operation parameters
|
|
265
|
+
* @return Success
|
|
266
|
+
*/
|
|
267
|
+
create(storefrontId: number, tenantId?: number | null | undefined, userId?: number | null | undefined, body?: CreateProjectDto | undefined): Promise<ProjectDto>;
|
|
268
|
+
/**
|
|
269
|
+
* Gets project by id
|
|
270
|
+
* @param id Project identifier
|
|
271
|
+
* @param tenantId (optional) Tenant identifier
|
|
272
|
+
* @param userId (optional) User identifier
|
|
273
|
+
* @return Success
|
|
274
|
+
*/
|
|
275
|
+
get(id: number, tenantId?: number | null | undefined, userId?: number | null | undefined): Promise<ProjectDto>;
|
|
276
|
+
/**
|
|
277
|
+
* Gets available project transitions
|
|
278
|
+
* @param id Project identifier
|
|
279
|
+
* @param tenantId (optional) Tenant identifier
|
|
280
|
+
* @param userId (optional) User identifier
|
|
281
|
+
* @return Success
|
|
282
|
+
*/
|
|
283
|
+
getAvailableTransitions(id: number, tenantId?: number | null | undefined, userId?: number | null | undefined): Promise<PagedOfProjectTransitionDto>;
|
|
284
|
+
/**
|
|
285
|
+
* Changes project status
|
|
286
|
+
* @param id Project identifier
|
|
287
|
+
* @param transition Transition identifying name
|
|
288
|
+
* @param tenantId (optional) Tenant identifier
|
|
289
|
+
* @param userId (optional) User identifier
|
|
290
|
+
* @return Success
|
|
291
|
+
*/
|
|
292
|
+
changeStatus(id: number, transition: string | null, tenantId?: number | null | undefined, userId?: number | null | undefined): Promise<ProjectStatusDto>;
|
|
293
|
+
/**
|
|
294
|
+
* Force changes project status
|
|
295
|
+
* @param id Project identifier
|
|
296
|
+
* @param status Project status code
|
|
297
|
+
* @param tenantId (optional) Tenant identifier
|
|
298
|
+
* @param userId (optional) User identifier
|
|
299
|
+
* @return Success
|
|
300
|
+
*/
|
|
301
|
+
forceStatus(id: number, status: number, tenantId?: number | null | undefined, userId?: number | null | undefined): Promise<ProjectStatusDto>;
|
|
302
|
+
/**
|
|
303
|
+
* Gets all project statuses
|
|
304
|
+
* @param tenantId (optional) Tenant identifier
|
|
305
|
+
* @param userId (optional) User identifier
|
|
306
|
+
* @return Success
|
|
307
|
+
*/
|
|
308
|
+
getAllStatuses(tenantId?: number | null | undefined, userId?: number | null | undefined): Promise<PagedOfProjectStatusDto>;
|
|
309
|
+
/**
|
|
310
|
+
* Gets all project transitions
|
|
311
|
+
* @param tenantId (optional) Tenant identifier
|
|
312
|
+
* @param userId (optional) User identifier
|
|
313
|
+
* @return Success
|
|
314
|
+
*/
|
|
315
|
+
getAllTransitions(tenantId?: number | null | undefined, userId?: number | null | undefined): Promise<PagedOfProjectTransitionDto>;
|
|
316
|
+
/**
|
|
317
|
+
* Gets project pdf url
|
|
318
|
+
* @param id Project unique identifier
|
|
319
|
+
* @param designUserId User identifier
|
|
320
|
+
* @param designId Design identifier
|
|
321
|
+
* @param tenantId (optional) Tenant identifier
|
|
322
|
+
* @param userId (optional) User identifier
|
|
323
|
+
* @return Success
|
|
324
|
+
*/
|
|
325
|
+
getProjectPdfUrl(id: number, designUserId: string, designId: string, tenantId?: number | null | undefined, userId?: number | null | undefined): Promise<ProjectPdfResultDto>;
|
|
326
|
+
/**
|
|
327
|
+
* Gets project pdf files in zip archive
|
|
328
|
+
* @param id Project unique identifier
|
|
329
|
+
* @param designUserId User identifier
|
|
330
|
+
* @param designId Design identifier
|
|
331
|
+
* @param attachment (optional) If set to 'true', file will be provided as an attachment with proper filename supplied (default value is 'false')
|
|
332
|
+
* @param tenantId (optional) Tenant identifier
|
|
333
|
+
* @param userId (optional) User identifier
|
|
334
|
+
* @return Success
|
|
335
|
+
*/
|
|
336
|
+
getProjectPdfZip(id: number, designUserId: string, designId: string, attachment?: boolean | null | undefined, tenantId?: number | null | undefined, userId?: number | null | undefined): Promise<FileResponse>;
|
|
337
|
+
/**
|
|
338
|
+
* Gets project order data from ecommerce system
|
|
339
|
+
* @param id Project identifier
|
|
340
|
+
* @return Success
|
|
341
|
+
*/
|
|
342
|
+
getProjectOrder(id: number): Promise<any>;
|
|
343
|
+
}
|
|
344
|
+
export declare class ProjectsApiClient extends ApiClientBase implements IProjectsApiClient {
|
|
345
|
+
private instance;
|
|
346
|
+
private baseUrl;
|
|
347
|
+
protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
|
|
348
|
+
constructor(configuration: ApiClientConfiguration, baseUrl?: string, instance?: AxiosInstance);
|
|
349
|
+
/**
|
|
350
|
+
* Gets all projects relevant to specified query parameters
|
|
351
|
+
* @param storefrontId Storefront identifier
|
|
352
|
+
* @param status (optional) Project status filter
|
|
353
|
+
* @param datePeriod (optional) Project date period filter
|
|
354
|
+
* @param skip (optional) Defines page start offset from beginning of sorted result list
|
|
355
|
+
* @param take (optional) Defines page length (how much consequent items of sorted result list should be taken)
|
|
356
|
+
* @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC"
|
|
357
|
+
* @param search (optional) Search string for partial match
|
|
358
|
+
* @param tenantId (optional) Tenant identifier
|
|
359
|
+
* @param userId (optional) User identifier
|
|
360
|
+
* @return Success
|
|
361
|
+
*/
|
|
362
|
+
getAll(storefrontId: number, status?: number | null | undefined, datePeriod?: DatePeriod | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, tenantId?: number | null | undefined, userId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfProjectDto>;
|
|
363
|
+
protected processGetAll(response: AxiosResponse): Promise<PagedOfProjectDto>;
|
|
364
|
+
/**
|
|
365
|
+
* Creates new project
|
|
366
|
+
* @param storefrontId Storefront identifier
|
|
367
|
+
* @param tenantId (optional) Tenant identifier
|
|
368
|
+
* @param userId (optional) User identifier
|
|
369
|
+
* @param body (optional) Create operation parameters
|
|
370
|
+
* @return Success
|
|
371
|
+
*/
|
|
372
|
+
create(storefrontId: number, tenantId?: number | null | undefined, userId?: number | null | undefined, body?: CreateProjectDto | undefined, cancelToken?: CancelToken | undefined): Promise<ProjectDto>;
|
|
373
|
+
protected processCreate(response: AxiosResponse): Promise<ProjectDto>;
|
|
374
|
+
/**
|
|
375
|
+
* Gets project by id
|
|
376
|
+
* @param id Project identifier
|
|
377
|
+
* @param tenantId (optional) Tenant identifier
|
|
378
|
+
* @param userId (optional) User identifier
|
|
379
|
+
* @return Success
|
|
380
|
+
*/
|
|
381
|
+
get(id: number, tenantId?: number | null | undefined, userId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProjectDto>;
|
|
382
|
+
protected processGet(response: AxiosResponse): Promise<ProjectDto>;
|
|
383
|
+
/**
|
|
384
|
+
* Gets available project transitions
|
|
385
|
+
* @param id Project identifier
|
|
386
|
+
* @param tenantId (optional) Tenant identifier
|
|
387
|
+
* @param userId (optional) User identifier
|
|
388
|
+
* @return Success
|
|
389
|
+
*/
|
|
390
|
+
getAvailableTransitions(id: number, tenantId?: number | null | undefined, userId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfProjectTransitionDto>;
|
|
391
|
+
protected processGetAvailableTransitions(response: AxiosResponse): Promise<PagedOfProjectTransitionDto>;
|
|
392
|
+
/**
|
|
393
|
+
* Changes project status
|
|
394
|
+
* @param id Project identifier
|
|
395
|
+
* @param transition Transition identifying name
|
|
396
|
+
* @param tenantId (optional) Tenant identifier
|
|
397
|
+
* @param userId (optional) User identifier
|
|
398
|
+
* @return Success
|
|
399
|
+
*/
|
|
400
|
+
changeStatus(id: number, transition: string | null, tenantId?: number | null | undefined, userId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProjectStatusDto>;
|
|
401
|
+
protected processChangeStatus(response: AxiosResponse): Promise<ProjectStatusDto>;
|
|
402
|
+
/**
|
|
403
|
+
* Force changes project status
|
|
404
|
+
* @param id Project identifier
|
|
405
|
+
* @param status Project status code
|
|
406
|
+
* @param tenantId (optional) Tenant identifier
|
|
407
|
+
* @param userId (optional) User identifier
|
|
408
|
+
* @return Success
|
|
409
|
+
*/
|
|
410
|
+
forceStatus(id: number, status: number, tenantId?: number | null | undefined, userId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProjectStatusDto>;
|
|
411
|
+
protected processForceStatus(response: AxiosResponse): Promise<ProjectStatusDto>;
|
|
412
|
+
/**
|
|
413
|
+
* Gets all project statuses
|
|
414
|
+
* @param tenantId (optional) Tenant identifier
|
|
415
|
+
* @param userId (optional) User identifier
|
|
416
|
+
* @return Success
|
|
417
|
+
*/
|
|
418
|
+
getAllStatuses(tenantId?: number | null | undefined, userId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfProjectStatusDto>;
|
|
419
|
+
protected processGetAllStatuses(response: AxiosResponse): Promise<PagedOfProjectStatusDto>;
|
|
420
|
+
/**
|
|
421
|
+
* Gets all project transitions
|
|
422
|
+
* @param tenantId (optional) Tenant identifier
|
|
423
|
+
* @param userId (optional) User identifier
|
|
424
|
+
* @return Success
|
|
425
|
+
*/
|
|
426
|
+
getAllTransitions(tenantId?: number | null | undefined, userId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfProjectTransitionDto>;
|
|
427
|
+
protected processGetAllTransitions(response: AxiosResponse): Promise<PagedOfProjectTransitionDto>;
|
|
428
|
+
/**
|
|
429
|
+
* Gets project pdf url
|
|
430
|
+
* @param id Project unique identifier
|
|
431
|
+
* @param designUserId User identifier
|
|
432
|
+
* @param designId Design identifier
|
|
433
|
+
* @param tenantId (optional) Tenant identifier
|
|
434
|
+
* @param userId (optional) User identifier
|
|
435
|
+
* @return Success
|
|
436
|
+
*/
|
|
437
|
+
getProjectPdfUrl(id: number, designUserId: string, designId: string, tenantId?: number | null | undefined, userId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProjectPdfResultDto>;
|
|
438
|
+
protected processGetProjectPdfUrl(response: AxiosResponse): Promise<ProjectPdfResultDto>;
|
|
439
|
+
/**
|
|
440
|
+
* Gets project pdf files in zip archive
|
|
441
|
+
* @param id Project unique identifier
|
|
442
|
+
* @param designUserId User identifier
|
|
443
|
+
* @param designId Design identifier
|
|
444
|
+
* @param attachment (optional) If set to 'true', file will be provided as an attachment with proper filename supplied (default value is 'false')
|
|
445
|
+
* @param tenantId (optional) Tenant identifier
|
|
446
|
+
* @param userId (optional) User identifier
|
|
447
|
+
* @return Success
|
|
448
|
+
*/
|
|
449
|
+
getProjectPdfZip(id: number, designUserId: string, designId: string, attachment?: boolean | null | undefined, tenantId?: number | null | undefined, userId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<FileResponse>;
|
|
450
|
+
protected processGetProjectPdfZip(response: AxiosResponse): Promise<FileResponse>;
|
|
451
|
+
/**
|
|
452
|
+
* Gets project order data from ecommerce system
|
|
453
|
+
* @param id Project identifier
|
|
454
|
+
* @return Success
|
|
455
|
+
*/
|
|
456
|
+
getProjectOrder(id: number, cancelToken?: CancelToken | undefined): Promise<any>;
|
|
457
|
+
protected processGetProjectOrder(response: AxiosResponse): Promise<any>;
|
|
458
|
+
}
|
|
459
|
+
export interface IStorefrontsApiClient {
|
|
460
|
+
/**
|
|
461
|
+
* Gets all storefronts relevant to specified query parameters
|
|
462
|
+
* @param types (optional) Storefront type filter
|
|
463
|
+
* @param skip (optional) Defines page start offset from beginning of sorted result list
|
|
464
|
+
* @param take (optional) Defines page length (how much consequent items of sorted result list should be taken)
|
|
465
|
+
* @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC"
|
|
466
|
+
* @param search (optional) Search string for partial match
|
|
467
|
+
* @param tenantId (optional) Tenant identifier
|
|
468
|
+
* @param userId (optional) User identifier
|
|
469
|
+
* @return Success
|
|
470
|
+
*/
|
|
471
|
+
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, userId?: number | null | undefined): Promise<PagedOfStorefrontDto>;
|
|
472
|
+
/**
|
|
473
|
+
* Gets storefront
|
|
474
|
+
* @param id Storefront identifier
|
|
475
|
+
* @param tenantId (optional) Tenant identifier
|
|
476
|
+
* @param userId (optional) User identifier
|
|
477
|
+
* @return Success
|
|
478
|
+
*/
|
|
479
|
+
get(id: number, tenantId?: number | null | undefined, userId?: number | null | undefined): Promise<StorefrontDto>;
|
|
480
|
+
}
|
|
481
|
+
export declare class StorefrontsApiClient extends ApiClientBase implements IStorefrontsApiClient {
|
|
482
|
+
private instance;
|
|
483
|
+
private baseUrl;
|
|
484
|
+
protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
|
|
485
|
+
constructor(configuration: ApiClientConfiguration, baseUrl?: string, instance?: AxiosInstance);
|
|
486
|
+
/**
|
|
487
|
+
* Gets all storefronts relevant to specified query parameters
|
|
488
|
+
* @param types (optional) Storefront type filter
|
|
489
|
+
* @param skip (optional) Defines page start offset from beginning of sorted result list
|
|
490
|
+
* @param take (optional) Defines page length (how much consequent items of sorted result list should be taken)
|
|
491
|
+
* @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC"
|
|
492
|
+
* @param search (optional) Search string for partial match
|
|
493
|
+
* @param tenantId (optional) Tenant identifier
|
|
494
|
+
* @param userId (optional) User identifier
|
|
495
|
+
* @return Success
|
|
496
|
+
*/
|
|
497
|
+
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, userId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfStorefrontDto>;
|
|
498
|
+
protected processGetAll(response: AxiosResponse): Promise<PagedOfStorefrontDto>;
|
|
499
|
+
/**
|
|
500
|
+
* Gets storefront
|
|
501
|
+
* @param id Storefront identifier
|
|
502
|
+
* @param tenantId (optional) Tenant identifier
|
|
503
|
+
* @param userId (optional) User identifier
|
|
504
|
+
* @return Success
|
|
505
|
+
*/
|
|
506
|
+
get(id: number, tenantId?: number | null | undefined, userId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<StorefrontDto>;
|
|
507
|
+
protected processGet(response: AxiosResponse): Promise<StorefrontDto>;
|
|
508
|
+
}
|
|
509
|
+
export interface IStorefrontUsersApiClient {
|
|
510
|
+
/**
|
|
511
|
+
* Gets all storefront users relevant to specified query parameters
|
|
512
|
+
* @param storefrontId Storefront identifier
|
|
513
|
+
* @param storefrontUserId (optional) Storefront user identifier
|
|
514
|
+
* @param skip (optional) Defines page start offset from beginning of sorted result list
|
|
515
|
+
* @param take (optional) Defines page length (how much consequent items of sorted result list should be taken)
|
|
516
|
+
* @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC"
|
|
517
|
+
* @param search (optional) Search string for partial match
|
|
518
|
+
* @param tenantId (optional) Tenant identifier
|
|
519
|
+
* @param userId (optional) User identifier
|
|
520
|
+
* @return Success
|
|
521
|
+
*/
|
|
522
|
+
getAll(storefrontId: number, storefrontUserId?: string | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, tenantId?: number | null | undefined, userId?: number | null | undefined): Promise<PagedOfStorefrontUserDto>;
|
|
523
|
+
/**
|
|
524
|
+
* Creates new storefront user
|
|
525
|
+
* @param storefrontId Storefront identifier
|
|
526
|
+
* @param tenantId (optional) Tenant identifier
|
|
527
|
+
* @param userId (optional) User identifier
|
|
528
|
+
* @param body (optional) Create operation parameters
|
|
529
|
+
* @return Success
|
|
530
|
+
*/
|
|
531
|
+
create(storefrontId: number, tenantId?: number | null | undefined, userId?: number | null | undefined, body?: CreateStorefrontUserDto | undefined): Promise<StorefrontUserDto>;
|
|
532
|
+
/**
|
|
533
|
+
* Gets storefront user by id
|
|
534
|
+
* @param id Storefront user identifier
|
|
535
|
+
* @param storefrontId Storefront identifier
|
|
536
|
+
* @param tenantId (optional) Tenant identifier
|
|
537
|
+
* @param userId (optional) User identifier
|
|
538
|
+
* @return Success
|
|
539
|
+
*/
|
|
540
|
+
get(id: string | null, storefrontId: number, tenantId?: number | null | undefined, userId?: number | null | undefined): Promise<StorefrontUserDto>;
|
|
541
|
+
/**
|
|
542
|
+
* Merges anonymous storefront user data to regular storefront user account
|
|
543
|
+
* @param storefrontId Storefront identifier
|
|
544
|
+
* @param tenantId (optional) Tenant identifier
|
|
545
|
+
* @param userId (optional) User identifier
|
|
546
|
+
* @param body (optional) Merge operation parameters
|
|
547
|
+
* @return Success
|
|
548
|
+
*/
|
|
549
|
+
mergeAnonymous(storefrontId: number, tenantId?: number | null | undefined, userId?: number | null | undefined, body?: MergeAnonymousUserDataInput | undefined): Promise<void>;
|
|
550
|
+
/**
|
|
551
|
+
* Gets storefront user token
|
|
552
|
+
* @param storefrontUserId Storefront user identifier
|
|
553
|
+
* @param storefrontId Storefront identifier
|
|
554
|
+
* @param tenantId (optional) Tenant identifier
|
|
555
|
+
* @param userId (optional) User identifier
|
|
556
|
+
* @return Success
|
|
557
|
+
*/
|
|
558
|
+
getToken(storefrontUserId: string, storefrontId: number, tenantId?: number | null | undefined, userId?: number | null | undefined): Promise<void>;
|
|
559
|
+
}
|
|
560
|
+
export declare class StorefrontUsersApiClient extends ApiClientBase implements IStorefrontUsersApiClient {
|
|
561
|
+
private instance;
|
|
562
|
+
private baseUrl;
|
|
563
|
+
protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
|
|
564
|
+
constructor(configuration: ApiClientConfiguration, baseUrl?: string, instance?: AxiosInstance);
|
|
565
|
+
/**
|
|
566
|
+
* Gets all storefront users relevant to specified query parameters
|
|
567
|
+
* @param storefrontId Storefront identifier
|
|
568
|
+
* @param storefrontUserId (optional) Storefront user identifier
|
|
569
|
+
* @param skip (optional) Defines page start offset from beginning of sorted result list
|
|
570
|
+
* @param take (optional) Defines page length (how much consequent items of sorted result list should be taken)
|
|
571
|
+
* @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC"
|
|
572
|
+
* @param search (optional) Search string for partial match
|
|
573
|
+
* @param tenantId (optional) Tenant identifier
|
|
574
|
+
* @param userId (optional) User identifier
|
|
575
|
+
* @return Success
|
|
576
|
+
*/
|
|
577
|
+
getAll(storefrontId: number, storefrontUserId?: string | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, tenantId?: number | null | undefined, userId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfStorefrontUserDto>;
|
|
578
|
+
protected processGetAll(response: AxiosResponse): Promise<PagedOfStorefrontUserDto>;
|
|
579
|
+
/**
|
|
580
|
+
* Creates new storefront user
|
|
581
|
+
* @param storefrontId Storefront identifier
|
|
582
|
+
* @param tenantId (optional) Tenant identifier
|
|
583
|
+
* @param userId (optional) User identifier
|
|
584
|
+
* @param body (optional) Create operation parameters
|
|
585
|
+
* @return Success
|
|
586
|
+
*/
|
|
587
|
+
create(storefrontId: number, tenantId?: number | null | undefined, userId?: number | null | undefined, body?: CreateStorefrontUserDto | undefined, cancelToken?: CancelToken | undefined): Promise<StorefrontUserDto>;
|
|
588
|
+
protected processCreate(response: AxiosResponse): Promise<StorefrontUserDto>;
|
|
589
|
+
/**
|
|
590
|
+
* Gets storefront user by id
|
|
591
|
+
* @param id Storefront user identifier
|
|
592
|
+
* @param storefrontId Storefront identifier
|
|
593
|
+
* @param tenantId (optional) Tenant identifier
|
|
594
|
+
* @param userId (optional) User identifier
|
|
595
|
+
* @return Success
|
|
596
|
+
*/
|
|
597
|
+
get(id: string | null, storefrontId: number, tenantId?: number | null | undefined, userId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<StorefrontUserDto>;
|
|
598
|
+
protected processGet(response: AxiosResponse): Promise<StorefrontUserDto>;
|
|
599
|
+
/**
|
|
600
|
+
* Merges anonymous storefront user data to regular storefront user account
|
|
601
|
+
* @param storefrontId Storefront identifier
|
|
602
|
+
* @param tenantId (optional) Tenant identifier
|
|
603
|
+
* @param userId (optional) User identifier
|
|
604
|
+
* @param body (optional) Merge operation parameters
|
|
605
|
+
* @return Success
|
|
606
|
+
*/
|
|
607
|
+
mergeAnonymous(storefrontId: number, tenantId?: number | null | undefined, userId?: number | null | undefined, body?: MergeAnonymousUserDataInput | undefined, cancelToken?: CancelToken | undefined): Promise<void>;
|
|
608
|
+
protected processMergeAnonymous(response: AxiosResponse): Promise<void>;
|
|
609
|
+
/**
|
|
610
|
+
* Gets storefront user token
|
|
611
|
+
* @param storefrontUserId Storefront user identifier
|
|
612
|
+
* @param storefrontId Storefront identifier
|
|
613
|
+
* @param tenantId (optional) Tenant identifier
|
|
614
|
+
* @param userId (optional) User identifier
|
|
615
|
+
* @return Success
|
|
616
|
+
*/
|
|
617
|
+
getToken(storefrontUserId: string, storefrontId: number, tenantId?: number | null | undefined, userId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<void>;
|
|
618
|
+
protected processGetToken(response: AxiosResponse): Promise<void>;
|
|
619
|
+
}
|
|
620
|
+
export interface ITenantInfoApiClient {
|
|
621
|
+
/**
|
|
622
|
+
* Gets information about tenant applications
|
|
623
|
+
* @param tenantId (optional) Tenant identifier
|
|
624
|
+
* @param userId (optional) User identifier
|
|
625
|
+
* @return Success
|
|
626
|
+
*/
|
|
627
|
+
getApplicationsInfo(tenantId?: number | null | undefined, userId?: number | null | undefined): Promise<TenantApplicationsInfoDto>;
|
|
628
|
+
/**
|
|
629
|
+
* Gets information about tenant
|
|
630
|
+
* @param tenantId (optional) Tenant identifier
|
|
631
|
+
* @param userId (optional) User identifier
|
|
632
|
+
* @return Success
|
|
633
|
+
*/
|
|
634
|
+
getInfo(tenantId?: number | null | undefined, userId?: number | null | undefined): Promise<TenantInfoDto>;
|
|
635
|
+
}
|
|
636
|
+
export declare class TenantInfoApiClient extends ApiClientBase implements ITenantInfoApiClient {
|
|
637
|
+
private instance;
|
|
638
|
+
private baseUrl;
|
|
639
|
+
protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
|
|
640
|
+
constructor(configuration: ApiClientConfiguration, baseUrl?: string, instance?: AxiosInstance);
|
|
641
|
+
/**
|
|
642
|
+
* Gets information about tenant applications
|
|
643
|
+
* @param tenantId (optional) Tenant identifier
|
|
644
|
+
* @param userId (optional) User identifier
|
|
645
|
+
* @return Success
|
|
646
|
+
*/
|
|
647
|
+
getApplicationsInfo(tenantId?: number | null | undefined, userId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<TenantApplicationsInfoDto>;
|
|
648
|
+
protected processGetApplicationsInfo(response: AxiosResponse): Promise<TenantApplicationsInfoDto>;
|
|
649
|
+
/**
|
|
650
|
+
* Gets information about tenant
|
|
651
|
+
* @param tenantId (optional) Tenant identifier
|
|
652
|
+
* @param userId (optional) User identifier
|
|
653
|
+
* @return Success
|
|
654
|
+
*/
|
|
655
|
+
getInfo(tenantId?: number | null | undefined, userId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<TenantInfoDto>;
|
|
656
|
+
protected processGetInfo(response: AxiosResponse): Promise<TenantInfoDto>;
|
|
657
|
+
}
|
|
658
|
+
/** Information about a service */
|
|
659
|
+
export interface BuildInfoModel {
|
|
660
|
+
/** Version number */
|
|
661
|
+
version?: string | null;
|
|
662
|
+
/** Build date (UTC) */
|
|
663
|
+
buildDate?: string | null;
|
|
664
|
+
/** Build configuration (Debug | Release) */
|
|
665
|
+
configuration?: string | null;
|
|
666
|
+
/** Service name */
|
|
667
|
+
appName?: string | null;
|
|
668
|
+
}
|
|
669
|
+
/** Storefront product reference dto class */
|
|
670
|
+
export interface ProductReferenceDto {
|
|
671
|
+
/** Product reference is an external reference to Customer's Canvas product specification, e.g online store product identifier */
|
|
672
|
+
productReference?: string | null;
|
|
673
|
+
/** Customer's Canvas product specification identifier */
|
|
674
|
+
productSpecificationId?: number;
|
|
675
|
+
/** Storefront identifier */
|
|
676
|
+
storefrontId?: number;
|
|
677
|
+
/** Tenant identifier */
|
|
678
|
+
tenantId?: number;
|
|
679
|
+
/** Storefront product reference creation date and time */
|
|
680
|
+
created?: string;
|
|
681
|
+
}
|
|
682
|
+
/** Paged list of items */
|
|
683
|
+
export interface PagedOfProductReferenceDto {
|
|
684
|
+
/** Items count */
|
|
685
|
+
total?: number;
|
|
686
|
+
/** Items list */
|
|
687
|
+
items?: ProductReferenceDto[] | null;
|
|
688
|
+
}
|
|
689
|
+
/** Dto class, containing create operation parameters for storefront product reference */
|
|
690
|
+
export interface CreateProductReferenceDto {
|
|
691
|
+
/** Product reference is an external reference to Customer's Canvas product specification, e.g online store product identifier */
|
|
692
|
+
productReference: string;
|
|
693
|
+
/** Customer's Canvas product specification identifier */
|
|
694
|
+
productSpecificationId: number;
|
|
695
|
+
}
|
|
696
|
+
export interface ProblemDetails {
|
|
697
|
+
type?: string | null;
|
|
698
|
+
title?: string | null;
|
|
699
|
+
status?: number | null;
|
|
700
|
+
detail?: string | null;
|
|
701
|
+
instance?: string | null;
|
|
702
|
+
}
|
|
703
|
+
/** Product attribute dto class */
|
|
704
|
+
export interface ProductAttributeDto {
|
|
705
|
+
/** Product attribute name */
|
|
706
|
+
name?: string | null;
|
|
707
|
+
/** Product attribute type */
|
|
708
|
+
type?: string | null;
|
|
709
|
+
/** Product attribute value */
|
|
710
|
+
value?: any | null;
|
|
711
|
+
}
|
|
712
|
+
/** Product specification dto class */
|
|
713
|
+
export interface ProductSpecificationDto {
|
|
714
|
+
/** Product specification identifier */
|
|
715
|
+
id?: number;
|
|
716
|
+
/** Tenant identifier */
|
|
717
|
+
tenantId?: number;
|
|
718
|
+
/** Product specification name */
|
|
719
|
+
name?: string | null;
|
|
720
|
+
/** List of product attributes */
|
|
721
|
+
productAttributes?: ProductAttributeDto[] | null;
|
|
722
|
+
/** Product specification creation time */
|
|
723
|
+
created?: string;
|
|
724
|
+
/** Product specification modification time */
|
|
725
|
+
lastModified?: string | null;
|
|
726
|
+
}
|
|
727
|
+
/** Paged list of items */
|
|
728
|
+
export interface PagedOfProductSpecificationDto {
|
|
729
|
+
/** Items count */
|
|
730
|
+
total?: number;
|
|
731
|
+
/** Items list */
|
|
732
|
+
items?: ProductSpecificationDto[] | null;
|
|
733
|
+
}
|
|
734
|
+
/** Available date period filter values for queries */
|
|
735
|
+
export declare enum DatePeriod {
|
|
736
|
+
All = "All",
|
|
737
|
+
Today = "Today",
|
|
738
|
+
Last7Days = "Last7Days",
|
|
739
|
+
Last30Days = "Last30Days"
|
|
740
|
+
}
|
|
741
|
+
/** Project item dto class */
|
|
742
|
+
export interface ProjectItemDto {
|
|
743
|
+
/** Item name */
|
|
744
|
+
name?: string | null;
|
|
745
|
+
/** Item quantity information */
|
|
746
|
+
quantity?: number | null;
|
|
747
|
+
/** Item information */
|
|
748
|
+
fields?: {
|
|
749
|
+
[key: string]: any;
|
|
750
|
+
} | null;
|
|
751
|
+
/** Additional item information */
|
|
752
|
+
hidden?: any | null;
|
|
753
|
+
/** List of item associated design identifiers */
|
|
754
|
+
designIds?: string[] | null;
|
|
755
|
+
/** SKU */
|
|
756
|
+
sku?: string | null;
|
|
757
|
+
}
|
|
758
|
+
/** Project dto class */
|
|
759
|
+
export interface ProjectDto {
|
|
760
|
+
/** Project identifier */
|
|
761
|
+
id?: number;
|
|
762
|
+
/** Storefront identifier */
|
|
763
|
+
storefrontId?: number;
|
|
764
|
+
/** Project tenant indentifier */
|
|
765
|
+
tenantId?: number;
|
|
766
|
+
/** Order identifier in ecommerce system */
|
|
767
|
+
orderId?: string | null;
|
|
768
|
+
/** Order url in ecommerce system */
|
|
769
|
+
orderUrl?: string | null;
|
|
770
|
+
/** Order number in ecommerce system */
|
|
771
|
+
orderNumber?: number | null;
|
|
772
|
+
/** Line item ID from external ecommerce system order. */
|
|
773
|
+
orderLineItemId?: string | null;
|
|
774
|
+
/** Line item index from external ecommerce system order. */
|
|
775
|
+
orderLineItemIndex?: number | null;
|
|
776
|
+
/** Customer identifier in ecommerce system */
|
|
777
|
+
customerId?: string | null;
|
|
778
|
+
/** Customer name in ecommerce system */
|
|
779
|
+
customerName?: string | null;
|
|
780
|
+
/** Project name */
|
|
781
|
+
name?: string | null;
|
|
782
|
+
/** Project owner identifier */
|
|
783
|
+
ownerId?: string | null;
|
|
784
|
+
/** List of project items */
|
|
785
|
+
items?: ProjectItemDto[] | null;
|
|
786
|
+
/** Project status code */
|
|
787
|
+
status?: number;
|
|
788
|
+
/** Project creation time */
|
|
789
|
+
created?: string;
|
|
790
|
+
/** Project modification time */
|
|
791
|
+
lastModified?: string | null;
|
|
792
|
+
/** Description of the project */
|
|
793
|
+
description?: string | null;
|
|
794
|
+
}
|
|
795
|
+
/** Paged list of items */
|
|
796
|
+
export interface PagedOfProjectDto {
|
|
797
|
+
/** Items count */
|
|
798
|
+
total?: number;
|
|
799
|
+
/** Items list */
|
|
800
|
+
items?: ProjectDto[] | null;
|
|
801
|
+
}
|
|
802
|
+
/** Dto class, containing create operation parameters for project entity */
|
|
803
|
+
export interface CreateProjectDto {
|
|
804
|
+
/** Product reference (i.e external reference to Customer's Canvas product specification - main subject of this project) */
|
|
805
|
+
productReference: string;
|
|
806
|
+
/** Order identifier in ecommerce system */
|
|
807
|
+
orderId?: string | null;
|
|
808
|
+
/** Order url in ecommerce system */
|
|
809
|
+
orderUrl?: string | null;
|
|
810
|
+
/** Order number in ecommerce system */
|
|
811
|
+
orderNumber?: number | null;
|
|
812
|
+
/** Line item index from ecommerce system order */
|
|
813
|
+
orderLineItemIndex?: number | null;
|
|
814
|
+
/** Line Item id from ecommerce system order */
|
|
815
|
+
orderLineItemId?: string | null;
|
|
816
|
+
/** Customer identifier in ecommerce system */
|
|
817
|
+
customerId?: string | null;
|
|
818
|
+
/** Customer name in ecommerce system */
|
|
819
|
+
customerName?: string | null;
|
|
820
|
+
/** Project name */
|
|
821
|
+
name?: string | null;
|
|
822
|
+
/** Project owner identifier */
|
|
823
|
+
ownerId?: string | null;
|
|
824
|
+
/** List of project items */
|
|
825
|
+
items?: ProjectItemDto[] | null;
|
|
826
|
+
/** Description of the project */
|
|
827
|
+
description?: string | null;
|
|
828
|
+
}
|
|
829
|
+
/** Project transition dto class */
|
|
830
|
+
export interface ProjectTransitionDto {
|
|
831
|
+
/** Transition identifying name */
|
|
832
|
+
name?: string | null;
|
|
833
|
+
/** Transition display name */
|
|
834
|
+
displayName?: string | null;
|
|
835
|
+
/** Project status code from which transition to the result status code can be done */
|
|
836
|
+
startStatus?: number;
|
|
837
|
+
/** Transition result project status code */
|
|
838
|
+
resultStatus?: number;
|
|
839
|
+
}
|
|
840
|
+
/** Paged list of items */
|
|
841
|
+
export interface PagedOfProjectTransitionDto {
|
|
842
|
+
/** Items count */
|
|
843
|
+
total?: number;
|
|
844
|
+
/** Items list */
|
|
845
|
+
items?: ProjectTransitionDto[] | null;
|
|
846
|
+
}
|
|
847
|
+
/** Information about project transition conflict */
|
|
848
|
+
export interface ProjectTransitionConflictDto {
|
|
849
|
+
/** List of available project transitions */
|
|
850
|
+
availableTransitions?: ProjectTransitionDto[] | null;
|
|
851
|
+
}
|
|
852
|
+
/** Project status dto class */
|
|
853
|
+
export interface ProjectStatusDto {
|
|
854
|
+
/** Status code */
|
|
855
|
+
code?: number;
|
|
856
|
+
/** Status display name */
|
|
857
|
+
displayName?: string | null;
|
|
858
|
+
}
|
|
859
|
+
/** Paged list of items */
|
|
860
|
+
export interface PagedOfProjectStatusDto {
|
|
861
|
+
/** Items count */
|
|
862
|
+
total?: number;
|
|
863
|
+
/** Items list */
|
|
864
|
+
items?: ProjectStatusDto[] | null;
|
|
865
|
+
}
|
|
866
|
+
/** Dto class, containing result of get project pdf url operation */
|
|
867
|
+
export interface ProjectPdfResultDto {
|
|
868
|
+
/** Project pdf url */
|
|
869
|
+
url?: string | null;
|
|
870
|
+
}
|
|
871
|
+
/** Storefront types */
|
|
872
|
+
export declare enum StorefrontType {
|
|
873
|
+
Custom = "Custom",
|
|
874
|
+
Shopify = "Shopify",
|
|
875
|
+
DocketManager = "DocketManager",
|
|
876
|
+
Auth0Saml = "Auth0Saml"
|
|
877
|
+
}
|
|
878
|
+
/** Storefront dto class */
|
|
879
|
+
export interface StorefrontDto {
|
|
880
|
+
/** Storefront identifier */
|
|
881
|
+
id?: number;
|
|
882
|
+
/** Tenant identifier */
|
|
883
|
+
tenantId?: number;
|
|
884
|
+
/** Storefront name */
|
|
885
|
+
name?: string | null;
|
|
886
|
+
type?: StorefrontType;
|
|
887
|
+
/** Storefront entity creation date and time */
|
|
888
|
+
created?: string;
|
|
889
|
+
}
|
|
890
|
+
/** Paged list of items */
|
|
891
|
+
export interface PagedOfStorefrontDto {
|
|
892
|
+
/** Items count */
|
|
893
|
+
total?: number;
|
|
894
|
+
/** Items list */
|
|
895
|
+
items?: StorefrontDto[] | null;
|
|
896
|
+
}
|
|
897
|
+
/** Storefront user dto class */
|
|
898
|
+
export interface StorefrontUserDto {
|
|
899
|
+
/** Storefront user identifier */
|
|
900
|
+
userId?: string | null;
|
|
901
|
+
/** Storefront tenant indentifier */
|
|
902
|
+
tenantId?: number;
|
|
903
|
+
/** Storefront identifier */
|
|
904
|
+
storefrontId?: number | null;
|
|
905
|
+
/** Indicates whether user is an anonymous */
|
|
906
|
+
isAnonymous?: boolean;
|
|
907
|
+
}
|
|
908
|
+
/** Paged list of items */
|
|
909
|
+
export interface PagedOfStorefrontUserDto {
|
|
910
|
+
/** Items count */
|
|
911
|
+
total?: number;
|
|
912
|
+
/** Items list */
|
|
913
|
+
items?: StorefrontUserDto[] | null;
|
|
914
|
+
}
|
|
915
|
+
/** Dto class, containing create operation parameters for storefront user entity */
|
|
916
|
+
export interface CreateStorefrontUserDto {
|
|
917
|
+
/** Storefront user identifier */
|
|
918
|
+
storefrontUserId?: string | null;
|
|
919
|
+
/** Indicates whether user is an anonymous */
|
|
920
|
+
isAnonymous?: boolean;
|
|
921
|
+
}
|
|
922
|
+
/** Dto class, containing parameters for merge anonymous user operation */
|
|
923
|
+
export interface MergeAnonymousUserDataInput {
|
|
924
|
+
/** Anonymous storefront user identifier */
|
|
925
|
+
anonymousStorefrontUserId?: string | null;
|
|
926
|
+
/** Regular storefront user identifier */
|
|
927
|
+
regularStorefrontUserId?: string | null;
|
|
928
|
+
}
|
|
929
|
+
/** Dto class, containing information about tenant applications */
|
|
930
|
+
export interface TenantApplicationsInfoDto {
|
|
931
|
+
designEditorUrl?: string | null;
|
|
932
|
+
uiFrameworkUrl?: string | null;
|
|
933
|
+
preflightUrl?: string | null;
|
|
934
|
+
dynamicImageUrl?: string | null;
|
|
935
|
+
tenantId?: number;
|
|
936
|
+
}
|
|
937
|
+
/** Dto class, containing information about tenant */
|
|
938
|
+
export interface TenantInfoDto {
|
|
939
|
+
/** Tenant identifier */
|
|
940
|
+
tenantId?: number;
|
|
941
|
+
/** Tenancy name */
|
|
942
|
+
tenancyName?: string | null;
|
|
943
|
+
/** Tenant creation time */
|
|
944
|
+
tenantCreationTime?: string;
|
|
945
|
+
}
|
|
946
|
+
export interface FileResponse {
|
|
947
|
+
data: Blob;
|
|
948
|
+
status: number;
|
|
949
|
+
fileName?: string;
|
|
950
|
+
headers?: {
|
|
951
|
+
[name: string]: any;
|
|
952
|
+
};
|
|
953
|
+
}
|
|
954
|
+
export declare class ApiException extends Error {
|
|
955
|
+
message: string;
|
|
956
|
+
status: number;
|
|
957
|
+
response: string;
|
|
958
|
+
headers: {
|
|
959
|
+
[key: string]: any;
|
|
960
|
+
};
|
|
961
|
+
result: any;
|
|
962
|
+
constructor(message: string, status: number, response: string, headers: {
|
|
963
|
+
[key: string]: any;
|
|
964
|
+
}, result: any);
|
|
965
|
+
protected isApiException: boolean;
|
|
966
|
+
static isApiException(obj: any): obj is ApiException;
|
|
967
|
+
}
|