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