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