@emilgroup/commission-sdk 2.10.0 → 2.10.1-beta.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +2 -0
- package/README.md +2 -2
- package/api/commission-agreement-versions-api.ts +12 -12
- package/api/commission-settlements-api.ts +107 -0
- package/api/commissions-api.ts +13 -13
- package/dist/api/commission-agreement-versions-api.d.ts +12 -12
- package/dist/api/commission-agreement-versions-api.js +9 -9
- package/dist/api/commission-settlements-api.d.ts +57 -0
- package/dist/api/commission-settlements-api.js +93 -0
- package/dist/api/commissions-api.d.ts +13 -13
- package/dist/api/commissions-api.js +6 -6
- package/dist/models/commission-agreement-version-class.d.ts +6 -0
- package/dist/models/commission-class.d.ts +6 -0
- package/dist/models/create-commission-agreement-request-dto.d.ts +6 -0
- package/dist/models/create-commission-agreement-version-request-dto.d.ts +6 -0
- package/dist/models/index.d.ts +2 -0
- package/dist/models/index.js +2 -0
- package/dist/models/trigger-commission-settlement-creation-request-dto.d.ts +30 -0
- package/dist/models/trigger-commission-settlement-creation-request-dto.js +15 -0
- package/dist/models/trigger-commission-settlement-creation-response-class.d.ts +24 -0
- package/dist/models/trigger-commission-settlement-creation-response-class.js +15 -0
- package/models/commission-agreement-version-class.ts +6 -0
- package/models/commission-class.ts +6 -0
- package/models/create-commission-agreement-request-dto.ts +6 -0
- package/models/create-commission-agreement-version-request-dto.ts +6 -0
- package/models/index.ts +2 -0
- package/models/trigger-commission-settlement-creation-request-dto.ts +36 -0
- package/models/trigger-commission-settlement-creation-response-class.ts +30 -0
- package/package.json +1 -1
package/.openapi-generator/FILES
CHANGED
|
@@ -81,6 +81,8 @@ models/patch-commission-agreement-status-request-dto.ts
|
|
|
81
81
|
models/patch-commission-agreement-status-response-class.ts
|
|
82
82
|
models/publish-commission-settlements-request-dto.ts
|
|
83
83
|
models/publish-commission-settlements-response-class.ts
|
|
84
|
+
models/trigger-commission-settlement-creation-request-dto.ts
|
|
85
|
+
models/trigger-commission-settlement-creation-response-class.ts
|
|
84
86
|
models/update-commission-agreement-product-request-dto.ts
|
|
85
87
|
models/update-commission-agreement-product-response-class.ts
|
|
86
88
|
models/update-commission-agreement-request-dto.ts
|
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@2.10.
|
|
20
|
+
npm install @emilgroup/commission-sdk@2.10.1-beta.1 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/commission-sdk@2.10.
|
|
24
|
+
yarn add @emilgroup/commission-sdk@2.10.1-beta.1
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import `CommissionApi`.
|
|
@@ -184,11 +184,11 @@ export const CommissionAgreementVersionsApiAxiosParamCreator = function (configu
|
|
|
184
184
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
185
185
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
186
186
|
* @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.
|
|
187
|
-
* @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, agreementCode, startDate, endDate, createdAt</i>
|
|
187
|
+
* @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, agreementCode, startDate, endDate, settlementCreationDate, createdAt</i>
|
|
188
188
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
189
|
-
* @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: code, createdAt, startDate, endDate</i>
|
|
189
|
+
* @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: code, createdAt, startDate, endDate, settlementCreationDate</i>
|
|
190
190
|
* @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/> <i>Allowed values: agreements<i>
|
|
191
|
-
* @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, agreementCode, startDate, endDate, createdAt</i>
|
|
191
|
+
* @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, agreementCode, startDate, endDate, settlementCreationDate, createdAt</i>
|
|
192
192
|
* @param {*} [options] Override http request option.
|
|
193
193
|
* @throws {RequiredError}
|
|
194
194
|
*/
|
|
@@ -307,11 +307,11 @@ export const CommissionAgreementVersionsApiFp = function(configuration?: Configu
|
|
|
307
307
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
308
308
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
309
309
|
* @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.
|
|
310
|
-
* @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, agreementCode, startDate, endDate, createdAt</i>
|
|
310
|
+
* @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, agreementCode, startDate, endDate, settlementCreationDate, createdAt</i>
|
|
311
311
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
312
|
-
* @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: code, createdAt, startDate, endDate</i>
|
|
312
|
+
* @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: code, createdAt, startDate, endDate, settlementCreationDate</i>
|
|
313
313
|
* @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/> <i>Allowed values: agreements<i>
|
|
314
|
-
* @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, agreementCode, startDate, endDate, createdAt</i>
|
|
314
|
+
* @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, agreementCode, startDate, endDate, settlementCreationDate, createdAt</i>
|
|
315
315
|
* @param {*} [options] Override http request option.
|
|
316
316
|
* @throws {RequiredError}
|
|
317
317
|
*/
|
|
@@ -369,11 +369,11 @@ export const CommissionAgreementVersionsApiFactory = function (configuration?: C
|
|
|
369
369
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
370
370
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
371
371
|
* @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.
|
|
372
|
-
* @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, agreementCode, startDate, endDate, createdAt</i>
|
|
372
|
+
* @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, agreementCode, startDate, endDate, settlementCreationDate, createdAt</i>
|
|
373
373
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
374
|
-
* @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: code, createdAt, startDate, endDate</i>
|
|
374
|
+
* @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: code, createdAt, startDate, endDate, settlementCreationDate</i>
|
|
375
375
|
* @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/> <i>Allowed values: agreements<i>
|
|
376
|
-
* @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, agreementCode, startDate, endDate, createdAt</i>
|
|
376
|
+
* @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, agreementCode, startDate, endDate, settlementCreationDate, createdAt</i>
|
|
377
377
|
* @param {*} [options] Override http request option.
|
|
378
378
|
* @throws {RequiredError}
|
|
379
379
|
*/
|
|
@@ -481,7 +481,7 @@ export interface CommissionAgreementVersionsApiListCommissionAgreementVersionsRe
|
|
|
481
481
|
readonly pageToken?: string
|
|
482
482
|
|
|
483
483
|
/**
|
|
484
|
-
* 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, agreementCode, startDate, endDate, createdAt</i>
|
|
484
|
+
* 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, agreementCode, startDate, endDate, settlementCreationDate, createdAt</i>
|
|
485
485
|
* @type {string}
|
|
486
486
|
* @memberof CommissionAgreementVersionsApiListCommissionAgreementVersions
|
|
487
487
|
*/
|
|
@@ -495,7 +495,7 @@ export interface CommissionAgreementVersionsApiListCommissionAgreementVersionsRe
|
|
|
495
495
|
readonly search?: string
|
|
496
496
|
|
|
497
497
|
/**
|
|
498
|
-
* 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: code, createdAt, startDate, endDate</i>
|
|
498
|
+
* 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: code, createdAt, startDate, endDate, settlementCreationDate</i>
|
|
499
499
|
* @type {string}
|
|
500
500
|
* @memberof CommissionAgreementVersionsApiListCommissionAgreementVersions
|
|
501
501
|
*/
|
|
@@ -509,7 +509,7 @@ export interface CommissionAgreementVersionsApiListCommissionAgreementVersionsRe
|
|
|
509
509
|
readonly expand?: string
|
|
510
510
|
|
|
511
511
|
/**
|
|
512
|
-
* 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, agreementCode, startDate, endDate, createdAt</i>
|
|
512
|
+
* 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, agreementCode, startDate, endDate, settlementCreationDate, createdAt</i>
|
|
513
513
|
* @type {string}
|
|
514
514
|
* @memberof CommissionAgreementVersionsApiListCommissionAgreementVersions
|
|
515
515
|
*/
|
|
@@ -33,6 +33,10 @@ import { PublishCommissionSettlementsRequestDto } from '../models';
|
|
|
33
33
|
// @ts-ignore
|
|
34
34
|
import { PublishCommissionSettlementsResponseClass } from '../models';
|
|
35
35
|
// @ts-ignore
|
|
36
|
+
import { TriggerCommissionSettlementCreationRequestDto } from '../models';
|
|
37
|
+
// @ts-ignore
|
|
38
|
+
import { TriggerCommissionSettlementCreationResponseClass } from '../models';
|
|
39
|
+
// @ts-ignore
|
|
36
40
|
import { UpdateCommissionSettlementRequestDto } from '../models';
|
|
37
41
|
// @ts-ignore
|
|
38
42
|
import { UpdateCommissionSettlementResponseClass } from '../models';
|
|
@@ -309,6 +313,53 @@ export const CommissionSettlementsApiAxiosParamCreator = function (configuration
|
|
|
309
313
|
options: localVarRequestOptions,
|
|
310
314
|
};
|
|
311
315
|
},
|
|
316
|
+
/**
|
|
317
|
+
* Triggers the commission settlement creation job.
|
|
318
|
+
* @summary Create the commission settlement creation job
|
|
319
|
+
* @param {TriggerCommissionSettlementCreationRequestDto} triggerCommissionSettlementCreationRequestDto
|
|
320
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
321
|
+
* @param {*} [options] Override http request option.
|
|
322
|
+
* @throws {RequiredError}
|
|
323
|
+
*/
|
|
324
|
+
triggerCommissionSettlementCreation: async (triggerCommissionSettlementCreationRequestDto: TriggerCommissionSettlementCreationRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
325
|
+
// verify required parameter 'triggerCommissionSettlementCreationRequestDto' is not null or undefined
|
|
326
|
+
assertParamExists('triggerCommissionSettlementCreation', 'triggerCommissionSettlementCreationRequestDto', triggerCommissionSettlementCreationRequestDto)
|
|
327
|
+
const localVarPath = `/commissionservice/v1/commission-settlements/commission-settlement-creation/trigger`;
|
|
328
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
329
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
330
|
+
let baseOptions;
|
|
331
|
+
let baseAccessToken;
|
|
332
|
+
if (configuration) {
|
|
333
|
+
baseOptions = configuration.baseOptions;
|
|
334
|
+
baseAccessToken = configuration.accessToken;
|
|
335
|
+
}
|
|
336
|
+
|
|
337
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
338
|
+
const localVarHeaderParameter = {} as any;
|
|
339
|
+
const localVarQueryParameter = {} as any;
|
|
340
|
+
|
|
341
|
+
// authentication bearer required
|
|
342
|
+
// http bearer authentication required
|
|
343
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
344
|
+
|
|
345
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
346
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
347
|
+
}
|
|
348
|
+
|
|
349
|
+
|
|
350
|
+
|
|
351
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
352
|
+
|
|
353
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
354
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
355
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
356
|
+
localVarRequestOptions.data = serializeDataIfNeeded(triggerCommissionSettlementCreationRequestDto, localVarRequestOptions, configuration)
|
|
357
|
+
|
|
358
|
+
return {
|
|
359
|
+
url: toPathString(localVarUrlObj),
|
|
360
|
+
options: localVarRequestOptions,
|
|
361
|
+
};
|
|
362
|
+
},
|
|
312
363
|
/**
|
|
313
364
|
* This will update commission settlement.
|
|
314
365
|
* @summary Update the commission settlement
|
|
@@ -437,6 +488,18 @@ export const CommissionSettlementsApiFp = function(configuration?: Configuration
|
|
|
437
488
|
const localVarAxiosArgs = await localVarAxiosParamCreator.publishCommissionSettlements(publishCommissionSettlementsRequestDto, authorization, options);
|
|
438
489
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
439
490
|
},
|
|
491
|
+
/**
|
|
492
|
+
* Triggers the commission settlement creation job.
|
|
493
|
+
* @summary Create the commission settlement creation job
|
|
494
|
+
* @param {TriggerCommissionSettlementCreationRequestDto} triggerCommissionSettlementCreationRequestDto
|
|
495
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
496
|
+
* @param {*} [options] Override http request option.
|
|
497
|
+
* @throws {RequiredError}
|
|
498
|
+
*/
|
|
499
|
+
async triggerCommissionSettlementCreation(triggerCommissionSettlementCreationRequestDto: TriggerCommissionSettlementCreationRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TriggerCommissionSettlementCreationResponseClass>> {
|
|
500
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.triggerCommissionSettlementCreation(triggerCommissionSettlementCreationRequestDto, authorization, options);
|
|
501
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
502
|
+
},
|
|
440
503
|
/**
|
|
441
504
|
* This will update commission settlement.
|
|
442
505
|
* @summary Update the commission settlement
|
|
@@ -522,6 +585,17 @@ export const CommissionSettlementsApiFactory = function (configuration?: Configu
|
|
|
522
585
|
publishCommissionSettlements(publishCommissionSettlementsRequestDto: PublishCommissionSettlementsRequestDto, authorization?: string, options?: any): AxiosPromise<PublishCommissionSettlementsResponseClass> {
|
|
523
586
|
return localVarFp.publishCommissionSettlements(publishCommissionSettlementsRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
524
587
|
},
|
|
588
|
+
/**
|
|
589
|
+
* Triggers the commission settlement creation job.
|
|
590
|
+
* @summary Create the commission settlement creation job
|
|
591
|
+
* @param {TriggerCommissionSettlementCreationRequestDto} triggerCommissionSettlementCreationRequestDto
|
|
592
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
593
|
+
* @param {*} [options] Override http request option.
|
|
594
|
+
* @throws {RequiredError}
|
|
595
|
+
*/
|
|
596
|
+
triggerCommissionSettlementCreation(triggerCommissionSettlementCreationRequestDto: TriggerCommissionSettlementCreationRequestDto, authorization?: string, options?: any): AxiosPromise<TriggerCommissionSettlementCreationResponseClass> {
|
|
597
|
+
return localVarFp.triggerCommissionSettlementCreation(triggerCommissionSettlementCreationRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
598
|
+
},
|
|
525
599
|
/**
|
|
526
600
|
* This will update commission settlement.
|
|
527
601
|
* @summary Update the commission settlement
|
|
@@ -691,6 +765,27 @@ export interface CommissionSettlementsApiPublishCommissionSettlementsRequest {
|
|
|
691
765
|
readonly authorization?: string
|
|
692
766
|
}
|
|
693
767
|
|
|
768
|
+
/**
|
|
769
|
+
* Request parameters for triggerCommissionSettlementCreation operation in CommissionSettlementsApi.
|
|
770
|
+
* @export
|
|
771
|
+
* @interface CommissionSettlementsApiTriggerCommissionSettlementCreationRequest
|
|
772
|
+
*/
|
|
773
|
+
export interface CommissionSettlementsApiTriggerCommissionSettlementCreationRequest {
|
|
774
|
+
/**
|
|
775
|
+
*
|
|
776
|
+
* @type {TriggerCommissionSettlementCreationRequestDto}
|
|
777
|
+
* @memberof CommissionSettlementsApiTriggerCommissionSettlementCreation
|
|
778
|
+
*/
|
|
779
|
+
readonly triggerCommissionSettlementCreationRequestDto: TriggerCommissionSettlementCreationRequestDto
|
|
780
|
+
|
|
781
|
+
/**
|
|
782
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
783
|
+
* @type {string}
|
|
784
|
+
* @memberof CommissionSettlementsApiTriggerCommissionSettlementCreation
|
|
785
|
+
*/
|
|
786
|
+
readonly authorization?: string
|
|
787
|
+
}
|
|
788
|
+
|
|
694
789
|
/**
|
|
695
790
|
* Request parameters for updateCommissionSettlement operation in CommissionSettlementsApi.
|
|
696
791
|
* @export
|
|
@@ -786,6 +881,18 @@ export class CommissionSettlementsApi extends BaseAPI {
|
|
|
786
881
|
return CommissionSettlementsApiFp(this.configuration).publishCommissionSettlements(requestParameters.publishCommissionSettlementsRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
787
882
|
}
|
|
788
883
|
|
|
884
|
+
/**
|
|
885
|
+
* Triggers the commission settlement creation job.
|
|
886
|
+
* @summary Create the commission settlement creation job
|
|
887
|
+
* @param {CommissionSettlementsApiTriggerCommissionSettlementCreationRequest} requestParameters Request parameters.
|
|
888
|
+
* @param {*} [options] Override http request option.
|
|
889
|
+
* @throws {RequiredError}
|
|
890
|
+
* @memberof CommissionSettlementsApi
|
|
891
|
+
*/
|
|
892
|
+
public triggerCommissionSettlementCreation(requestParameters: CommissionSettlementsApiTriggerCommissionSettlementCreationRequest, options?: AxiosRequestConfig) {
|
|
893
|
+
return CommissionSettlementsApiFp(this.configuration).triggerCommissionSettlementCreation(requestParameters.triggerCommissionSettlementCreationRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
894
|
+
}
|
|
895
|
+
|
|
789
896
|
/**
|
|
790
897
|
* This will update commission settlement.
|
|
791
898
|
* @summary Update the commission settlement
|
package/api/commissions-api.ts
CHANGED
|
@@ -239,15 +239,15 @@ export const CommissionsApiAxiosParamCreator = function (configuration?: Configu
|
|
|
239
239
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
240
240
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
241
241
|
* @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.
|
|
242
|
-
* @param {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementNumber' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'settlementCode'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
242
|
+
* @param {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementNumber' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'openedAt' | 'updatedAt' | 'settlementCode'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
243
243
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
244
|
-
* @param {'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency'} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
244
|
+
* @param {'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'openedAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency'} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
245
245
|
* @param {'items' | 'agreement'} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
246
246
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
247
247
|
* @param {*} [options] Override http request option.
|
|
248
248
|
* @throws {RequiredError}
|
|
249
249
|
*/
|
|
250
|
-
listCommissions: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementNumber' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'settlementCode', search?: string, order?: 'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency', expand?: 'items' | 'agreement', filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
250
|
+
listCommissions: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementNumber' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'openedAt' | 'updatedAt' | 'settlementCode', search?: string, order?: 'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'openedAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency', expand?: 'items' | 'agreement', filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
251
251
|
const localVarPath = `/commissionservice/v1/commissions`;
|
|
252
252
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
253
253
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -425,15 +425,15 @@ export const CommissionsApiFp = function(configuration?: Configuration) {
|
|
|
425
425
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
426
426
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
427
427
|
* @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.
|
|
428
|
-
* @param {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementNumber' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'settlementCode'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
428
|
+
* @param {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementNumber' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'openedAt' | 'updatedAt' | 'settlementCode'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
429
429
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
430
|
-
* @param {'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency'} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
430
|
+
* @param {'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'openedAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency'} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
431
431
|
* @param {'items' | 'agreement'} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
432
432
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
433
433
|
* @param {*} [options] Override http request option.
|
|
434
434
|
* @throws {RequiredError}
|
|
435
435
|
*/
|
|
436
|
-
async listCommissions(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementNumber' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'settlementCode', search?: string, order?: 'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency', expand?: 'items' | 'agreement', filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCommissionsResponseClass>> {
|
|
436
|
+
async listCommissions(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementNumber' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'openedAt' | 'updatedAt' | 'settlementCode', search?: string, order?: 'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'openedAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency', expand?: 'items' | 'agreement', filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCommissionsResponseClass>> {
|
|
437
437
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listCommissions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
438
438
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
439
439
|
},
|
|
@@ -511,15 +511,15 @@ export const CommissionsApiFactory = function (configuration?: Configuration, ba
|
|
|
511
511
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
512
512
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
513
513
|
* @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.
|
|
514
|
-
* @param {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementNumber' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'settlementCode'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
514
|
+
* @param {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementNumber' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'openedAt' | 'updatedAt' | 'settlementCode'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
515
515
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
516
|
-
* @param {'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency'} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
516
|
+
* @param {'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'openedAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency'} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
517
517
|
* @param {'items' | 'agreement'} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
518
518
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
519
519
|
* @param {*} [options] Override http request option.
|
|
520
520
|
* @throws {RequiredError}
|
|
521
521
|
*/
|
|
522
|
-
listCommissions(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementNumber' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'settlementCode', search?: string, order?: 'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency', expand?: 'items' | 'agreement', filters?: string, options?: any): AxiosPromise<ListCommissionsResponseClass> {
|
|
522
|
+
listCommissions(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementNumber' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'openedAt' | 'updatedAt' | 'settlementCode', search?: string, order?: 'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'openedAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency', expand?: 'items' | 'agreement', filters?: string, options?: any): AxiosPromise<ListCommissionsResponseClass> {
|
|
523
523
|
return localVarFp.listCommissions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
524
524
|
},
|
|
525
525
|
/**
|
|
@@ -657,10 +657,10 @@ export interface CommissionsApiListCommissionsRequest {
|
|
|
657
657
|
|
|
658
658
|
/**
|
|
659
659
|
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
660
|
-
* @type {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementNumber' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'settlementCode'}
|
|
660
|
+
* @type {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementNumber' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'openedAt' | 'updatedAt' | 'settlementCode'}
|
|
661
661
|
* @memberof CommissionsApiListCommissions
|
|
662
662
|
*/
|
|
663
|
-
readonly filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementNumber' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'settlementCode'
|
|
663
|
+
readonly filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementNumber' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'openedAt' | 'updatedAt' | 'settlementCode'
|
|
664
664
|
|
|
665
665
|
/**
|
|
666
666
|
* To search the list by any field, pass search=xxx to fetch the result.
|
|
@@ -671,10 +671,10 @@ export interface CommissionsApiListCommissionsRequest {
|
|
|
671
671
|
|
|
672
672
|
/**
|
|
673
673
|
* The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
674
|
-
* @type {'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency'}
|
|
674
|
+
* @type {'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'openedAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency'}
|
|
675
675
|
* @memberof CommissionsApiListCommissions
|
|
676
676
|
*/
|
|
677
|
-
readonly order?: 'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency'
|
|
677
|
+
readonly order?: 'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'openedAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency'
|
|
678
678
|
|
|
679
679
|
/**
|
|
680
680
|
* Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
@@ -55,11 +55,11 @@ export declare const CommissionAgreementVersionsApiAxiosParamCreator: (configura
|
|
|
55
55
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
56
56
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
57
57
|
* @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
|
-
* @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, agreementCode, startDate, endDate, createdAt</i>
|
|
58
|
+
* @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, agreementCode, startDate, endDate, settlementCreationDate, createdAt</i>
|
|
59
59
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
60
|
-
* @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: code, createdAt, startDate, endDate</i>
|
|
60
|
+
* @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: code, createdAt, startDate, endDate, settlementCreationDate</i>
|
|
61
61
|
* @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/> <i>Allowed values: agreements<i>
|
|
62
|
-
* @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, agreementCode, startDate, endDate, createdAt</i>
|
|
62
|
+
* @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, agreementCode, startDate, endDate, settlementCreationDate, createdAt</i>
|
|
63
63
|
* @param {*} [options] Override http request option.
|
|
64
64
|
* @throws {RequiredError}
|
|
65
65
|
*/
|
|
@@ -104,11 +104,11 @@ export declare const CommissionAgreementVersionsApiFp: (configuration?: Configur
|
|
|
104
104
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
105
105
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
106
106
|
* @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.
|
|
107
|
-
* @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, agreementCode, startDate, endDate, createdAt</i>
|
|
107
|
+
* @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, agreementCode, startDate, endDate, settlementCreationDate, createdAt</i>
|
|
108
108
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
109
|
-
* @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: code, createdAt, startDate, endDate</i>
|
|
109
|
+
* @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: code, createdAt, startDate, endDate, settlementCreationDate</i>
|
|
110
110
|
* @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/> <i>Allowed values: agreements<i>
|
|
111
|
-
* @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, agreementCode, startDate, endDate, createdAt</i>
|
|
111
|
+
* @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, agreementCode, startDate, endDate, settlementCreationDate, createdAt</i>
|
|
112
112
|
* @param {*} [options] Override http request option.
|
|
113
113
|
* @throws {RequiredError}
|
|
114
114
|
*/
|
|
@@ -153,11 +153,11 @@ export declare const CommissionAgreementVersionsApiFactory: (configuration?: Con
|
|
|
153
153
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
154
154
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
155
155
|
* @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.
|
|
156
|
-
* @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, agreementCode, startDate, endDate, createdAt</i>
|
|
156
|
+
* @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, agreementCode, startDate, endDate, settlementCreationDate, createdAt</i>
|
|
157
157
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
158
|
-
* @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: code, createdAt, startDate, endDate</i>
|
|
158
|
+
* @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: code, createdAt, startDate, endDate, settlementCreationDate</i>
|
|
159
159
|
* @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/> <i>Allowed values: agreements<i>
|
|
160
|
-
* @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, agreementCode, startDate, endDate, createdAt</i>
|
|
160
|
+
* @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, agreementCode, startDate, endDate, settlementCreationDate, createdAt</i>
|
|
161
161
|
* @param {*} [options] Override http request option.
|
|
162
162
|
* @throws {RequiredError}
|
|
163
163
|
*/
|
|
@@ -251,7 +251,7 @@ export interface CommissionAgreementVersionsApiListCommissionAgreementVersionsRe
|
|
|
251
251
|
*/
|
|
252
252
|
readonly pageToken?: string;
|
|
253
253
|
/**
|
|
254
|
-
* 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, agreementCode, startDate, endDate, createdAt</i>
|
|
254
|
+
* 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, agreementCode, startDate, endDate, settlementCreationDate, createdAt</i>
|
|
255
255
|
* @type {string}
|
|
256
256
|
* @memberof CommissionAgreementVersionsApiListCommissionAgreementVersions
|
|
257
257
|
*/
|
|
@@ -263,7 +263,7 @@ export interface CommissionAgreementVersionsApiListCommissionAgreementVersionsRe
|
|
|
263
263
|
*/
|
|
264
264
|
readonly search?: string;
|
|
265
265
|
/**
|
|
266
|
-
* 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: code, createdAt, startDate, endDate</i>
|
|
266
|
+
* 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: code, createdAt, startDate, endDate, settlementCreationDate</i>
|
|
267
267
|
* @type {string}
|
|
268
268
|
* @memberof CommissionAgreementVersionsApiListCommissionAgreementVersions
|
|
269
269
|
*/
|
|
@@ -275,7 +275,7 @@ export interface CommissionAgreementVersionsApiListCommissionAgreementVersionsRe
|
|
|
275
275
|
*/
|
|
276
276
|
readonly expand?: string;
|
|
277
277
|
/**
|
|
278
|
-
* 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, agreementCode, startDate, endDate, createdAt</i>
|
|
278
|
+
* 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, agreementCode, startDate, endDate, settlementCreationDate, createdAt</i>
|
|
279
279
|
* @type {string}
|
|
280
280
|
* @memberof CommissionAgreementVersionsApiListCommissionAgreementVersions
|
|
281
281
|
*/
|
|
@@ -249,11 +249,11 @@ var CommissionAgreementVersionsApiAxiosParamCreator = function (configuration) {
|
|
|
249
249
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
250
250
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
251
251
|
* @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.
|
|
252
|
-
* @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, agreementCode, startDate, endDate, createdAt</i>
|
|
252
|
+
* @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, agreementCode, startDate, endDate, settlementCreationDate, createdAt</i>
|
|
253
253
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
254
|
-
* @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: code, createdAt, startDate, endDate</i>
|
|
254
|
+
* @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: code, createdAt, startDate, endDate, settlementCreationDate</i>
|
|
255
255
|
* @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/> <i>Allowed values: agreements<i>
|
|
256
|
-
* @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, agreementCode, startDate, endDate, createdAt</i>
|
|
256
|
+
* @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, agreementCode, startDate, endDate, settlementCreationDate, createdAt</i>
|
|
257
257
|
* @param {*} [options] Override http request option.
|
|
258
258
|
* @throws {RequiredError}
|
|
259
259
|
*/
|
|
@@ -395,11 +395,11 @@ var CommissionAgreementVersionsApiFp = function (configuration) {
|
|
|
395
395
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
396
396
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
397
397
|
* @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.
|
|
398
|
-
* @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, agreementCode, startDate, endDate, createdAt</i>
|
|
398
|
+
* @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, agreementCode, startDate, endDate, settlementCreationDate, createdAt</i>
|
|
399
399
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
400
|
-
* @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: code, createdAt, startDate, endDate</i>
|
|
400
|
+
* @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: code, createdAt, startDate, endDate, settlementCreationDate</i>
|
|
401
401
|
* @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/> <i>Allowed values: agreements<i>
|
|
402
|
-
* @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, agreementCode, startDate, endDate, createdAt</i>
|
|
402
|
+
* @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, agreementCode, startDate, endDate, settlementCreationDate, createdAt</i>
|
|
403
403
|
* @param {*} [options] Override http request option.
|
|
404
404
|
* @throws {RequiredError}
|
|
405
405
|
*/
|
|
@@ -466,11 +466,11 @@ var CommissionAgreementVersionsApiFactory = function (configuration, basePath, a
|
|
|
466
466
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
467
467
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
468
468
|
* @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.
|
|
469
|
-
* @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, agreementCode, startDate, endDate, createdAt</i>
|
|
469
|
+
* @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, agreementCode, startDate, endDate, settlementCreationDate, createdAt</i>
|
|
470
470
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
471
|
-
* @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: code, createdAt, startDate, endDate</i>
|
|
471
|
+
* @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: code, createdAt, startDate, endDate, settlementCreationDate</i>
|
|
472
472
|
* @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/> <i>Allowed values: agreements<i>
|
|
473
|
-
* @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, agreementCode, startDate, endDate, createdAt</i>
|
|
473
|
+
* @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, agreementCode, startDate, endDate, settlementCreationDate, createdAt</i>
|
|
474
474
|
* @param {*} [options] Override http request option.
|
|
475
475
|
* @throws {RequiredError}
|
|
476
476
|
*/
|
|
@@ -18,6 +18,8 @@ import { GetCommissionSettlementResponseClass } from '../models';
|
|
|
18
18
|
import { ListCommissionSettlementsResponseClass } from '../models';
|
|
19
19
|
import { PublishCommissionSettlementsRequestDto } from '../models';
|
|
20
20
|
import { PublishCommissionSettlementsResponseClass } from '../models';
|
|
21
|
+
import { TriggerCommissionSettlementCreationRequestDto } from '../models';
|
|
22
|
+
import { TriggerCommissionSettlementCreationResponseClass } from '../models';
|
|
21
23
|
import { UpdateCommissionSettlementRequestDto } from '../models';
|
|
22
24
|
import { UpdateCommissionSettlementResponseClass } from '../models';
|
|
23
25
|
/**
|
|
@@ -77,6 +79,15 @@ export declare const CommissionSettlementsApiAxiosParamCreator: (configuration?:
|
|
|
77
79
|
* @throws {RequiredError}
|
|
78
80
|
*/
|
|
79
81
|
publishCommissionSettlements: (publishCommissionSettlementsRequestDto: PublishCommissionSettlementsRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
82
|
+
/**
|
|
83
|
+
* Triggers the commission settlement creation job.
|
|
84
|
+
* @summary Create the commission settlement creation job
|
|
85
|
+
* @param {TriggerCommissionSettlementCreationRequestDto} triggerCommissionSettlementCreationRequestDto
|
|
86
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
87
|
+
* @param {*} [options] Override http request option.
|
|
88
|
+
* @throws {RequiredError}
|
|
89
|
+
*/
|
|
90
|
+
triggerCommissionSettlementCreation: (triggerCommissionSettlementCreationRequestDto: TriggerCommissionSettlementCreationRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
80
91
|
/**
|
|
81
92
|
* This will update commission settlement.
|
|
82
93
|
* @summary Update the commission settlement
|
|
@@ -145,6 +156,15 @@ export declare const CommissionSettlementsApiFp: (configuration?: Configuration)
|
|
|
145
156
|
* @throws {RequiredError}
|
|
146
157
|
*/
|
|
147
158
|
publishCommissionSettlements(publishCommissionSettlementsRequestDto: PublishCommissionSettlementsRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PublishCommissionSettlementsResponseClass>>;
|
|
159
|
+
/**
|
|
160
|
+
* Triggers the commission settlement creation job.
|
|
161
|
+
* @summary Create the commission settlement creation job
|
|
162
|
+
* @param {TriggerCommissionSettlementCreationRequestDto} triggerCommissionSettlementCreationRequestDto
|
|
163
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
164
|
+
* @param {*} [options] Override http request option.
|
|
165
|
+
* @throws {RequiredError}
|
|
166
|
+
*/
|
|
167
|
+
triggerCommissionSettlementCreation(triggerCommissionSettlementCreationRequestDto: TriggerCommissionSettlementCreationRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TriggerCommissionSettlementCreationResponseClass>>;
|
|
148
168
|
/**
|
|
149
169
|
* This will update commission settlement.
|
|
150
170
|
* @summary Update the commission settlement
|
|
@@ -213,6 +233,15 @@ export declare const CommissionSettlementsApiFactory: (configuration?: Configura
|
|
|
213
233
|
* @throws {RequiredError}
|
|
214
234
|
*/
|
|
215
235
|
publishCommissionSettlements(publishCommissionSettlementsRequestDto: PublishCommissionSettlementsRequestDto, authorization?: string, options?: any): AxiosPromise<PublishCommissionSettlementsResponseClass>;
|
|
236
|
+
/**
|
|
237
|
+
* Triggers the commission settlement creation job.
|
|
238
|
+
* @summary Create the commission settlement creation job
|
|
239
|
+
* @param {TriggerCommissionSettlementCreationRequestDto} triggerCommissionSettlementCreationRequestDto
|
|
240
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
241
|
+
* @param {*} [options] Override http request option.
|
|
242
|
+
* @throws {RequiredError}
|
|
243
|
+
*/
|
|
244
|
+
triggerCommissionSettlementCreation(triggerCommissionSettlementCreationRequestDto: TriggerCommissionSettlementCreationRequestDto, authorization?: string, options?: any): AxiosPromise<TriggerCommissionSettlementCreationResponseClass>;
|
|
216
245
|
/**
|
|
217
246
|
* This will update commission settlement.
|
|
218
247
|
* @summary Update the commission settlement
|
|
@@ -361,6 +390,25 @@ export interface CommissionSettlementsApiPublishCommissionSettlementsRequest {
|
|
|
361
390
|
*/
|
|
362
391
|
readonly authorization?: string;
|
|
363
392
|
}
|
|
393
|
+
/**
|
|
394
|
+
* Request parameters for triggerCommissionSettlementCreation operation in CommissionSettlementsApi.
|
|
395
|
+
* @export
|
|
396
|
+
* @interface CommissionSettlementsApiTriggerCommissionSettlementCreationRequest
|
|
397
|
+
*/
|
|
398
|
+
export interface CommissionSettlementsApiTriggerCommissionSettlementCreationRequest {
|
|
399
|
+
/**
|
|
400
|
+
*
|
|
401
|
+
* @type {TriggerCommissionSettlementCreationRequestDto}
|
|
402
|
+
* @memberof CommissionSettlementsApiTriggerCommissionSettlementCreation
|
|
403
|
+
*/
|
|
404
|
+
readonly triggerCommissionSettlementCreationRequestDto: TriggerCommissionSettlementCreationRequestDto;
|
|
405
|
+
/**
|
|
406
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
407
|
+
* @type {string}
|
|
408
|
+
* @memberof CommissionSettlementsApiTriggerCommissionSettlementCreation
|
|
409
|
+
*/
|
|
410
|
+
readonly authorization?: string;
|
|
411
|
+
}
|
|
364
412
|
/**
|
|
365
413
|
* Request parameters for updateCommissionSettlement operation in CommissionSettlementsApi.
|
|
366
414
|
* @export
|
|
@@ -438,6 +486,15 @@ export declare class CommissionSettlementsApi extends BaseAPI {
|
|
|
438
486
|
* @memberof CommissionSettlementsApi
|
|
439
487
|
*/
|
|
440
488
|
publishCommissionSettlements(requestParameters: CommissionSettlementsApiPublishCommissionSettlementsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PublishCommissionSettlementsResponseClass, any, {}>>;
|
|
489
|
+
/**
|
|
490
|
+
* Triggers the commission settlement creation job.
|
|
491
|
+
* @summary Create the commission settlement creation job
|
|
492
|
+
* @param {CommissionSettlementsApiTriggerCommissionSettlementCreationRequest} requestParameters Request parameters.
|
|
493
|
+
* @param {*} [options] Override http request option.
|
|
494
|
+
* @throws {RequiredError}
|
|
495
|
+
* @memberof CommissionSettlementsApi
|
|
496
|
+
*/
|
|
497
|
+
triggerCommissionSettlementCreation(requestParameters: CommissionSettlementsApiTriggerCommissionSettlementCreationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<TriggerCommissionSettlementCreationResponseClass, any, {}>>;
|
|
441
498
|
/**
|
|
442
499
|
* This will update commission settlement.
|
|
443
500
|
* @summary Update the commission settlement
|