@emilgroup/settlement-sdk 0.3.1-beta.6 → 0.3.1-beta.8
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 +1 -0
- package/README.md +2 -2
- package/api/settlements-api.ts +63 -46
- package/dist/api/settlements-api.d.ts +53 -43
- package/dist/api/settlements-api.js +48 -41
- package/dist/models/add-settlement-entry-request-body-dto.d.ts +25 -0
- package/dist/models/add-settlement-entry-request-body-dto.js +15 -0
- package/dist/models/index.d.ts +1 -0
- package/dist/models/index.js +1 -0
- package/dist/models/settlement-entry-class.d.ts +30 -3
- package/dist/models/settlement-entry-class.js +25 -1
- package/dist/models/settlement-entry-input-dto.d.ts +1 -0
- package/dist/models/settlement-entry-input-dto.js +1 -0
- package/models/add-settlement-entry-request-body-dto.ts +31 -0
- package/models/index.ts +1 -0
- package/models/settlement-entry-class.ts +33 -3
- package/models/settlement-entry-input-dto.ts +1 -0
- package/package.json +1 -1
package/.openapi-generator/FILES
CHANGED
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/settlement-sdk@0.3.1-beta.
|
|
20
|
+
npm install @emilgroup/settlement-sdk@0.3.1-beta.8 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/settlement-sdk@0.3.1-beta.
|
|
24
|
+
yarn add @emilgroup/settlement-sdk@0.3.1-beta.8
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import ``.
|
package/api/settlements-api.ts
CHANGED
|
@@ -21,6 +21,8 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj
|
|
|
21
21
|
// @ts-ignore
|
|
22
22
|
import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
|
|
23
23
|
// @ts-ignore
|
|
24
|
+
import { AddSettlementEntryRequestBodyDto } from '../models';
|
|
25
|
+
// @ts-ignore
|
|
24
26
|
import { AddSettlementEntryResponseClass } from '../models';
|
|
25
27
|
// @ts-ignore
|
|
26
28
|
import { CreateSettlementRequestDto } from '../models';
|
|
@@ -37,16 +39,19 @@ import { ListSettlementsResponseClass } from '../models';
|
|
|
37
39
|
export const SettlementsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
38
40
|
return {
|
|
39
41
|
/**
|
|
40
|
-
* This will add settlement entry. **Required Permissions**
|
|
42
|
+
* This will add settlement entry. **Required Permissions** \"payment-management.settlements.create\"
|
|
41
43
|
* @summary Create the settlement entry
|
|
42
44
|
* @param {string} settlementCode
|
|
45
|
+
* @param {AddSettlementEntryRequestBodyDto} addSettlementEntryRequestBodyDto
|
|
43
46
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
44
47
|
* @param {*} [options] Override http request option.
|
|
45
48
|
* @throws {RequiredError}
|
|
46
49
|
*/
|
|
47
|
-
addSettlementEntry: async (settlementCode: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
50
|
+
addSettlementEntry: async (settlementCode: string, addSettlementEntryRequestBodyDto: AddSettlementEntryRequestBodyDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
48
51
|
// verify required parameter 'settlementCode' is not null or undefined
|
|
49
52
|
assertParamExists('addSettlementEntry', 'settlementCode', settlementCode)
|
|
53
|
+
// verify required parameter 'addSettlementEntryRequestBodyDto' is not null or undefined
|
|
54
|
+
assertParamExists('addSettlementEntry', 'addSettlementEntryRequestBodyDto', addSettlementEntryRequestBodyDto)
|
|
50
55
|
const localVarPath = `/settlementservice/v1/settlements/{settlementCode}/entries`
|
|
51
56
|
.replace(`{${"settlementCode"}}`, encodeURIComponent(String(settlementCode)));
|
|
52
57
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -72,9 +77,12 @@ export const SettlementsApiAxiosParamCreator = function (configuration?: Configu
|
|
|
72
77
|
|
|
73
78
|
|
|
74
79
|
|
|
80
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
81
|
+
|
|
75
82
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
76
83
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
77
84
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
85
|
+
localVarRequestOptions.data = serializeDataIfNeeded(addSettlementEntryRequestBodyDto, localVarRequestOptions, configuration)
|
|
78
86
|
|
|
79
87
|
return {
|
|
80
88
|
url: toPathString(localVarUrlObj),
|
|
@@ -82,7 +90,7 @@ export const SettlementsApiAxiosParamCreator = function (configuration?: Configu
|
|
|
82
90
|
};
|
|
83
91
|
},
|
|
84
92
|
/**
|
|
85
|
-
* This will create settlement. **Required Permissions**
|
|
93
|
+
* This will create settlement. **Required Permissions** \"payment-management.settlements.create\"
|
|
86
94
|
* @summary Create the settlement
|
|
87
95
|
* @param {CreateSettlementRequestDto} createSettlementRequestDto
|
|
88
96
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -129,7 +137,7 @@ export const SettlementsApiAxiosParamCreator = function (configuration?: Configu
|
|
|
129
137
|
};
|
|
130
138
|
},
|
|
131
139
|
/**
|
|
132
|
-
* This will delete settlement. **Required Permissions**
|
|
140
|
+
* This will delete settlement. **Required Permissions** \"payment-management.settlements.delete\"
|
|
133
141
|
* @summary Delete the settlement
|
|
134
142
|
* @param {string} code Unique identifier for the object.
|
|
135
143
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -174,7 +182,7 @@ export const SettlementsApiAxiosParamCreator = function (configuration?: Configu
|
|
|
174
182
|
};
|
|
175
183
|
},
|
|
176
184
|
/**
|
|
177
|
-
* This will get settlement. **Required Permissions**
|
|
185
|
+
* This will get settlement. **Required Permissions** \"payment-management.settlements.view\"
|
|
178
186
|
* @summary Retrieve the settlement
|
|
179
187
|
* @param {string} code
|
|
180
188
|
* @param {string} expand
|
|
@@ -226,16 +234,16 @@ export const SettlementsApiAxiosParamCreator = function (configuration?: Configu
|
|
|
226
234
|
};
|
|
227
235
|
},
|
|
228
236
|
/**
|
|
229
|
-
* Retrieves a list of settlements. **Required Permissions**
|
|
237
|
+
* Retrieves a list of settlements. **Required Permissions** \"payment-management.settlements.view\"
|
|
230
238
|
* @summary List settlements
|
|
231
239
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
232
240
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
233
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.
|
|
234
|
-
* @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:
|
|
235
|
-
* @param {string} [search]
|
|
236
|
-
* @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>
|
|
237
|
-
* @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/>
|
|
238
|
-
* @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:
|
|
242
|
+
* @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: code, settlementNumber, domainEntityCode, domainEntityType, domainEntityNumber, partnerCode, status, currency, createdAt</i>
|
|
243
|
+
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: code, settlementNumber, domainEntityCode, domainEntityNumber, partnerCode</i>
|
|
244
|
+
* @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: status, balance, createdAt</i>
|
|
245
|
+
* @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: settlementEntries<i>
|
|
246
|
+
* @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: code, settlementNumber, domainEntityCode, domainEntityType, domainEntityNumber, partnerCode, status, currency, createdAt</i>
|
|
239
247
|
* @param {*} [options] Override http request option.
|
|
240
248
|
* @throws {RequiredError}
|
|
241
249
|
*/
|
|
@@ -312,19 +320,20 @@ export const SettlementsApiFp = function(configuration?: Configuration) {
|
|
|
312
320
|
const localVarAxiosParamCreator = SettlementsApiAxiosParamCreator(configuration)
|
|
313
321
|
return {
|
|
314
322
|
/**
|
|
315
|
-
* This will add settlement entry. **Required Permissions**
|
|
323
|
+
* This will add settlement entry. **Required Permissions** \"payment-management.settlements.create\"
|
|
316
324
|
* @summary Create the settlement entry
|
|
317
325
|
* @param {string} settlementCode
|
|
326
|
+
* @param {AddSettlementEntryRequestBodyDto} addSettlementEntryRequestBodyDto
|
|
318
327
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
319
328
|
* @param {*} [options] Override http request option.
|
|
320
329
|
* @throws {RequiredError}
|
|
321
330
|
*/
|
|
322
|
-
async addSettlementEntry(settlementCode: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AddSettlementEntryResponseClass>> {
|
|
323
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.addSettlementEntry(settlementCode, authorization, options);
|
|
331
|
+
async addSettlementEntry(settlementCode: string, addSettlementEntryRequestBodyDto: AddSettlementEntryRequestBodyDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AddSettlementEntryResponseClass>> {
|
|
332
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.addSettlementEntry(settlementCode, addSettlementEntryRequestBodyDto, authorization, options);
|
|
324
333
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
325
334
|
},
|
|
326
335
|
/**
|
|
327
|
-
* This will create settlement. **Required Permissions**
|
|
336
|
+
* This will create settlement. **Required Permissions** \"payment-management.settlements.create\"
|
|
328
337
|
* @summary Create the settlement
|
|
329
338
|
* @param {CreateSettlementRequestDto} createSettlementRequestDto
|
|
330
339
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -336,7 +345,7 @@ export const SettlementsApiFp = function(configuration?: Configuration) {
|
|
|
336
345
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
337
346
|
},
|
|
338
347
|
/**
|
|
339
|
-
* This will delete settlement. **Required Permissions**
|
|
348
|
+
* This will delete settlement. **Required Permissions** \"payment-management.settlements.delete\"
|
|
340
349
|
* @summary Delete the settlement
|
|
341
350
|
* @param {string} code Unique identifier for the object.
|
|
342
351
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -348,7 +357,7 @@ export const SettlementsApiFp = function(configuration?: Configuration) {
|
|
|
348
357
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
349
358
|
},
|
|
350
359
|
/**
|
|
351
|
-
* This will get settlement. **Required Permissions**
|
|
360
|
+
* This will get settlement. **Required Permissions** \"payment-management.settlements.view\"
|
|
352
361
|
* @summary Retrieve the settlement
|
|
353
362
|
* @param {string} code
|
|
354
363
|
* @param {string} expand
|
|
@@ -361,16 +370,16 @@ export const SettlementsApiFp = function(configuration?: Configuration) {
|
|
|
361
370
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
362
371
|
},
|
|
363
372
|
/**
|
|
364
|
-
* Retrieves a list of settlements. **Required Permissions**
|
|
373
|
+
* Retrieves a list of settlements. **Required Permissions** \"payment-management.settlements.view\"
|
|
365
374
|
* @summary List settlements
|
|
366
375
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
367
376
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
368
377
|
* @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.
|
|
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:
|
|
370
|
-
* @param {string} [search]
|
|
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>
|
|
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:
|
|
378
|
+
* @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: code, settlementNumber, domainEntityCode, domainEntityType, domainEntityNumber, partnerCode, status, currency, createdAt</i>
|
|
379
|
+
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: code, settlementNumber, domainEntityCode, domainEntityNumber, partnerCode</i>
|
|
380
|
+
* @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: status, balance, createdAt</i>
|
|
381
|
+
* @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: settlementEntries<i>
|
|
382
|
+
* @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: code, settlementNumber, domainEntityCode, domainEntityType, domainEntityNumber, partnerCode, status, currency, createdAt</i>
|
|
374
383
|
* @param {*} [options] Override http request option.
|
|
375
384
|
* @throws {RequiredError}
|
|
376
385
|
*/
|
|
@@ -389,18 +398,19 @@ export const SettlementsApiFactory = function (configuration?: Configuration, ba
|
|
|
389
398
|
const localVarFp = SettlementsApiFp(configuration)
|
|
390
399
|
return {
|
|
391
400
|
/**
|
|
392
|
-
* This will add settlement entry. **Required Permissions**
|
|
401
|
+
* This will add settlement entry. **Required Permissions** \"payment-management.settlements.create\"
|
|
393
402
|
* @summary Create the settlement entry
|
|
394
403
|
* @param {string} settlementCode
|
|
404
|
+
* @param {AddSettlementEntryRequestBodyDto} addSettlementEntryRequestBodyDto
|
|
395
405
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
396
406
|
* @param {*} [options] Override http request option.
|
|
397
407
|
* @throws {RequiredError}
|
|
398
408
|
*/
|
|
399
|
-
addSettlementEntry(settlementCode: string, authorization?: string, options?: any): AxiosPromise<AddSettlementEntryResponseClass> {
|
|
400
|
-
return localVarFp.addSettlementEntry(settlementCode, authorization, options).then((request) => request(axios, basePath));
|
|
409
|
+
addSettlementEntry(settlementCode: string, addSettlementEntryRequestBodyDto: AddSettlementEntryRequestBodyDto, authorization?: string, options?: any): AxiosPromise<AddSettlementEntryResponseClass> {
|
|
410
|
+
return localVarFp.addSettlementEntry(settlementCode, addSettlementEntryRequestBodyDto, authorization, options).then((request) => request(axios, basePath));
|
|
401
411
|
},
|
|
402
412
|
/**
|
|
403
|
-
* This will create settlement. **Required Permissions**
|
|
413
|
+
* This will create settlement. **Required Permissions** \"payment-management.settlements.create\"
|
|
404
414
|
* @summary Create the settlement
|
|
405
415
|
* @param {CreateSettlementRequestDto} createSettlementRequestDto
|
|
406
416
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -411,7 +421,7 @@ export const SettlementsApiFactory = function (configuration?: Configuration, ba
|
|
|
411
421
|
return localVarFp.createSettlement(createSettlementRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
412
422
|
},
|
|
413
423
|
/**
|
|
414
|
-
* This will delete settlement. **Required Permissions**
|
|
424
|
+
* This will delete settlement. **Required Permissions** \"payment-management.settlements.delete\"
|
|
415
425
|
* @summary Delete the settlement
|
|
416
426
|
* @param {string} code Unique identifier for the object.
|
|
417
427
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -422,7 +432,7 @@ export const SettlementsApiFactory = function (configuration?: Configuration, ba
|
|
|
422
432
|
return localVarFp.deleteSettlement(code, authorization, options).then((request) => request(axios, basePath));
|
|
423
433
|
},
|
|
424
434
|
/**
|
|
425
|
-
* This will get settlement. **Required Permissions**
|
|
435
|
+
* This will get settlement. **Required Permissions** \"payment-management.settlements.view\"
|
|
426
436
|
* @summary Retrieve the settlement
|
|
427
437
|
* @param {string} code
|
|
428
438
|
* @param {string} expand
|
|
@@ -434,16 +444,16 @@ export const SettlementsApiFactory = function (configuration?: Configuration, ba
|
|
|
434
444
|
return localVarFp.getSettlement(code, expand, authorization, options).then((request) => request(axios, basePath));
|
|
435
445
|
},
|
|
436
446
|
/**
|
|
437
|
-
* Retrieves a list of settlements. **Required Permissions**
|
|
447
|
+
* Retrieves a list of settlements. **Required Permissions** \"payment-management.settlements.view\"
|
|
438
448
|
* @summary List settlements
|
|
439
449
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
440
450
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
441
451
|
* @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.
|
|
442
|
-
* @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:
|
|
443
|
-
* @param {string} [search]
|
|
444
|
-
* @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>
|
|
445
|
-
* @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/>
|
|
446
|
-
* @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:
|
|
452
|
+
* @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: code, settlementNumber, domainEntityCode, domainEntityType, domainEntityNumber, partnerCode, status, currency, createdAt</i>
|
|
453
|
+
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: code, settlementNumber, domainEntityCode, domainEntityNumber, partnerCode</i>
|
|
454
|
+
* @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: status, balance, createdAt</i>
|
|
455
|
+
* @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: settlementEntries<i>
|
|
456
|
+
* @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: code, settlementNumber, domainEntityCode, domainEntityType, domainEntityNumber, partnerCode, status, currency, createdAt</i>
|
|
447
457
|
* @param {*} [options] Override http request option.
|
|
448
458
|
* @throws {RequiredError}
|
|
449
459
|
*/
|
|
@@ -466,6 +476,13 @@ export interface SettlementsApiAddSettlementEntryRequest {
|
|
|
466
476
|
*/
|
|
467
477
|
readonly settlementCode: string
|
|
468
478
|
|
|
479
|
+
/**
|
|
480
|
+
*
|
|
481
|
+
* @type {AddSettlementEntryRequestBodyDto}
|
|
482
|
+
* @memberof SettlementsApiAddSettlementEntry
|
|
483
|
+
*/
|
|
484
|
+
readonly addSettlementEntryRequestBodyDto: AddSettlementEntryRequestBodyDto
|
|
485
|
+
|
|
469
486
|
/**
|
|
470
487
|
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
471
488
|
* @type {string}
|
|
@@ -572,35 +589,35 @@ export interface SettlementsApiListSettlementsRequest {
|
|
|
572
589
|
readonly pageToken?: string
|
|
573
590
|
|
|
574
591
|
/**
|
|
575
|
-
* 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:
|
|
592
|
+
* 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: code, settlementNumber, domainEntityCode, domainEntityType, domainEntityNumber, partnerCode, status, currency, createdAt</i>
|
|
576
593
|
* @type {string}
|
|
577
594
|
* @memberof SettlementsApiListSettlements
|
|
578
595
|
*/
|
|
579
596
|
readonly filter?: string
|
|
580
597
|
|
|
581
598
|
/**
|
|
582
|
-
*
|
|
599
|
+
* Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: code, settlementNumber, domainEntityCode, domainEntityNumber, partnerCode</i>
|
|
583
600
|
* @type {string}
|
|
584
601
|
* @memberof SettlementsApiListSettlements
|
|
585
602
|
*/
|
|
586
603
|
readonly search?: string
|
|
587
604
|
|
|
588
605
|
/**
|
|
589
|
-
* 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>
|
|
606
|
+
* 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: status, balance, createdAt</i>
|
|
590
607
|
* @type {string}
|
|
591
608
|
* @memberof SettlementsApiListSettlements
|
|
592
609
|
*/
|
|
593
610
|
readonly order?: string
|
|
594
611
|
|
|
595
612
|
/**
|
|
596
|
-
* 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/>
|
|
613
|
+
* 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: settlementEntries<i>
|
|
597
614
|
* @type {string}
|
|
598
615
|
* @memberof SettlementsApiListSettlements
|
|
599
616
|
*/
|
|
600
617
|
readonly expand?: string
|
|
601
618
|
|
|
602
619
|
/**
|
|
603
|
-
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values:
|
|
620
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, settlementNumber, domainEntityCode, domainEntityType, domainEntityNumber, partnerCode, status, currency, createdAt</i>
|
|
604
621
|
* @type {string}
|
|
605
622
|
* @memberof SettlementsApiListSettlements
|
|
606
623
|
*/
|
|
@@ -615,7 +632,7 @@ export interface SettlementsApiListSettlementsRequest {
|
|
|
615
632
|
*/
|
|
616
633
|
export class SettlementsApi extends BaseAPI {
|
|
617
634
|
/**
|
|
618
|
-
* This will add settlement entry. **Required Permissions**
|
|
635
|
+
* This will add settlement entry. **Required Permissions** \"payment-management.settlements.create\"
|
|
619
636
|
* @summary Create the settlement entry
|
|
620
637
|
* @param {SettlementsApiAddSettlementEntryRequest} requestParameters Request parameters.
|
|
621
638
|
* @param {*} [options] Override http request option.
|
|
@@ -623,11 +640,11 @@ export class SettlementsApi extends BaseAPI {
|
|
|
623
640
|
* @memberof SettlementsApi
|
|
624
641
|
*/
|
|
625
642
|
public addSettlementEntry(requestParameters: SettlementsApiAddSettlementEntryRequest, options?: AxiosRequestConfig) {
|
|
626
|
-
return SettlementsApiFp(this.configuration).addSettlementEntry(requestParameters.settlementCode, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
643
|
+
return SettlementsApiFp(this.configuration).addSettlementEntry(requestParameters.settlementCode, requestParameters.addSettlementEntryRequestBodyDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
627
644
|
}
|
|
628
645
|
|
|
629
646
|
/**
|
|
630
|
-
* This will create settlement. **Required Permissions**
|
|
647
|
+
* This will create settlement. **Required Permissions** \"payment-management.settlements.create\"
|
|
631
648
|
* @summary Create the settlement
|
|
632
649
|
* @param {SettlementsApiCreateSettlementRequest} requestParameters Request parameters.
|
|
633
650
|
* @param {*} [options] Override http request option.
|
|
@@ -639,7 +656,7 @@ export class SettlementsApi extends BaseAPI {
|
|
|
639
656
|
}
|
|
640
657
|
|
|
641
658
|
/**
|
|
642
|
-
* This will delete settlement. **Required Permissions**
|
|
659
|
+
* This will delete settlement. **Required Permissions** \"payment-management.settlements.delete\"
|
|
643
660
|
* @summary Delete the settlement
|
|
644
661
|
* @param {SettlementsApiDeleteSettlementRequest} requestParameters Request parameters.
|
|
645
662
|
* @param {*} [options] Override http request option.
|
|
@@ -651,7 +668,7 @@ export class SettlementsApi extends BaseAPI {
|
|
|
651
668
|
}
|
|
652
669
|
|
|
653
670
|
/**
|
|
654
|
-
* This will get settlement. **Required Permissions**
|
|
671
|
+
* This will get settlement. **Required Permissions** \"payment-management.settlements.view\"
|
|
655
672
|
* @summary Retrieve the settlement
|
|
656
673
|
* @param {SettlementsApiGetSettlementRequest} requestParameters Request parameters.
|
|
657
674
|
* @param {*} [options] Override http request option.
|
|
@@ -663,7 +680,7 @@ export class SettlementsApi extends BaseAPI {
|
|
|
663
680
|
}
|
|
664
681
|
|
|
665
682
|
/**
|
|
666
|
-
* Retrieves a list of settlements. **Required Permissions**
|
|
683
|
+
* Retrieves a list of settlements. **Required Permissions** \"payment-management.settlements.view\"
|
|
667
684
|
* @summary List settlements
|
|
668
685
|
* @param {SettlementsApiListSettlementsRequest} requestParameters Request parameters.
|
|
669
686
|
* @param {*} [options] Override http request option.
|