@emilgroup/commission-sdk-node 1.0.0-beta.6 → 1.0.0-beta.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md
CHANGED
|
@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
|
|
|
17
17
|
Navigate to the folder of your consuming project and run one of the following commands:
|
|
18
18
|
|
|
19
19
|
```
|
|
20
|
-
npm install @emilgroup/commission-sdk-node@1.0.0-beta.
|
|
20
|
+
npm install @emilgroup/commission-sdk-node@1.0.0-beta.7 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/commission-sdk-node@1.0.0-beta.
|
|
24
|
+
yarn add @emilgroup/commission-sdk-node@1.0.0-beta.7
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import `CommissionApi`.
|
|
@@ -92,15 +92,15 @@ export const CommissionRecipientsApiAxiosParamCreator = function (configuration?
|
|
|
92
92
|
/**
|
|
93
93
|
* This will delete commission recipient.
|
|
94
94
|
* @summary Delete the commission recipient
|
|
95
|
-
* @param {
|
|
95
|
+
* @param {string} code Unique identifier for the object.
|
|
96
96
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
97
97
|
* @param {*} [options] Override http request option.
|
|
98
98
|
* @throws {RequiredError}
|
|
99
99
|
*/
|
|
100
|
-
deleteCommissionRecipient: async (code:
|
|
100
|
+
deleteCommissionRecipient: async (code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
101
101
|
// verify required parameter 'code' is not null or undefined
|
|
102
102
|
assertParamExists('deleteCommissionRecipient', 'code', code)
|
|
103
|
-
const localVarPath = `/commissionservice/v1/commission-recipients`
|
|
103
|
+
const localVarPath = `/commissionservice/v1/commission-recipients/{code}`
|
|
104
104
|
.replace(`{${"code"}}`, encodeURIComponent(String(code)));
|
|
105
105
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
106
106
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -187,17 +187,20 @@ export const CommissionRecipientsApiAxiosParamCreator = function (configuration?
|
|
|
187
187
|
};
|
|
188
188
|
},
|
|
189
189
|
/**
|
|
190
|
-
* Retrieves a list of
|
|
190
|
+
* Retrieves a list of commission recipients.
|
|
191
191
|
* @summary List commission recipients
|
|
192
192
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
193
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
194
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
193
195
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, displayName, partnerCode, status, createdAt</i>
|
|
194
|
-
* @param {string} [
|
|
196
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
195
197
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: createdAt</i>
|
|
196
198
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
199
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, displayName, partnerCode, status, createdAt</i>
|
|
197
200
|
* @param {*} [options] Override http request option.
|
|
198
201
|
* @throws {RequiredError}
|
|
199
202
|
*/
|
|
200
|
-
listCommissionRecipients: async (authorization?: string, filter?: string,
|
|
203
|
+
listCommissionRecipients: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
201
204
|
const localVarPath = `/commissionservice/v1/commission-recipients`;
|
|
202
205
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
203
206
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -216,12 +219,20 @@ export const CommissionRecipientsApiAxiosParamCreator = function (configuration?
|
|
|
216
219
|
// http bearer authentication required
|
|
217
220
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
218
221
|
|
|
222
|
+
if (pageSize !== undefined) {
|
|
223
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
224
|
+
}
|
|
225
|
+
|
|
226
|
+
if (pageToken !== undefined) {
|
|
227
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
228
|
+
}
|
|
229
|
+
|
|
219
230
|
if (filter !== undefined) {
|
|
220
231
|
localVarQueryParameter['filter'] = filter;
|
|
221
232
|
}
|
|
222
233
|
|
|
223
|
-
if (
|
|
224
|
-
localVarQueryParameter['
|
|
234
|
+
if (search !== undefined) {
|
|
235
|
+
localVarQueryParameter['search'] = search;
|
|
225
236
|
}
|
|
226
237
|
|
|
227
238
|
if (order !== undefined) {
|
|
@@ -232,6 +243,10 @@ export const CommissionRecipientsApiAxiosParamCreator = function (configuration?
|
|
|
232
243
|
localVarQueryParameter['expand'] = expand;
|
|
233
244
|
}
|
|
234
245
|
|
|
246
|
+
if (filters !== undefined) {
|
|
247
|
+
localVarQueryParameter['filters'] = filters;
|
|
248
|
+
}
|
|
249
|
+
|
|
235
250
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
236
251
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
237
252
|
}
|
|
@@ -250,15 +265,19 @@ export const CommissionRecipientsApiAxiosParamCreator = function (configuration?
|
|
|
250
265
|
/**
|
|
251
266
|
* This will update commission recipient.
|
|
252
267
|
* @summary Update the commission recipient
|
|
268
|
+
* @param {string} code
|
|
253
269
|
* @param {UpdateCommissionRecipientRequestDto} updateCommissionRecipientRequestDto
|
|
254
270
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
255
271
|
* @param {*} [options] Override http request option.
|
|
256
272
|
* @throws {RequiredError}
|
|
257
273
|
*/
|
|
258
|
-
updateCommissionRecipient: async (updateCommissionRecipientRequestDto: UpdateCommissionRecipientRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
274
|
+
updateCommissionRecipient: async (code: string, updateCommissionRecipientRequestDto: UpdateCommissionRecipientRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
275
|
+
// verify required parameter 'code' is not null or undefined
|
|
276
|
+
assertParamExists('updateCommissionRecipient', 'code', code)
|
|
259
277
|
// verify required parameter 'updateCommissionRecipientRequestDto' is not null or undefined
|
|
260
278
|
assertParamExists('updateCommissionRecipient', 'updateCommissionRecipientRequestDto', updateCommissionRecipientRequestDto)
|
|
261
|
-
const localVarPath = `/commissionservice/v1/commission-recipients
|
|
279
|
+
const localVarPath = `/commissionservice/v1/commission-recipients/{code}`
|
|
280
|
+
.replace(`{${"code"}}`, encodeURIComponent(String(code)));
|
|
262
281
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
263
282
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
264
283
|
let baseOptions;
|
|
@@ -319,12 +338,12 @@ export const CommissionRecipientsApiFp = function(configuration?: Configuration)
|
|
|
319
338
|
/**
|
|
320
339
|
* This will delete commission recipient.
|
|
321
340
|
* @summary Delete the commission recipient
|
|
322
|
-
* @param {
|
|
341
|
+
* @param {string} code Unique identifier for the object.
|
|
323
342
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
324
343
|
* @param {*} [options] Override http request option.
|
|
325
344
|
* @throws {RequiredError}
|
|
326
345
|
*/
|
|
327
|
-
async deleteCommissionRecipient(code:
|
|
346
|
+
async deleteCommissionRecipient(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
328
347
|
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteCommissionRecipient(code, authorization, options);
|
|
329
348
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
330
349
|
},
|
|
@@ -342,30 +361,34 @@ export const CommissionRecipientsApiFp = function(configuration?: Configuration)
|
|
|
342
361
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
343
362
|
},
|
|
344
363
|
/**
|
|
345
|
-
* Retrieves a list of
|
|
364
|
+
* Retrieves a list of commission recipients.
|
|
346
365
|
* @summary List commission recipients
|
|
347
366
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
367
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
368
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
348
369
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, displayName, partnerCode, status, createdAt</i>
|
|
349
|
-
* @param {string} [
|
|
370
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
350
371
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: createdAt</i>
|
|
351
372
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
373
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, displayName, partnerCode, status, createdAt</i>
|
|
352
374
|
* @param {*} [options] Override http request option.
|
|
353
375
|
* @throws {RequiredError}
|
|
354
376
|
*/
|
|
355
|
-
async listCommissionRecipients(authorization?: string, filter?: string,
|
|
356
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listCommissionRecipients(authorization, filter,
|
|
377
|
+
async listCommissionRecipients(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCommissionRecipientsResponseClass>> {
|
|
378
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listCommissionRecipients(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
357
379
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
358
380
|
},
|
|
359
381
|
/**
|
|
360
382
|
* This will update commission recipient.
|
|
361
383
|
* @summary Update the commission recipient
|
|
384
|
+
* @param {string} code
|
|
362
385
|
* @param {UpdateCommissionRecipientRequestDto} updateCommissionRecipientRequestDto
|
|
363
386
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
364
387
|
* @param {*} [options] Override http request option.
|
|
365
388
|
* @throws {RequiredError}
|
|
366
389
|
*/
|
|
367
|
-
async updateCommissionRecipient(updateCommissionRecipientRequestDto: UpdateCommissionRecipientRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateCommissionRecipientResponseClass>> {
|
|
368
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.updateCommissionRecipient(updateCommissionRecipientRequestDto, authorization, options);
|
|
390
|
+
async updateCommissionRecipient(code: string, updateCommissionRecipientRequestDto: UpdateCommissionRecipientRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateCommissionRecipientResponseClass>> {
|
|
391
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.updateCommissionRecipient(code, updateCommissionRecipientRequestDto, authorization, options);
|
|
369
392
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
370
393
|
},
|
|
371
394
|
}
|
|
@@ -392,12 +415,12 @@ export const CommissionRecipientsApiFactory = function (configuration?: Configur
|
|
|
392
415
|
/**
|
|
393
416
|
* This will delete commission recipient.
|
|
394
417
|
* @summary Delete the commission recipient
|
|
395
|
-
* @param {
|
|
418
|
+
* @param {string} code Unique identifier for the object.
|
|
396
419
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
397
420
|
* @param {*} [options] Override http request option.
|
|
398
421
|
* @throws {RequiredError}
|
|
399
422
|
*/
|
|
400
|
-
deleteCommissionRecipient(code:
|
|
423
|
+
deleteCommissionRecipient(code: string, authorization?: string, options?: any): AxiosPromise<void> {
|
|
401
424
|
return localVarFp.deleteCommissionRecipient(code, authorization, options).then((request) => request(axios, basePath));
|
|
402
425
|
},
|
|
403
426
|
/**
|
|
@@ -413,29 +436,33 @@ export const CommissionRecipientsApiFactory = function (configuration?: Configur
|
|
|
413
436
|
return localVarFp.getCommissionRecipient(code, expand, authorization, options).then((request) => request(axios, basePath));
|
|
414
437
|
},
|
|
415
438
|
/**
|
|
416
|
-
* Retrieves a list of
|
|
439
|
+
* Retrieves a list of commission recipients.
|
|
417
440
|
* @summary List commission recipients
|
|
418
441
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
442
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
443
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
419
444
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, displayName, partnerCode, status, createdAt</i>
|
|
420
|
-
* @param {string} [
|
|
445
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
421
446
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: createdAt</i>
|
|
422
447
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
448
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, displayName, partnerCode, status, createdAt</i>
|
|
423
449
|
* @param {*} [options] Override http request option.
|
|
424
450
|
* @throws {RequiredError}
|
|
425
451
|
*/
|
|
426
|
-
listCommissionRecipients(authorization?: string, filter?: string,
|
|
427
|
-
return localVarFp.listCommissionRecipients(authorization, filter,
|
|
452
|
+
listCommissionRecipients(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListCommissionRecipientsResponseClass> {
|
|
453
|
+
return localVarFp.listCommissionRecipients(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
428
454
|
},
|
|
429
455
|
/**
|
|
430
456
|
* This will update commission recipient.
|
|
431
457
|
* @summary Update the commission recipient
|
|
458
|
+
* @param {string} code
|
|
432
459
|
* @param {UpdateCommissionRecipientRequestDto} updateCommissionRecipientRequestDto
|
|
433
460
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
434
461
|
* @param {*} [options] Override http request option.
|
|
435
462
|
* @throws {RequiredError}
|
|
436
463
|
*/
|
|
437
|
-
updateCommissionRecipient(updateCommissionRecipientRequestDto: UpdateCommissionRecipientRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateCommissionRecipientResponseClass> {
|
|
438
|
-
return localVarFp.updateCommissionRecipient(updateCommissionRecipientRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
464
|
+
updateCommissionRecipient(code: string, updateCommissionRecipientRequestDto: UpdateCommissionRecipientRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateCommissionRecipientResponseClass> {
|
|
465
|
+
return localVarFp.updateCommissionRecipient(code, updateCommissionRecipientRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
439
466
|
},
|
|
440
467
|
};
|
|
441
468
|
};
|
|
@@ -469,10 +496,10 @@ export interface CommissionRecipientsApiCreateCommissionRecipientRequest {
|
|
|
469
496
|
export interface CommissionRecipientsApiDeleteCommissionRecipientRequest {
|
|
470
497
|
/**
|
|
471
498
|
* Unique identifier for the object.
|
|
472
|
-
* @type {
|
|
499
|
+
* @type {string}
|
|
473
500
|
* @memberof CommissionRecipientsApiDeleteCommissionRecipient
|
|
474
501
|
*/
|
|
475
|
-
readonly code:
|
|
502
|
+
readonly code: string
|
|
476
503
|
|
|
477
504
|
/**
|
|
478
505
|
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -523,6 +550,20 @@ export interface CommissionRecipientsApiListCommissionRecipientsRequest {
|
|
|
523
550
|
*/
|
|
524
551
|
readonly authorization?: string
|
|
525
552
|
|
|
553
|
+
/**
|
|
554
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
555
|
+
* @type {number}
|
|
556
|
+
* @memberof CommissionRecipientsApiListCommissionRecipients
|
|
557
|
+
*/
|
|
558
|
+
readonly pageSize?: number
|
|
559
|
+
|
|
560
|
+
/**
|
|
561
|
+
* A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
562
|
+
* @type {string}
|
|
563
|
+
* @memberof CommissionRecipientsApiListCommissionRecipients
|
|
564
|
+
*/
|
|
565
|
+
readonly pageToken?: string
|
|
566
|
+
|
|
526
567
|
/**
|
|
527
568
|
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, displayName, partnerCode, status, createdAt</i>
|
|
528
569
|
* @type {string}
|
|
@@ -531,11 +572,11 @@ export interface CommissionRecipientsApiListCommissionRecipientsRequest {
|
|
|
531
572
|
readonly filter?: string
|
|
532
573
|
|
|
533
574
|
/**
|
|
534
|
-
*
|
|
575
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
535
576
|
* @type {string}
|
|
536
577
|
* @memberof CommissionRecipientsApiListCommissionRecipients
|
|
537
578
|
*/
|
|
538
|
-
readonly
|
|
579
|
+
readonly search?: string
|
|
539
580
|
|
|
540
581
|
/**
|
|
541
582
|
* Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: createdAt</i>
|
|
@@ -550,6 +591,13 @@ export interface CommissionRecipientsApiListCommissionRecipientsRequest {
|
|
|
550
591
|
* @memberof CommissionRecipientsApiListCommissionRecipients
|
|
551
592
|
*/
|
|
552
593
|
readonly expand?: string
|
|
594
|
+
|
|
595
|
+
/**
|
|
596
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, displayName, partnerCode, status, createdAt</i>
|
|
597
|
+
* @type {string}
|
|
598
|
+
* @memberof CommissionRecipientsApiListCommissionRecipients
|
|
599
|
+
*/
|
|
600
|
+
readonly filters?: string
|
|
553
601
|
}
|
|
554
602
|
|
|
555
603
|
/**
|
|
@@ -558,6 +606,13 @@ export interface CommissionRecipientsApiListCommissionRecipientsRequest {
|
|
|
558
606
|
* @interface CommissionRecipientsApiUpdateCommissionRecipientRequest
|
|
559
607
|
*/
|
|
560
608
|
export interface CommissionRecipientsApiUpdateCommissionRecipientRequest {
|
|
609
|
+
/**
|
|
610
|
+
*
|
|
611
|
+
* @type {string}
|
|
612
|
+
* @memberof CommissionRecipientsApiUpdateCommissionRecipient
|
|
613
|
+
*/
|
|
614
|
+
readonly code: string
|
|
615
|
+
|
|
561
616
|
/**
|
|
562
617
|
*
|
|
563
618
|
* @type {UpdateCommissionRecipientRequestDto}
|
|
@@ -617,7 +672,7 @@ export class CommissionRecipientsApi extends BaseAPI {
|
|
|
617
672
|
}
|
|
618
673
|
|
|
619
674
|
/**
|
|
620
|
-
* Retrieves a list of
|
|
675
|
+
* Retrieves a list of commission recipients.
|
|
621
676
|
* @summary List commission recipients
|
|
622
677
|
* @param {CommissionRecipientsApiListCommissionRecipientsRequest} requestParameters Request parameters.
|
|
623
678
|
* @param {*} [options] Override http request option.
|
|
@@ -625,7 +680,7 @@ export class CommissionRecipientsApi extends BaseAPI {
|
|
|
625
680
|
* @memberof CommissionRecipientsApi
|
|
626
681
|
*/
|
|
627
682
|
public listCommissionRecipients(requestParameters: CommissionRecipientsApiListCommissionRecipientsRequest = {}, options?: AxiosRequestConfig) {
|
|
628
|
-
return CommissionRecipientsApiFp(this.configuration).listCommissionRecipients(requestParameters.authorization, requestParameters.filter, requestParameters.
|
|
683
|
+
return CommissionRecipientsApiFp(this.configuration).listCommissionRecipients(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
|
|
629
684
|
}
|
|
630
685
|
|
|
631
686
|
/**
|
|
@@ -637,6 +692,6 @@ export class CommissionRecipientsApi extends BaseAPI {
|
|
|
637
692
|
* @memberof CommissionRecipientsApi
|
|
638
693
|
*/
|
|
639
694
|
public updateCommissionRecipient(requestParameters: CommissionRecipientsApiUpdateCommissionRecipientRequest, options?: AxiosRequestConfig) {
|
|
640
|
-
return CommissionRecipientsApiFp(this.configuration).updateCommissionRecipient(requestParameters.updateCommissionRecipientRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
695
|
+
return CommissionRecipientsApiFp(this.configuration).updateCommissionRecipient(requestParameters.code, requestParameters.updateCommissionRecipientRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
641
696
|
}
|
|
642
697
|
}
|
|
@@ -35,12 +35,12 @@ export declare const CommissionRecipientsApiAxiosParamCreator: (configuration?:
|
|
|
35
35
|
/**
|
|
36
36
|
* This will delete commission recipient.
|
|
37
37
|
* @summary Delete the commission recipient
|
|
38
|
-
* @param {
|
|
38
|
+
* @param {string} code Unique identifier for the object.
|
|
39
39
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
40
40
|
* @param {*} [options] Override http request option.
|
|
41
41
|
* @throws {RequiredError}
|
|
42
42
|
*/
|
|
43
|
-
deleteCommissionRecipient: (code:
|
|
43
|
+
deleteCommissionRecipient: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
44
44
|
/**
|
|
45
45
|
* This will get commission recipient.
|
|
46
46
|
* @summary Retrieve the commission recipient
|
|
@@ -52,26 +52,30 @@ export declare const CommissionRecipientsApiAxiosParamCreator: (configuration?:
|
|
|
52
52
|
*/
|
|
53
53
|
getCommissionRecipient: (code: string, expand: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
54
54
|
/**
|
|
55
|
-
* Retrieves a list of
|
|
55
|
+
* Retrieves a list of commission recipients.
|
|
56
56
|
* @summary List commission recipients
|
|
57
57
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
58
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
59
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
58
60
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, displayName, partnerCode, status, createdAt</i>
|
|
59
|
-
* @param {string} [
|
|
61
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
60
62
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: createdAt</i>
|
|
61
63
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
64
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, displayName, partnerCode, status, createdAt</i>
|
|
62
65
|
* @param {*} [options] Override http request option.
|
|
63
66
|
* @throws {RequiredError}
|
|
64
67
|
*/
|
|
65
|
-
listCommissionRecipients: (authorization?: string, filter?: string,
|
|
68
|
+
listCommissionRecipients: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
66
69
|
/**
|
|
67
70
|
* This will update commission recipient.
|
|
68
71
|
* @summary Update the commission recipient
|
|
72
|
+
* @param {string} code
|
|
69
73
|
* @param {UpdateCommissionRecipientRequestDto} updateCommissionRecipientRequestDto
|
|
70
74
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
71
75
|
* @param {*} [options] Override http request option.
|
|
72
76
|
* @throws {RequiredError}
|
|
73
77
|
*/
|
|
74
|
-
updateCommissionRecipient: (updateCommissionRecipientRequestDto: UpdateCommissionRecipientRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
78
|
+
updateCommissionRecipient: (code: string, updateCommissionRecipientRequestDto: UpdateCommissionRecipientRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
75
79
|
};
|
|
76
80
|
/**
|
|
77
81
|
* CommissionRecipientsApi - functional programming interface
|
|
@@ -90,12 +94,12 @@ export declare const CommissionRecipientsApiFp: (configuration?: Configuration)
|
|
|
90
94
|
/**
|
|
91
95
|
* This will delete commission recipient.
|
|
92
96
|
* @summary Delete the commission recipient
|
|
93
|
-
* @param {
|
|
97
|
+
* @param {string} code Unique identifier for the object.
|
|
94
98
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
95
99
|
* @param {*} [options] Override http request option.
|
|
96
100
|
* @throws {RequiredError}
|
|
97
101
|
*/
|
|
98
|
-
deleteCommissionRecipient(code:
|
|
102
|
+
deleteCommissionRecipient(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
99
103
|
/**
|
|
100
104
|
* This will get commission recipient.
|
|
101
105
|
* @summary Retrieve the commission recipient
|
|
@@ -107,26 +111,30 @@ export declare const CommissionRecipientsApiFp: (configuration?: Configuration)
|
|
|
107
111
|
*/
|
|
108
112
|
getCommissionRecipient(code: string, expand: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetCommissionRecipientResponseClass>>;
|
|
109
113
|
/**
|
|
110
|
-
* Retrieves a list of
|
|
114
|
+
* Retrieves a list of commission recipients.
|
|
111
115
|
* @summary List commission recipients
|
|
112
116
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
117
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
118
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
113
119
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, displayName, partnerCode, status, createdAt</i>
|
|
114
|
-
* @param {string} [
|
|
120
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
115
121
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: createdAt</i>
|
|
116
122
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
123
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, displayName, partnerCode, status, createdAt</i>
|
|
117
124
|
* @param {*} [options] Override http request option.
|
|
118
125
|
* @throws {RequiredError}
|
|
119
126
|
*/
|
|
120
|
-
listCommissionRecipients(authorization?: string, filter?: string,
|
|
127
|
+
listCommissionRecipients(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCommissionRecipientsResponseClass>>;
|
|
121
128
|
/**
|
|
122
129
|
* This will update commission recipient.
|
|
123
130
|
* @summary Update the commission recipient
|
|
131
|
+
* @param {string} code
|
|
124
132
|
* @param {UpdateCommissionRecipientRequestDto} updateCommissionRecipientRequestDto
|
|
125
133
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
126
134
|
* @param {*} [options] Override http request option.
|
|
127
135
|
* @throws {RequiredError}
|
|
128
136
|
*/
|
|
129
|
-
updateCommissionRecipient(updateCommissionRecipientRequestDto: UpdateCommissionRecipientRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateCommissionRecipientResponseClass>>;
|
|
137
|
+
updateCommissionRecipient(code: string, updateCommissionRecipientRequestDto: UpdateCommissionRecipientRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateCommissionRecipientResponseClass>>;
|
|
130
138
|
};
|
|
131
139
|
/**
|
|
132
140
|
* CommissionRecipientsApi - factory interface
|
|
@@ -145,12 +153,12 @@ export declare const CommissionRecipientsApiFactory: (configuration?: Configurat
|
|
|
145
153
|
/**
|
|
146
154
|
* This will delete commission recipient.
|
|
147
155
|
* @summary Delete the commission recipient
|
|
148
|
-
* @param {
|
|
156
|
+
* @param {string} code Unique identifier for the object.
|
|
149
157
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
150
158
|
* @param {*} [options] Override http request option.
|
|
151
159
|
* @throws {RequiredError}
|
|
152
160
|
*/
|
|
153
|
-
deleteCommissionRecipient(code:
|
|
161
|
+
deleteCommissionRecipient(code: string, authorization?: string, options?: any): AxiosPromise<void>;
|
|
154
162
|
/**
|
|
155
163
|
* This will get commission recipient.
|
|
156
164
|
* @summary Retrieve the commission recipient
|
|
@@ -162,26 +170,30 @@ export declare const CommissionRecipientsApiFactory: (configuration?: Configurat
|
|
|
162
170
|
*/
|
|
163
171
|
getCommissionRecipient(code: string, expand: string, authorization?: string, options?: any): AxiosPromise<GetCommissionRecipientResponseClass>;
|
|
164
172
|
/**
|
|
165
|
-
* Retrieves a list of
|
|
173
|
+
* Retrieves a list of commission recipients.
|
|
166
174
|
* @summary List commission recipients
|
|
167
175
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
176
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
177
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
168
178
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, displayName, partnerCode, status, createdAt</i>
|
|
169
|
-
* @param {string} [
|
|
179
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
170
180
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: createdAt</i>
|
|
171
181
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
182
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, displayName, partnerCode, status, createdAt</i>
|
|
172
183
|
* @param {*} [options] Override http request option.
|
|
173
184
|
* @throws {RequiredError}
|
|
174
185
|
*/
|
|
175
|
-
listCommissionRecipients(authorization?: string, filter?: string,
|
|
186
|
+
listCommissionRecipients(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListCommissionRecipientsResponseClass>;
|
|
176
187
|
/**
|
|
177
188
|
* This will update commission recipient.
|
|
178
189
|
* @summary Update the commission recipient
|
|
190
|
+
* @param {string} code
|
|
179
191
|
* @param {UpdateCommissionRecipientRequestDto} updateCommissionRecipientRequestDto
|
|
180
192
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
181
193
|
* @param {*} [options] Override http request option.
|
|
182
194
|
* @throws {RequiredError}
|
|
183
195
|
*/
|
|
184
|
-
updateCommissionRecipient(updateCommissionRecipientRequestDto: UpdateCommissionRecipientRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateCommissionRecipientResponseClass>;
|
|
196
|
+
updateCommissionRecipient(code: string, updateCommissionRecipientRequestDto: UpdateCommissionRecipientRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateCommissionRecipientResponseClass>;
|
|
185
197
|
};
|
|
186
198
|
/**
|
|
187
199
|
* Request parameters for createCommissionRecipient operation in CommissionRecipientsApi.
|
|
@@ -210,10 +222,10 @@ export interface CommissionRecipientsApiCreateCommissionRecipientRequest {
|
|
|
210
222
|
export interface CommissionRecipientsApiDeleteCommissionRecipientRequest {
|
|
211
223
|
/**
|
|
212
224
|
* Unique identifier for the object.
|
|
213
|
-
* @type {
|
|
225
|
+
* @type {string}
|
|
214
226
|
* @memberof CommissionRecipientsApiDeleteCommissionRecipient
|
|
215
227
|
*/
|
|
216
|
-
readonly code:
|
|
228
|
+
readonly code: string;
|
|
217
229
|
/**
|
|
218
230
|
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
219
231
|
* @type {string}
|
|
@@ -258,6 +270,18 @@ export interface CommissionRecipientsApiListCommissionRecipientsRequest {
|
|
|
258
270
|
* @memberof CommissionRecipientsApiListCommissionRecipients
|
|
259
271
|
*/
|
|
260
272
|
readonly authorization?: string;
|
|
273
|
+
/**
|
|
274
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
275
|
+
* @type {number}
|
|
276
|
+
* @memberof CommissionRecipientsApiListCommissionRecipients
|
|
277
|
+
*/
|
|
278
|
+
readonly pageSize?: number;
|
|
279
|
+
/**
|
|
280
|
+
* A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
281
|
+
* @type {string}
|
|
282
|
+
* @memberof CommissionRecipientsApiListCommissionRecipients
|
|
283
|
+
*/
|
|
284
|
+
readonly pageToken?: string;
|
|
261
285
|
/**
|
|
262
286
|
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, displayName, partnerCode, status, createdAt</i>
|
|
263
287
|
* @type {string}
|
|
@@ -265,11 +289,11 @@ export interface CommissionRecipientsApiListCommissionRecipientsRequest {
|
|
|
265
289
|
*/
|
|
266
290
|
readonly filter?: string;
|
|
267
291
|
/**
|
|
268
|
-
*
|
|
292
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
269
293
|
* @type {string}
|
|
270
294
|
* @memberof CommissionRecipientsApiListCommissionRecipients
|
|
271
295
|
*/
|
|
272
|
-
readonly
|
|
296
|
+
readonly search?: string;
|
|
273
297
|
/**
|
|
274
298
|
* Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: createdAt</i>
|
|
275
299
|
* @type {string}
|
|
@@ -282,6 +306,12 @@ export interface CommissionRecipientsApiListCommissionRecipientsRequest {
|
|
|
282
306
|
* @memberof CommissionRecipientsApiListCommissionRecipients
|
|
283
307
|
*/
|
|
284
308
|
readonly expand?: string;
|
|
309
|
+
/**
|
|
310
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, displayName, partnerCode, status, createdAt</i>
|
|
311
|
+
* @type {string}
|
|
312
|
+
* @memberof CommissionRecipientsApiListCommissionRecipients
|
|
313
|
+
*/
|
|
314
|
+
readonly filters?: string;
|
|
285
315
|
}
|
|
286
316
|
/**
|
|
287
317
|
* Request parameters for updateCommissionRecipient operation in CommissionRecipientsApi.
|
|
@@ -289,6 +319,12 @@ export interface CommissionRecipientsApiListCommissionRecipientsRequest {
|
|
|
289
319
|
* @interface CommissionRecipientsApiUpdateCommissionRecipientRequest
|
|
290
320
|
*/
|
|
291
321
|
export interface CommissionRecipientsApiUpdateCommissionRecipientRequest {
|
|
322
|
+
/**
|
|
323
|
+
*
|
|
324
|
+
* @type {string}
|
|
325
|
+
* @memberof CommissionRecipientsApiUpdateCommissionRecipient
|
|
326
|
+
*/
|
|
327
|
+
readonly code: string;
|
|
292
328
|
/**
|
|
293
329
|
*
|
|
294
330
|
* @type {UpdateCommissionRecipientRequestDto}
|
|
@@ -337,7 +373,7 @@ export declare class CommissionRecipientsApi extends BaseAPI {
|
|
|
337
373
|
*/
|
|
338
374
|
getCommissionRecipient(requestParameters: CommissionRecipientsApiGetCommissionRecipientRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetCommissionRecipientResponseClass, any, {}>>;
|
|
339
375
|
/**
|
|
340
|
-
* Retrieves a list of
|
|
376
|
+
* Retrieves a list of commission recipients.
|
|
341
377
|
* @summary List commission recipients
|
|
342
378
|
* @param {CommissionRecipientsApiListCommissionRecipientsRequest} requestParameters Request parameters.
|
|
343
379
|
* @param {*} [options] Override http request option.
|
|
@@ -148,7 +148,7 @@ var CommissionRecipientsApiAxiosParamCreator = function (configuration) {
|
|
|
148
148
|
/**
|
|
149
149
|
* This will delete commission recipient.
|
|
150
150
|
* @summary Delete the commission recipient
|
|
151
|
-
* @param {
|
|
151
|
+
* @param {string} code Unique identifier for the object.
|
|
152
152
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
153
153
|
* @param {*} [options] Override http request option.
|
|
154
154
|
* @throws {RequiredError}
|
|
@@ -162,7 +162,7 @@ var CommissionRecipientsApiAxiosParamCreator = function (configuration) {
|
|
|
162
162
|
case 0:
|
|
163
163
|
// verify required parameter 'code' is not null or undefined
|
|
164
164
|
(0, common_1.assertParamExists)('deleteCommissionRecipient', 'code', code);
|
|
165
|
-
localVarPath = "/commissionservice/v1/commission-recipients"
|
|
165
|
+
localVarPath = "/commissionservice/v1/commission-recipients/{code}"
|
|
166
166
|
.replace("{".concat("code", "}"), encodeURIComponent(String(code)));
|
|
167
167
|
localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
168
168
|
if (configuration) {
|
|
@@ -248,17 +248,20 @@ var CommissionRecipientsApiAxiosParamCreator = function (configuration) {
|
|
|
248
248
|
});
|
|
249
249
|
},
|
|
250
250
|
/**
|
|
251
|
-
* Retrieves a list of
|
|
251
|
+
* Retrieves a list of commission recipients.
|
|
252
252
|
* @summary List commission recipients
|
|
253
253
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
254
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
255
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
254
256
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, displayName, partnerCode, status, createdAt</i>
|
|
255
|
-
* @param {string} [
|
|
257
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
256
258
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: createdAt</i>
|
|
257
259
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
260
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, displayName, partnerCode, status, createdAt</i>
|
|
258
261
|
* @param {*} [options] Override http request option.
|
|
259
262
|
* @throws {RequiredError}
|
|
260
263
|
*/
|
|
261
|
-
listCommissionRecipients: function (authorization, filter,
|
|
264
|
+
listCommissionRecipients: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
262
265
|
if (options === void 0) { options = {}; }
|
|
263
266
|
return __awaiter(_this, void 0, void 0, function () {
|
|
264
267
|
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
@@ -281,11 +284,17 @@ var CommissionRecipientsApiAxiosParamCreator = function (configuration) {
|
|
|
281
284
|
// authentication bearer required
|
|
282
285
|
// http bearer authentication required
|
|
283
286
|
_a.sent();
|
|
287
|
+
if (pageSize !== undefined) {
|
|
288
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
289
|
+
}
|
|
290
|
+
if (pageToken !== undefined) {
|
|
291
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
292
|
+
}
|
|
284
293
|
if (filter !== undefined) {
|
|
285
294
|
localVarQueryParameter['filter'] = filter;
|
|
286
295
|
}
|
|
287
|
-
if (
|
|
288
|
-
localVarQueryParameter['
|
|
296
|
+
if (search !== undefined) {
|
|
297
|
+
localVarQueryParameter['search'] = search;
|
|
289
298
|
}
|
|
290
299
|
if (order !== undefined) {
|
|
291
300
|
localVarQueryParameter['order'] = order;
|
|
@@ -293,6 +302,9 @@ var CommissionRecipientsApiAxiosParamCreator = function (configuration) {
|
|
|
293
302
|
if (expand !== undefined) {
|
|
294
303
|
localVarQueryParameter['expand'] = expand;
|
|
295
304
|
}
|
|
305
|
+
if (filters !== undefined) {
|
|
306
|
+
localVarQueryParameter['filters'] = filters;
|
|
307
|
+
}
|
|
296
308
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
297
309
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
298
310
|
}
|
|
@@ -310,21 +322,25 @@ var CommissionRecipientsApiAxiosParamCreator = function (configuration) {
|
|
|
310
322
|
/**
|
|
311
323
|
* This will update commission recipient.
|
|
312
324
|
* @summary Update the commission recipient
|
|
325
|
+
* @param {string} code
|
|
313
326
|
* @param {UpdateCommissionRecipientRequestDto} updateCommissionRecipientRequestDto
|
|
314
327
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
315
328
|
* @param {*} [options] Override http request option.
|
|
316
329
|
* @throws {RequiredError}
|
|
317
330
|
*/
|
|
318
|
-
updateCommissionRecipient: function (updateCommissionRecipientRequestDto, authorization, options) {
|
|
331
|
+
updateCommissionRecipient: function (code, updateCommissionRecipientRequestDto, authorization, options) {
|
|
319
332
|
if (options === void 0) { options = {}; }
|
|
320
333
|
return __awaiter(_this, void 0, void 0, function () {
|
|
321
334
|
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
322
335
|
return __generator(this, function (_a) {
|
|
323
336
|
switch (_a.label) {
|
|
324
337
|
case 0:
|
|
338
|
+
// verify required parameter 'code' is not null or undefined
|
|
339
|
+
(0, common_1.assertParamExists)('updateCommissionRecipient', 'code', code);
|
|
325
340
|
// verify required parameter 'updateCommissionRecipientRequestDto' is not null or undefined
|
|
326
341
|
(0, common_1.assertParamExists)('updateCommissionRecipient', 'updateCommissionRecipientRequestDto', updateCommissionRecipientRequestDto);
|
|
327
|
-
localVarPath = "/commissionservice/v1/commission-recipients"
|
|
342
|
+
localVarPath = "/commissionservice/v1/commission-recipients/{code}"
|
|
343
|
+
.replace("{".concat("code", "}"), encodeURIComponent(String(code)));
|
|
328
344
|
localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
329
345
|
if (configuration) {
|
|
330
346
|
baseOptions = configuration.baseOptions;
|
|
@@ -390,7 +406,7 @@ var CommissionRecipientsApiFp = function (configuration) {
|
|
|
390
406
|
/**
|
|
391
407
|
* This will delete commission recipient.
|
|
392
408
|
* @summary Delete the commission recipient
|
|
393
|
-
* @param {
|
|
409
|
+
* @param {string} code Unique identifier for the object.
|
|
394
410
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
395
411
|
* @param {*} [options] Override http request option.
|
|
396
412
|
* @throws {RequiredError}
|
|
@@ -431,22 +447,25 @@ var CommissionRecipientsApiFp = function (configuration) {
|
|
|
431
447
|
});
|
|
432
448
|
},
|
|
433
449
|
/**
|
|
434
|
-
* Retrieves a list of
|
|
450
|
+
* Retrieves a list of commission recipients.
|
|
435
451
|
* @summary List commission recipients
|
|
436
452
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
453
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
454
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
437
455
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, displayName, partnerCode, status, createdAt</i>
|
|
438
|
-
* @param {string} [
|
|
456
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
439
457
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: createdAt</i>
|
|
440
458
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
459
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, displayName, partnerCode, status, createdAt</i>
|
|
441
460
|
* @param {*} [options] Override http request option.
|
|
442
461
|
* @throws {RequiredError}
|
|
443
462
|
*/
|
|
444
|
-
listCommissionRecipients: function (authorization, filter,
|
|
463
|
+
listCommissionRecipients: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
445
464
|
return __awaiter(this, void 0, void 0, function () {
|
|
446
465
|
var localVarAxiosArgs;
|
|
447
466
|
return __generator(this, function (_a) {
|
|
448
467
|
switch (_a.label) {
|
|
449
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.listCommissionRecipients(authorization, filter,
|
|
468
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.listCommissionRecipients(authorization, pageSize, pageToken, filter, search, order, expand, filters, options)];
|
|
450
469
|
case 1:
|
|
451
470
|
localVarAxiosArgs = _a.sent();
|
|
452
471
|
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
@@ -457,17 +476,18 @@ var CommissionRecipientsApiFp = function (configuration) {
|
|
|
457
476
|
/**
|
|
458
477
|
* This will update commission recipient.
|
|
459
478
|
* @summary Update the commission recipient
|
|
479
|
+
* @param {string} code
|
|
460
480
|
* @param {UpdateCommissionRecipientRequestDto} updateCommissionRecipientRequestDto
|
|
461
481
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
462
482
|
* @param {*} [options] Override http request option.
|
|
463
483
|
* @throws {RequiredError}
|
|
464
484
|
*/
|
|
465
|
-
updateCommissionRecipient: function (updateCommissionRecipientRequestDto, authorization, options) {
|
|
485
|
+
updateCommissionRecipient: function (code, updateCommissionRecipientRequestDto, authorization, options) {
|
|
466
486
|
return __awaiter(this, void 0, void 0, function () {
|
|
467
487
|
var localVarAxiosArgs;
|
|
468
488
|
return __generator(this, function (_a) {
|
|
469
489
|
switch (_a.label) {
|
|
470
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.updateCommissionRecipient(updateCommissionRecipientRequestDto, authorization, options)];
|
|
490
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.updateCommissionRecipient(code, updateCommissionRecipientRequestDto, authorization, options)];
|
|
471
491
|
case 1:
|
|
472
492
|
localVarAxiosArgs = _a.sent();
|
|
473
493
|
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
@@ -499,7 +519,7 @@ var CommissionRecipientsApiFactory = function (configuration, basePath, axios) {
|
|
|
499
519
|
/**
|
|
500
520
|
* This will delete commission recipient.
|
|
501
521
|
* @summary Delete the commission recipient
|
|
502
|
-
* @param {
|
|
522
|
+
* @param {string} code Unique identifier for the object.
|
|
503
523
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
504
524
|
* @param {*} [options] Override http request option.
|
|
505
525
|
* @throws {RequiredError}
|
|
@@ -520,29 +540,33 @@ var CommissionRecipientsApiFactory = function (configuration, basePath, axios) {
|
|
|
520
540
|
return localVarFp.getCommissionRecipient(code, expand, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
521
541
|
},
|
|
522
542
|
/**
|
|
523
|
-
* Retrieves a list of
|
|
543
|
+
* Retrieves a list of commission recipients.
|
|
524
544
|
* @summary List commission recipients
|
|
525
545
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
546
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
547
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
526
548
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, displayName, partnerCode, status, createdAt</i>
|
|
527
|
-
* @param {string} [
|
|
549
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
528
550
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: createdAt</i>
|
|
529
551
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
552
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, displayName, partnerCode, status, createdAt</i>
|
|
530
553
|
* @param {*} [options] Override http request option.
|
|
531
554
|
* @throws {RequiredError}
|
|
532
555
|
*/
|
|
533
|
-
listCommissionRecipients: function (authorization, filter,
|
|
534
|
-
return localVarFp.listCommissionRecipients(authorization, filter,
|
|
556
|
+
listCommissionRecipients: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
557
|
+
return localVarFp.listCommissionRecipients(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
|
|
535
558
|
},
|
|
536
559
|
/**
|
|
537
560
|
* This will update commission recipient.
|
|
538
561
|
* @summary Update the commission recipient
|
|
562
|
+
* @param {string} code
|
|
539
563
|
* @param {UpdateCommissionRecipientRequestDto} updateCommissionRecipientRequestDto
|
|
540
564
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
541
565
|
* @param {*} [options] Override http request option.
|
|
542
566
|
* @throws {RequiredError}
|
|
543
567
|
*/
|
|
544
|
-
updateCommissionRecipient: function (updateCommissionRecipientRequestDto, authorization, options) {
|
|
545
|
-
return localVarFp.updateCommissionRecipient(updateCommissionRecipientRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
568
|
+
updateCommissionRecipient: function (code, updateCommissionRecipientRequestDto, authorization, options) {
|
|
569
|
+
return localVarFp.updateCommissionRecipient(code, updateCommissionRecipientRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
546
570
|
},
|
|
547
571
|
};
|
|
548
572
|
};
|
|
@@ -595,7 +619,7 @@ var CommissionRecipientsApi = /** @class */ (function (_super) {
|
|
|
595
619
|
return (0, exports.CommissionRecipientsApiFp)(this.configuration).getCommissionRecipient(requestParameters.code, requestParameters.expand, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
596
620
|
};
|
|
597
621
|
/**
|
|
598
|
-
* Retrieves a list of
|
|
622
|
+
* Retrieves a list of commission recipients.
|
|
599
623
|
* @summary List commission recipients
|
|
600
624
|
* @param {CommissionRecipientsApiListCommissionRecipientsRequest} requestParameters Request parameters.
|
|
601
625
|
* @param {*} [options] Override http request option.
|
|
@@ -605,7 +629,7 @@ var CommissionRecipientsApi = /** @class */ (function (_super) {
|
|
|
605
629
|
CommissionRecipientsApi.prototype.listCommissionRecipients = function (requestParameters, options) {
|
|
606
630
|
var _this = this;
|
|
607
631
|
if (requestParameters === void 0) { requestParameters = {}; }
|
|
608
|
-
return (0, exports.CommissionRecipientsApiFp)(this.configuration).listCommissionRecipients(requestParameters.authorization, requestParameters.filter, requestParameters.
|
|
632
|
+
return (0, exports.CommissionRecipientsApiFp)(this.configuration).listCommissionRecipients(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
609
633
|
};
|
|
610
634
|
/**
|
|
611
635
|
* This will update commission recipient.
|
|
@@ -617,7 +641,7 @@ var CommissionRecipientsApi = /** @class */ (function (_super) {
|
|
|
617
641
|
*/
|
|
618
642
|
CommissionRecipientsApi.prototype.updateCommissionRecipient = function (requestParameters, options) {
|
|
619
643
|
var _this = this;
|
|
620
|
-
return (0, exports.CommissionRecipientsApiFp)(this.configuration).updateCommissionRecipient(requestParameters.updateCommissionRecipientRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
644
|
+
return (0, exports.CommissionRecipientsApiFp)(this.configuration).updateCommissionRecipient(requestParameters.code, requestParameters.updateCommissionRecipientRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
621
645
|
};
|
|
622
646
|
return CommissionRecipientsApi;
|
|
623
647
|
}(base_1.BaseAPI));
|