@aurigma/ng-storefront-api-client 2.2.53

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