/
Products.ts
487 lines (465 loc) · 28.2 KB
/
Products.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
import { ListPageWithFacets } from '../models/ListPageWithFacets';
import { Searchable } from '../models/Searchable';
import { Sortable } from '../models/Sortable';
import { Filters } from '../models/Filters';
import { Product } from '../models/Product';
import { SearchType } from '../models/SearchType';
import { ListPage } from '../models/ListPage';
import { Spec } from '../models/Spec';
import { ProductSupplier } from '../models/ProductSupplier';
import { Variant } from '../models/Variant';
import { ProductAssignment } from '../models/ProductAssignment';
import { PartyType } from '../models/PartyType';
import { PartialDeep } from '../models/PartialDeep';
import { RequiredDeep } from '../models/RequiredDeep';
import { RequestOptions } from '../models/RequestOptions';
import http from '../utils/HttpClient';
import OrderCloudError from '../utils/OrderCloudError';
class Products {
private impersonating:boolean = false;
/**
* @ignore
* not part of public api, don't include in generated docs
*/
constructor() {
this.List = this.List.bind(this);
this.Create = this.Create.bind(this);
this.Get = this.Get.bind(this);
this.Save = this.Save.bind(this);
this.Delete = this.Delete.bind(this);
this.Patch = this.Patch.bind(this);
this.DeleteAssignment = this.DeleteAssignment.bind(this);
this.ListSpecs = this.ListSpecs.bind(this);
this.ListSuppliers = this.ListSuppliers.bind(this);
this.SaveSupplier = this.SaveSupplier.bind(this);
this.RemoveSupplier = this.RemoveSupplier.bind(this);
this.ListVariants = this.ListVariants.bind(this);
this.GetVariant = this.GetVariant.bind(this);
this.SaveVariant = this.SaveVariant.bind(this);
this.PatchVariant = this.PatchVariant.bind(this);
this.GenerateVariants = this.GenerateVariants.bind(this);
this.ListAssignments = this.ListAssignments.bind(this);
this.SaveAssignment = this.SaveAssignment.bind(this);
}
/**
* Get a list of products.
* Check out the {@link https://ordercloud.io/api-reference/product-catalogs/products/list|api docs} for more info
*
* @param listOptions.catalogID ID of the catalog.
* @param listOptions.categoryID ID of the category.
* @param listOptions.supplierID ID of the supplier.
* @param listOptions.search Word or phrase to search for.
* @param listOptions.searchOn Comma-delimited list of fields to search on.
* @param listOptions.searchType Type of search to perform. Possible values: AnyTerm (default), AllTermsAnyField, AllTermsSameField, ExactPhrase, ExactPhrasePrefix.
* @param listOptions.sortBy Comma-delimited list of fields to sort by.
* @param listOptions.page Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.
* @param listOptions.pageSize Number of results to return per page. Default: 20, max: 100.
* @param listOptions.filters An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'
* @param requestOptions.accessToken Provide an alternative token to the one stored in the sdk instance (useful for impersonation).
* @param requestOptions.cancelToken Provide an [axios cancelToken](https://github.com/axios/axios#cancellation) that can be used to cancel the request.
* @param requestOptions.requestType Provide a value that can be used to identify the type of request. Useful for error logs.
*/
public async List<TProduct extends Product>(listOptions: { catalogID?: string, categoryID?: string, supplierID?: string, search?: string, searchOn?: Searchable<'Products.List'>, searchType?: SearchType, sortBy?: Sortable<'Products.List'>, page?: number, pageSize?: number, filters?: Filters } = {}, requestOptions: RequestOptions = {} ): Promise<RequiredDeep<ListPageWithFacets<TProduct>>>{
const impersonating = this.impersonating;
this.impersonating = false;
return await http.get(`/products`, { ...requestOptions, impersonating, params: listOptions } )
.catch(ex => {
if(ex.response) {
throw new OrderCloudError(ex)
}
throw ex;
})
}
/**
* Create a new product. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned.
* Check out the {@link https://ordercloud.io/api-reference/product-catalogs/products/create|api docs} for more info
*
* @param product Required fields: Name
* @param requestOptions.accessToken Provide an alternative token to the one stored in the sdk instance (useful for impersonation).
* @param requestOptions.cancelToken Provide an [axios cancelToken](https://github.com/axios/axios#cancellation) that can be used to cancel the request.
* @param requestOptions.requestType Provide a value that can be used to identify the type of request. Useful for error logs.
*/
public async Create<TProduct extends Product>(product: Product,requestOptions: RequestOptions = {} ): Promise<RequiredDeep<TProduct>>{
const impersonating = this.impersonating;
this.impersonating = false;
return await http.post(`/products`, { ...requestOptions, data: product, impersonating, } )
.catch(ex => {
if(ex.response) {
throw new OrderCloudError(ex)
}
throw ex;
})
}
/**
* Get a single product.
* Check out the {@link https://ordercloud.io/api-reference/product-catalogs/products/get|api docs} for more info
*
* @param productID ID of the product.
* @param requestOptions.accessToken Provide an alternative token to the one stored in the sdk instance (useful for impersonation).
* @param requestOptions.cancelToken Provide an [axios cancelToken](https://github.com/axios/axios#cancellation) that can be used to cancel the request.
* @param requestOptions.requestType Provide a value that can be used to identify the type of request. Useful for error logs.
*/
public async Get<TProduct extends Product>(productID: string, requestOptions: RequestOptions = {} ): Promise<RequiredDeep<TProduct>>{
const impersonating = this.impersonating;
this.impersonating = false;
return await http.get(`/products/${productID}`, { ...requestOptions, impersonating, } )
.catch(ex => {
if(ex.response) {
throw new OrderCloudError(ex)
}
throw ex;
})
}
/**
* Create or update a product. If an object with the same ID already exists, it will be overwritten.
* Check out the {@link https://ordercloud.io/api-reference/product-catalogs/products/save|api docs} for more info
*
* @param productID ID of the product.
* @param product Required fields: Name
* @param requestOptions.accessToken Provide an alternative token to the one stored in the sdk instance (useful for impersonation).
* @param requestOptions.cancelToken Provide an [axios cancelToken](https://github.com/axios/axios#cancellation) that can be used to cancel the request.
* @param requestOptions.requestType Provide a value that can be used to identify the type of request. Useful for error logs.
*/
public async Save<TProduct extends Product>(productID: string, product: Product,requestOptions: RequestOptions = {} ): Promise<RequiredDeep<TProduct>>{
const impersonating = this.impersonating;
this.impersonating = false;
return await http.put(`/products/${productID}`, { ...requestOptions, data: product, impersonating, } )
.catch(ex => {
if(ex.response) {
throw new OrderCloudError(ex)
}
throw ex;
})
}
/**
* Delete a product.
* Check out the {@link https://ordercloud.io/api-reference/product-catalogs/products/delete|api docs} for more info
*
* @param productID ID of the product.
* @param requestOptions.accessToken Provide an alternative token to the one stored in the sdk instance (useful for impersonation).
* @param requestOptions.cancelToken Provide an [axios cancelToken](https://github.com/axios/axios#cancellation) that can be used to cancel the request.
* @param requestOptions.requestType Provide a value that can be used to identify the type of request. Useful for error logs.
*/
public async Delete(productID: string, requestOptions: RequestOptions = {} ): Promise<void>{
const impersonating = this.impersonating;
this.impersonating = false;
return await http.delete(`/products/${productID}`, { ...requestOptions, impersonating, } )
.catch(ex => {
if(ex.response) {
throw new OrderCloudError(ex)
}
throw ex;
})
}
/**
* Partially update a product.
* Check out the {@link https://ordercloud.io/api-reference/product-catalogs/products/patch|api docs} for more info
*
* @param productID ID of the product.
* @param product
* @param requestOptions.accessToken Provide an alternative token to the one stored in the sdk instance (useful for impersonation).
* @param requestOptions.cancelToken Provide an [axios cancelToken](https://github.com/axios/axios#cancellation) that can be used to cancel the request.
* @param requestOptions.requestType Provide a value that can be used to identify the type of request. Useful for error logs.
*/
public async Patch<TProduct extends Product>(productID: string, product: PartialDeep<Product>, requestOptions: RequestOptions = {} ): Promise<RequiredDeep<TProduct>>{
const impersonating = this.impersonating;
this.impersonating = false;
return await http.patch(`/products/${productID}`, { ...requestOptions, data: product, impersonating, } )
.catch(ex => {
if(ex.response) {
throw new OrderCloudError(ex)
}
throw ex;
})
}
/**
* Delete a product assignment.
* Check out the {@link https://ordercloud.io/api-reference/product-catalogs/products/delete-assignment|api docs} for more info
*
* @param productID ID of the product.
* @param buyerID ID of the buyer.
* @param listOptions.userID ID of the user.
* @param listOptions.userGroupID ID of the user group.
* @param listOptions.sellerID ID of the seller.
* @param requestOptions.accessToken Provide an alternative token to the one stored in the sdk instance (useful for impersonation).
* @param requestOptions.cancelToken Provide an [axios cancelToken](https://github.com/axios/axios#cancellation) that can be used to cancel the request.
* @param requestOptions.requestType Provide a value that can be used to identify the type of request. Useful for error logs.
*/
public async DeleteAssignment(productID: string, buyerID: string, listOptions: { userID?: string, userGroupID?: string, sellerID?: string } = {}, requestOptions: RequestOptions = {} ): Promise<void>{
const impersonating = this.impersonating;
this.impersonating = false;
return await http.delete(`/products/${productID}/assignments/${buyerID}`, { ...requestOptions, impersonating, params: listOptions } )
.catch(ex => {
if(ex.response) {
throw new OrderCloudError(ex)
}
throw ex;
})
}
/**
* Get a list of product specs.
* Check out the {@link https://ordercloud.io/api-reference/product-catalogs/products/list-specs|api docs} for more info
*
* @param productID ID of the product.
* @param listOptions.search Word or phrase to search for.
* @param listOptions.searchOn Comma-delimited list of fields to search on.
* @param listOptions.sortBy Comma-delimited list of fields to sort by.
* @param listOptions.page Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.
* @param listOptions.pageSize Number of results to return per page. Default: 20, max: 100.
* @param listOptions.filters An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'
* @param requestOptions.accessToken Provide an alternative token to the one stored in the sdk instance (useful for impersonation).
* @param requestOptions.cancelToken Provide an [axios cancelToken](https://github.com/axios/axios#cancellation) that can be used to cancel the request.
* @param requestOptions.requestType Provide a value that can be used to identify the type of request. Useful for error logs.
*/
public async ListSpecs<TSpec extends Spec>(productID: string, listOptions: { search?: string, searchOn?: Searchable<'Products.ListSpecs'>, sortBy?: Sortable<'Products.ListSpecs'>, page?: number, pageSize?: number, filters?: Filters } = {}, requestOptions: RequestOptions = {} ): Promise<RequiredDeep<ListPage<TSpec>>>{
const impersonating = this.impersonating;
this.impersonating = false;
return await http.get(`/products/${productID}/specs`, { ...requestOptions, impersonating, params: listOptions } )
.catch(ex => {
if(ex.response) {
throw new OrderCloudError(ex)
}
throw ex;
})
}
/**
* Get a list of product suppliers.
* Check out the {@link https://ordercloud.io/api-reference/product-catalogs/products/list-suppliers|api docs} for more info
*
* @param productID ID of the product.
* @param listOptions.search Word or phrase to search for.
* @param listOptions.searchOn Comma-delimited list of fields to search on.
* @param listOptions.sortBy Comma-delimited list of fields to sort by.
* @param listOptions.page Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.
* @param listOptions.pageSize Number of results to return per page. Default: 20, max: 100.
* @param listOptions.filters An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'
* @param requestOptions.accessToken Provide an alternative token to the one stored in the sdk instance (useful for impersonation).
* @param requestOptions.cancelToken Provide an [axios cancelToken](https://github.com/axios/axios#cancellation) that can be used to cancel the request.
* @param requestOptions.requestType Provide a value that can be used to identify the type of request. Useful for error logs.
*/
public async ListSuppliers<TProductSupplier extends ProductSupplier>(productID: string, listOptions: { search?: string, searchOn?: Searchable<'Products.ListSuppliers'>, sortBy?: Sortable<'Products.ListSuppliers'>, page?: number, pageSize?: number, filters?: Filters } = {}, requestOptions: RequestOptions = {} ): Promise<RequiredDeep<ListPage<TProductSupplier>>>{
const impersonating = this.impersonating;
this.impersonating = false;
return await http.get(`/products/${productID}/suppliers`, { ...requestOptions, impersonating, params: listOptions } )
.catch(ex => {
if(ex.response) {
throw new OrderCloudError(ex)
}
throw ex;
})
}
/**
* Create or update a product supplier.
* Check out the {@link https://ordercloud.io/api-reference/product-catalogs/products/save-supplier|api docs} for more info
*
* @param productID ID of the product.
* @param supplierID ID of the supplier.
* @param listOptions.defaultPriceScheduleID ID of the default price schedule.
* @param requestOptions.accessToken Provide an alternative token to the one stored in the sdk instance (useful for impersonation).
* @param requestOptions.cancelToken Provide an [axios cancelToken](https://github.com/axios/axios#cancellation) that can be used to cancel the request.
* @param requestOptions.requestType Provide a value that can be used to identify the type of request. Useful for error logs.
*/
public async SaveSupplier(productID: string, supplierID: string, listOptions: { defaultPriceScheduleID?: string } = {}, requestOptions: RequestOptions = {} ): Promise<void>{
const impersonating = this.impersonating;
this.impersonating = false;
return await http.put(`/products/${productID}/suppliers/${supplierID}`, { ...requestOptions, impersonating, params: listOptions } )
.catch(ex => {
if(ex.response) {
throw new OrderCloudError(ex)
}
throw ex;
})
}
/**
* Remove a product supplier.
* Check out the {@link https://ordercloud.io/api-reference/product-catalogs/products/remove-supplier|api docs} for more info
*
* @param productID ID of the product.
* @param supplierID ID of the supplier.
* @param requestOptions.accessToken Provide an alternative token to the one stored in the sdk instance (useful for impersonation).
* @param requestOptions.cancelToken Provide an [axios cancelToken](https://github.com/axios/axios#cancellation) that can be used to cancel the request.
* @param requestOptions.requestType Provide a value that can be used to identify the type of request. Useful for error logs.
*/
public async RemoveSupplier(productID: string, supplierID: string, requestOptions: RequestOptions = {} ): Promise<void>{
const impersonating = this.impersonating;
this.impersonating = false;
return await http.delete(`/products/${productID}/suppliers/${supplierID}`, { ...requestOptions, impersonating, } )
.catch(ex => {
if(ex.response) {
throw new OrderCloudError(ex)
}
throw ex;
})
}
/**
* Get a list of product variants.
* Check out the {@link https://ordercloud.io/api-reference/product-catalogs/products/list-variants|api docs} for more info
*
* @param productID ID of the product.
* @param listOptions.search Word or phrase to search for.
* @param listOptions.searchOn Comma-delimited list of fields to search on.
* @param listOptions.sortBy Comma-delimited list of fields to sort by.
* @param listOptions.page Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.
* @param listOptions.pageSize Number of results to return per page. Default: 20, max: 100.
* @param listOptions.filters An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'
* @param requestOptions.accessToken Provide an alternative token to the one stored in the sdk instance (useful for impersonation).
* @param requestOptions.cancelToken Provide an [axios cancelToken](https://github.com/axios/axios#cancellation) that can be used to cancel the request.
* @param requestOptions.requestType Provide a value that can be used to identify the type of request. Useful for error logs.
*/
public async ListVariants<TVariant extends Variant>(productID: string, listOptions: { search?: string, searchOn?: Searchable<'Products.ListVariants'>, sortBy?: Sortable<'Products.ListVariants'>, page?: number, pageSize?: number, filters?: Filters } = {}, requestOptions: RequestOptions = {} ): Promise<RequiredDeep<ListPage<TVariant>>>{
const impersonating = this.impersonating;
this.impersonating = false;
return await http.get(`/products/${productID}/variants`, { ...requestOptions, impersonating, params: listOptions } )
.catch(ex => {
if(ex.response) {
throw new OrderCloudError(ex)
}
throw ex;
})
}
/**
* Get a single product variant.
* Check out the {@link https://ordercloud.io/api-reference/product-catalogs/products/get-variant|api docs} for more info
*
* @param productID ID of the product.
* @param variantID ID of the variant.
* @param requestOptions.accessToken Provide an alternative token to the one stored in the sdk instance (useful for impersonation).
* @param requestOptions.cancelToken Provide an [axios cancelToken](https://github.com/axios/axios#cancellation) that can be used to cancel the request.
* @param requestOptions.requestType Provide a value that can be used to identify the type of request. Useful for error logs.
*/
public async GetVariant<TVariant extends Variant>(productID: string, variantID: string, requestOptions: RequestOptions = {} ): Promise<RequiredDeep<TVariant>>{
const impersonating = this.impersonating;
this.impersonating = false;
return await http.get(`/products/${productID}/variants/${variantID}`, { ...requestOptions, impersonating, } )
.catch(ex => {
if(ex.response) {
throw new OrderCloudError(ex)
}
throw ex;
})
}
/**
* Update a product variant. Update a product variant.
* Check out the {@link https://ordercloud.io/api-reference/product-catalogs/products/save-variant|api docs} for more info
*
* @param productID ID of the product.
* @param variantID ID of the variant.
* @param variant
* @param requestOptions.accessToken Provide an alternative token to the one stored in the sdk instance (useful for impersonation).
* @param requestOptions.cancelToken Provide an [axios cancelToken](https://github.com/axios/axios#cancellation) that can be used to cancel the request.
* @param requestOptions.requestType Provide a value that can be used to identify the type of request. Useful for error logs.
*/
public async SaveVariant<TVariant extends Variant>(productID: string, variantID: string, variant: Variant,requestOptions: RequestOptions = {} ): Promise<RequiredDeep<TVariant>>{
const impersonating = this.impersonating;
this.impersonating = false;
return await http.put(`/products/${productID}/variants/${variantID}`, { ...requestOptions, data: variant, impersonating, } )
.catch(ex => {
if(ex.response) {
throw new OrderCloudError(ex)
}
throw ex;
})
}
/**
* Partially update a product variant.
* Check out the {@link https://ordercloud.io/api-reference/product-catalogs/products/patch-variant|api docs} for more info
*
* @param productID ID of the product.
* @param variantID ID of the variant.
* @param variant
* @param requestOptions.accessToken Provide an alternative token to the one stored in the sdk instance (useful for impersonation).
* @param requestOptions.cancelToken Provide an [axios cancelToken](https://github.com/axios/axios#cancellation) that can be used to cancel the request.
* @param requestOptions.requestType Provide a value that can be used to identify the type of request. Useful for error logs.
*/
public async PatchVariant<TVariant extends Variant>(productID: string, variantID: string, variant: PartialDeep<Variant>, requestOptions: RequestOptions = {} ): Promise<RequiredDeep<TVariant>>{
const impersonating = this.impersonating;
this.impersonating = false;
return await http.patch(`/products/${productID}/variants/${variantID}`, { ...requestOptions, data: variant, impersonating, } )
.catch(ex => {
if(ex.response) {
throw new OrderCloudError(ex)
}
throw ex;
})
}
/**
* Generate variants.
* Check out the {@link https://ordercloud.io/api-reference/product-catalogs/products/generate-variants|api docs} for more info
*
* @param productID ID of the product.
* @param listOptions.overwriteExisting Overwrite existing of the product.
* @param requestOptions.accessToken Provide an alternative token to the one stored in the sdk instance (useful for impersonation).
* @param requestOptions.cancelToken Provide an [axios cancelToken](https://github.com/axios/axios#cancellation) that can be used to cancel the request.
* @param requestOptions.requestType Provide a value that can be used to identify the type of request. Useful for error logs.
*/
public async GenerateVariants<TProduct extends Product>(productID: string, listOptions: { overwriteExisting?: boolean } = {}, requestOptions: RequestOptions = {} ): Promise<RequiredDeep<TProduct>>{
const impersonating = this.impersonating;
this.impersonating = false;
return await http.post(`/products/${productID}/variants/generate`, { ...requestOptions, impersonating, params: listOptions } )
.catch(ex => {
if(ex.response) {
throw new OrderCloudError(ex)
}
throw ex;
})
}
/**
* Get a list of product assignments.
* Check out the {@link https://ordercloud.io/api-reference/product-catalogs/products/list-assignments|api docs} for more info
*
* @param listOptions.productID ID of the product.
* @param listOptions.priceScheduleID ID of the price schedule.
* @param listOptions.buyerID ID of the buyer.
* @param listOptions.userID ID of the user.
* @param listOptions.userGroupID ID of the user group.
* @param listOptions.level Level of the product assignment. Possible values: User, Group, Company.
* @param listOptions.page Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.
* @param listOptions.pageSize Number of results to return per page. Default: 20, max: 100.
* @param requestOptions.accessToken Provide an alternative token to the one stored in the sdk instance (useful for impersonation).
* @param requestOptions.cancelToken Provide an [axios cancelToken](https://github.com/axios/axios#cancellation) that can be used to cancel the request.
* @param requestOptions.requestType Provide a value that can be used to identify the type of request. Useful for error logs.
*/
public async ListAssignments<TProductAssignment extends ProductAssignment>(listOptions: { productID?: string, priceScheduleID?: string, buyerID?: string, userID?: string, userGroupID?: string, level?: PartyType, page?: number, pageSize?: number } = {}, requestOptions: RequestOptions = {} ): Promise<RequiredDeep<ListPage<TProductAssignment>>>{
const impersonating = this.impersonating;
this.impersonating = false;
return await http.get(`/products/assignments`, { ...requestOptions, impersonating, params: listOptions } )
.catch(ex => {
if(ex.response) {
throw new OrderCloudError(ex)
}
throw ex;
})
}
/**
* Create or update a product assignment.
* Check out the {@link https://ordercloud.io/api-reference/product-catalogs/products/save-assignment|api docs} for more info
*
* @param productAssignment Required fields: ProductID, BuyerID
* @param requestOptions.accessToken Provide an alternative token to the one stored in the sdk instance (useful for impersonation).
* @param requestOptions.cancelToken Provide an [axios cancelToken](https://github.com/axios/axios#cancellation) that can be used to cancel the request.
* @param requestOptions.requestType Provide a value that can be used to identify the type of request. Useful for error logs.
*/
public async SaveAssignment(productAssignment: ProductAssignment,requestOptions: RequestOptions = {} ): Promise<void>{
const impersonating = this.impersonating;
this.impersonating = false;
return await http.post(`/products/assignments`, { ...requestOptions, data: productAssignment, impersonating, } )
.catch(ex => {
if(ex.response) {
throw new OrderCloudError(ex)
}
throw ex;
})
}
/**
* @description
* enables impersonation by calling the subsequent method with the stored impersonation token
*
* @example
* Products.As().List() // lists Products using the impersonated users' token
*/
public As(): this {
this.impersonating = true;
return this;
}
}
export default new Products();