@emilgroup/payment-sdk-node 1.23.1-beta.4 → 1.23.1-beta.41
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 +12 -0
- package/README.md +2 -2
- package/api/bank-accounts-api.ts +16 -16
- package/api/bank-orders-api.ts +12 -12
- package/api/bank-transaction-api.ts +12 -12
- package/api/billing-addresses-api.ts +12 -12
- package/api/credit-allocation-api.ts +12 -12
- package/api/exceeding-credits-api.ts +12 -12
- package/api/ibanvalidator-api.ts +169 -0
- package/api/payment-methods-api.ts +12 -12
- package/api/payment-receipts-api.ts +680 -0
- package/api/payment-reminders-api.ts +12 -12
- package/api/payment-requests-api.ts +121 -20
- package/api/payments-api.ts +12 -12
- package/api/payout-methods-api.ts +138 -20
- package/api/refunds-api.ts +12 -12
- package/api/tenant-bank-account-api.ts +12 -12
- package/api.ts +4 -0
- package/dist/api/bank-accounts-api.d.ts +16 -16
- package/dist/api/bank-accounts-api.js +13 -13
- package/dist/api/bank-orders-api.d.ts +12 -12
- package/dist/api/bank-orders-api.js +10 -10
- package/dist/api/bank-transaction-api.d.ts +12 -12
- package/dist/api/bank-transaction-api.js +10 -10
- package/dist/api/billing-addresses-api.d.ts +12 -12
- package/dist/api/billing-addresses-api.js +10 -10
- package/dist/api/credit-allocation-api.d.ts +12 -12
- package/dist/api/credit-allocation-api.js +10 -10
- package/dist/api/exceeding-credits-api.d.ts +12 -12
- package/dist/api/exceeding-credits-api.js +10 -10
- package/dist/api/ibanvalidator-api.d.ts +97 -0
- package/dist/api/ibanvalidator-api.js +228 -0
- package/dist/api/payment-methods-api.d.ts +12 -12
- package/dist/api/payment-methods-api.js +10 -10
- package/dist/api/payment-receipts-api.d.ts +383 -0
- package/dist/api/payment-receipts-api.js +641 -0
- package/dist/api/payment-reminders-api.d.ts +12 -12
- package/dist/api/payment-reminders-api.js +10 -10
- package/dist/api/payment-requests-api.d.ts +75 -20
- package/dist/api/payment-requests-api.js +107 -15
- package/dist/api/payments-api.d.ts +12 -12
- package/dist/api/payments-api.js +10 -10
- package/dist/api/payout-methods-api.d.ts +85 -20
- package/dist/api/payout-methods-api.js +115 -16
- package/dist/api/refunds-api.d.ts +12 -12
- package/dist/api/refunds-api.js +10 -10
- package/dist/api/tenant-bank-account-api.d.ts +12 -12
- package/dist/api/tenant-bank-account-api.js +10 -10
- package/dist/api.d.ts +2 -0
- package/dist/api.js +2 -0
- package/dist/models/bank-account-class-without-expand-properties.d.ts +6 -0
- package/dist/models/bank-account-class.d.ts +6 -0
- package/dist/models/bank-data-class.d.ts +36 -0
- package/dist/models/bank-data-class.js +15 -0
- package/dist/models/create-payment-receipt-request-dto.d.ts +54 -0
- package/dist/models/create-payment-receipt-request-dto.js +15 -0
- package/dist/models/create-payment-receipt-response-class.d.ts +25 -0
- package/dist/models/create-payment-receipt-response-class.js +15 -0
- package/dist/models/create-payment-request-request-dto.d.ts +38 -9
- package/dist/models/create-payment-request-request-dto.js +8 -4
- package/dist/models/create-payout-method-by-bank-account-request-dto.d.ts +36 -0
- package/dist/models/create-payout-method-by-bank-account-request-dto.js +15 -0
- package/dist/models/create-payout-method-request-dto.d.ts +8 -2
- package/dist/models/get-payment-receipt-response-class.d.ts +25 -0
- package/dist/models/get-payment-receipt-response-class.js +15 -0
- package/dist/models/index.d.ts +10 -0
- package/dist/models/index.js +10 -0
- package/dist/models/list-payment-receipts-response-class.d.ts +43 -0
- package/dist/models/list-payment-receipts-response-class.js +15 -0
- package/dist/models/payment-receipt-class.d.ts +90 -0
- package/dist/models/payment-receipt-class.js +15 -0
- package/dist/models/payment-request-class.d.ts +54 -12
- package/dist/models/payment-request-class.js +11 -7
- package/dist/models/payout-method-class.d.ts +6 -0
- package/dist/models/update-payment-receipt-response-class.d.ts +25 -0
- package/dist/models/update-payment-receipt-response-class.js +15 -0
- package/dist/models/update-payment-request-request-dto.d.ts +4 -4
- package/dist/models/update-payment-request-request-dto.js +3 -3
- package/dist/models/validate-iban-request-dto.d.ts +24 -0
- package/dist/models/validate-iban-request-dto.js +15 -0
- package/dist/models/validate-iban-response-class.d.ts +31 -0
- package/dist/models/validate-iban-response-class.js +15 -0
- package/models/bank-account-class-without-expand-properties.ts +6 -0
- package/models/bank-account-class.ts +6 -0
- package/models/bank-data-class.ts +42 -0
- package/models/create-payment-receipt-request-dto.ts +60 -0
- package/models/create-payment-receipt-response-class.ts +31 -0
- package/models/create-payment-request-request-dto.ts +39 -9
- package/models/create-payout-method-by-bank-account-request-dto.ts +42 -0
- package/models/create-payout-method-request-dto.ts +8 -2
- package/models/get-payment-receipt-response-class.ts +31 -0
- package/models/index.ts +10 -0
- package/models/list-payment-receipts-response-class.ts +49 -0
- package/models/payment-receipt-class.ts +96 -0
- package/models/payment-request-class.ts +55 -12
- package/models/payout-method-class.ts +6 -0
- package/models/update-payment-receipt-response-class.ts +31 -0
- package/models/update-payment-request-request-dto.ts +4 -4
- package/models/validate-iban-request-dto.ts +30 -0
- package/models/validate-iban-response-class.ts +37 -0
- package/package.json +1 -1
|
@@ -186,16 +186,16 @@ export const PaymentRemindersApiAxiosParamCreator = function (configuration?: Co
|
|
|
186
186
|
};
|
|
187
187
|
},
|
|
188
188
|
/**
|
|
189
|
-
* Returns a list of payment reminders you have previously created.
|
|
189
|
+
* Returns a list of payment reminders you have previously created. The payment reminders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.reminders.view\"
|
|
190
190
|
* @summary List payment reminders
|
|
191
191
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
192
192
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
193
193
|
* @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.
|
|
194
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
194
|
+
* @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, id, policyCode, nextReminderDate</i>
|
|
195
195
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
196
196
|
* @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: id, createdAt, updatedAt</i>
|
|
197
197
|
* @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/>
|
|
198
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
198
|
+
* @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, id, policyCode, nextReminderDate</i>
|
|
199
199
|
* @param {*} [options] Override http request option.
|
|
200
200
|
* @throws {RequiredError}
|
|
201
201
|
*/
|
|
@@ -309,16 +309,16 @@ export const PaymentRemindersApiFp = function(configuration?: Configuration) {
|
|
|
309
309
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
310
310
|
},
|
|
311
311
|
/**
|
|
312
|
-
* Returns a list of payment reminders you have previously created.
|
|
312
|
+
* Returns a list of payment reminders you have previously created. The payment reminders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.reminders.view\"
|
|
313
313
|
* @summary List payment reminders
|
|
314
314
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
315
315
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
316
316
|
* @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.
|
|
317
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
317
|
+
* @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, id, policyCode, nextReminderDate</i>
|
|
318
318
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
319
319
|
* @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: id, createdAt, updatedAt</i>
|
|
320
320
|
* @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/>
|
|
321
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
321
|
+
* @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, id, policyCode, nextReminderDate</i>
|
|
322
322
|
* @param {*} [options] Override http request option.
|
|
323
323
|
* @throws {RequiredError}
|
|
324
324
|
*/
|
|
@@ -371,16 +371,16 @@ export const PaymentRemindersApiFactory = function (configuration?: Configuratio
|
|
|
371
371
|
return localVarFp.getPaymentReminder(code, authorization, options).then((request) => request(axios, basePath));
|
|
372
372
|
},
|
|
373
373
|
/**
|
|
374
|
-
* Returns a list of payment reminders you have previously created.
|
|
374
|
+
* Returns a list of payment reminders you have previously created. The payment reminders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.reminders.view\"
|
|
375
375
|
* @summary List payment reminders
|
|
376
376
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
377
377
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
378
378
|
* @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.
|
|
379
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
379
|
+
* @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, id, policyCode, nextReminderDate</i>
|
|
380
380
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
381
381
|
* @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: id, createdAt, updatedAt</i>
|
|
382
382
|
* @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/>
|
|
383
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
383
|
+
* @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, id, policyCode, nextReminderDate</i>
|
|
384
384
|
* @param {*} [options] Override http request option.
|
|
385
385
|
* @throws {RequiredError}
|
|
386
386
|
*/
|
|
@@ -488,7 +488,7 @@ export interface PaymentRemindersApiListPaymentRemindersRequest {
|
|
|
488
488
|
readonly pageToken?: string
|
|
489
489
|
|
|
490
490
|
/**
|
|
491
|
-
* Filter the response by one or multiple fields.
|
|
491
|
+
* 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, id, policyCode, nextReminderDate</i>
|
|
492
492
|
* @type {string}
|
|
493
493
|
* @memberof PaymentRemindersApiListPaymentReminders
|
|
494
494
|
*/
|
|
@@ -516,7 +516,7 @@ export interface PaymentRemindersApiListPaymentRemindersRequest {
|
|
|
516
516
|
readonly expand?: string
|
|
517
517
|
|
|
518
518
|
/**
|
|
519
|
-
* Filters the response by one or multiple fields.
|
|
519
|
+
* 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, id, policyCode, nextReminderDate</i>
|
|
520
520
|
* @type {string}
|
|
521
521
|
* @memberof PaymentRemindersApiListPaymentReminders
|
|
522
522
|
*/
|
|
@@ -567,7 +567,7 @@ export class PaymentRemindersApi extends BaseAPI {
|
|
|
567
567
|
}
|
|
568
568
|
|
|
569
569
|
/**
|
|
570
|
-
* Returns a list of payment reminders you have previously created.
|
|
570
|
+
* Returns a list of payment reminders you have previously created. The payment reminders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.reminders.view\"
|
|
571
571
|
* @summary List payment reminders
|
|
572
572
|
* @param {PaymentRemindersApiListPaymentRemindersRequest} requestParameters Request parameters.
|
|
573
573
|
* @param {*} [options] Override http request option.
|
|
@@ -89,6 +89,51 @@ export const PaymentRequestsApiAxiosParamCreator = function (configuration?: Con
|
|
|
89
89
|
options: localVarRequestOptions,
|
|
90
90
|
};
|
|
91
91
|
},
|
|
92
|
+
/**
|
|
93
|
+
* This will delete payment request. **Required Permissions** \"payment-management.payments.delete\"
|
|
94
|
+
* @summary Delete the payment request
|
|
95
|
+
* @param {string} code Unique identifier for the object.
|
|
96
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
97
|
+
* @param {*} [options] Override http request option.
|
|
98
|
+
* @throws {RequiredError}
|
|
99
|
+
*/
|
|
100
|
+
deletePaymentRequest: async (code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
101
|
+
// verify required parameter 'code' is not null or undefined
|
|
102
|
+
assertParamExists('deletePaymentRequest', 'code', code)
|
|
103
|
+
const localVarPath = `/paymentservice/v1/payment-requests/{code}`
|
|
104
|
+
.replace(`{${"code"}}`, encodeURIComponent(String(code)));
|
|
105
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
106
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
107
|
+
let baseOptions;
|
|
108
|
+
let baseAccessToken;
|
|
109
|
+
if (configuration) {
|
|
110
|
+
baseOptions = configuration.baseOptions;
|
|
111
|
+
baseAccessToken = configuration.accessToken;
|
|
112
|
+
}
|
|
113
|
+
|
|
114
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
|
|
115
|
+
const localVarHeaderParameter = {} as any;
|
|
116
|
+
const localVarQueryParameter = {} as any;
|
|
117
|
+
|
|
118
|
+
// authentication bearer required
|
|
119
|
+
// http bearer authentication required
|
|
120
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
121
|
+
|
|
122
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
123
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
124
|
+
}
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
129
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
130
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
131
|
+
|
|
132
|
+
return {
|
|
133
|
+
url: toPathString(localVarUrlObj),
|
|
134
|
+
options: localVarRequestOptions,
|
|
135
|
+
};
|
|
136
|
+
},
|
|
92
137
|
/**
|
|
93
138
|
* This will get payment request. **Required Permissions** \"payment-management.payments.view\"
|
|
94
139
|
* @summary Retrieve the payment request
|
|
@@ -147,11 +192,11 @@ export const PaymentRequestsApiAxiosParamCreator = function (configuration?: Con
|
|
|
147
192
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
148
193
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
149
194
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
150
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
151
|
-
* @param {string} [search]
|
|
152
|
-
* @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>
|
|
153
|
-
* @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/>
|
|
154
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
195
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, paymentRequestNumber, status, direction, financialEntityType, domainEntityType, paymentMethodPsp, paymentMethodType, createdAt</i>
|
|
196
|
+
* @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, paymentRequestNumber, financialEntityCode, financialEntityNumber, domainEntityCode, domainEntityNumber</i>
|
|
197
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, paymentRequestNumber, financialEntityNumber, domainEntityNumber, createdAt, status</i>
|
|
198
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: paymentReceipts<i>
|
|
199
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, paymentRequestNumber, status, direction, financialEntityType, domainEntityType, paymentMethodPsp, paymentMethodType, createdAt</i>
|
|
155
200
|
* @param {*} [options] Override http request option.
|
|
156
201
|
* @throws {RequiredError}
|
|
157
202
|
*/
|
|
@@ -290,6 +335,18 @@ export const PaymentRequestsApiFp = function(configuration?: Configuration) {
|
|
|
290
335
|
const localVarAxiosArgs = await localVarAxiosParamCreator.createPaymentRequest(createPaymentRequestRequestDto, authorization, options);
|
|
291
336
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
292
337
|
},
|
|
338
|
+
/**
|
|
339
|
+
* This will delete payment request. **Required Permissions** \"payment-management.payments.delete\"
|
|
340
|
+
* @summary Delete the payment request
|
|
341
|
+
* @param {string} code Unique identifier for the object.
|
|
342
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
343
|
+
* @param {*} [options] Override http request option.
|
|
344
|
+
* @throws {RequiredError}
|
|
345
|
+
*/
|
|
346
|
+
async deletePaymentRequest(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>> {
|
|
347
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.deletePaymentRequest(code, authorization, options);
|
|
348
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
349
|
+
},
|
|
293
350
|
/**
|
|
294
351
|
* This will get payment request. **Required Permissions** \"payment-management.payments.view\"
|
|
295
352
|
* @summary Retrieve the payment request
|
|
@@ -309,11 +366,11 @@ export const PaymentRequestsApiFp = function(configuration?: Configuration) {
|
|
|
309
366
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
310
367
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
311
368
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
312
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
313
|
-
* @param {string} [search]
|
|
314
|
-
* @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>
|
|
315
|
-
* @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/>
|
|
316
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
369
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, paymentRequestNumber, status, direction, financialEntityType, domainEntityType, paymentMethodPsp, paymentMethodType, createdAt</i>
|
|
370
|
+
* @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, paymentRequestNumber, financialEntityCode, financialEntityNumber, domainEntityCode, domainEntityNumber</i>
|
|
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: id, paymentRequestNumber, financialEntityNumber, domainEntityNumber, createdAt, status</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/> <i>Allowed values: paymentReceipts<i>
|
|
373
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, paymentRequestNumber, status, direction, financialEntityType, domainEntityType, paymentMethodPsp, paymentMethodType, createdAt</i>
|
|
317
374
|
* @param {*} [options] Override http request option.
|
|
318
375
|
* @throws {RequiredError}
|
|
319
376
|
*/
|
|
@@ -355,6 +412,17 @@ export const PaymentRequestsApiFactory = function (configuration?: Configuration
|
|
|
355
412
|
createPaymentRequest(createPaymentRequestRequestDto: CreatePaymentRequestRequestDto, authorization?: string, options?: any): AxiosPromise<CreatePaymentRequestResponseClass> {
|
|
356
413
|
return localVarFp.createPaymentRequest(createPaymentRequestRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
357
414
|
},
|
|
415
|
+
/**
|
|
416
|
+
* This will delete payment request. **Required Permissions** \"payment-management.payments.delete\"
|
|
417
|
+
* @summary Delete the payment request
|
|
418
|
+
* @param {string} code Unique identifier for the object.
|
|
419
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
420
|
+
* @param {*} [options] Override http request option.
|
|
421
|
+
* @throws {RequiredError}
|
|
422
|
+
*/
|
|
423
|
+
deletePaymentRequest(code: string, authorization?: string, options?: any): AxiosPromise<object> {
|
|
424
|
+
return localVarFp.deletePaymentRequest(code, authorization, options).then((request) => request(axios, basePath));
|
|
425
|
+
},
|
|
358
426
|
/**
|
|
359
427
|
* This will get payment request. **Required Permissions** \"payment-management.payments.view\"
|
|
360
428
|
* @summary Retrieve the payment request
|
|
@@ -373,11 +441,11 @@ export const PaymentRequestsApiFactory = function (configuration?: Configuration
|
|
|
373
441
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
374
442
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
375
443
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
376
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
377
|
-
* @param {string} [search]
|
|
378
|
-
* @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>
|
|
379
|
-
* @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/>
|
|
380
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
444
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, paymentRequestNumber, status, direction, financialEntityType, domainEntityType, paymentMethodPsp, paymentMethodType, createdAt</i>
|
|
445
|
+
* @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, paymentRequestNumber, financialEntityCode, financialEntityNumber, domainEntityCode, domainEntityNumber</i>
|
|
446
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, paymentRequestNumber, financialEntityNumber, domainEntityNumber, createdAt, status</i>
|
|
447
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: paymentReceipts<i>
|
|
448
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, paymentRequestNumber, status, direction, financialEntityType, domainEntityType, paymentMethodPsp, paymentMethodType, createdAt</i>
|
|
381
449
|
* @param {*} [options] Override http request option.
|
|
382
450
|
* @throws {RequiredError}
|
|
383
451
|
*/
|
|
@@ -420,6 +488,27 @@ export interface PaymentRequestsApiCreatePaymentRequestRequest {
|
|
|
420
488
|
readonly authorization?: string
|
|
421
489
|
}
|
|
422
490
|
|
|
491
|
+
/**
|
|
492
|
+
* Request parameters for deletePaymentRequest operation in PaymentRequestsApi.
|
|
493
|
+
* @export
|
|
494
|
+
* @interface PaymentRequestsApiDeletePaymentRequestRequest
|
|
495
|
+
*/
|
|
496
|
+
export interface PaymentRequestsApiDeletePaymentRequestRequest {
|
|
497
|
+
/**
|
|
498
|
+
* Unique identifier for the object.
|
|
499
|
+
* @type {string}
|
|
500
|
+
* @memberof PaymentRequestsApiDeletePaymentRequest
|
|
501
|
+
*/
|
|
502
|
+
readonly code: string
|
|
503
|
+
|
|
504
|
+
/**
|
|
505
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
506
|
+
* @type {string}
|
|
507
|
+
* @memberof PaymentRequestsApiDeletePaymentRequest
|
|
508
|
+
*/
|
|
509
|
+
readonly authorization?: string
|
|
510
|
+
}
|
|
511
|
+
|
|
423
512
|
/**
|
|
424
513
|
* Request parameters for getPaymentRequest operation in PaymentRequestsApi.
|
|
425
514
|
* @export
|
|
@@ -476,35 +565,35 @@ export interface PaymentRequestsApiListPaymentRequestsRequest {
|
|
|
476
565
|
readonly pageToken?: string
|
|
477
566
|
|
|
478
567
|
/**
|
|
479
|
-
* Filter the response by one or multiple fields.
|
|
568
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, paymentRequestNumber, status, direction, financialEntityType, domainEntityType, paymentMethodPsp, paymentMethodType, createdAt</i>
|
|
480
569
|
* @type {string}
|
|
481
570
|
* @memberof PaymentRequestsApiListPaymentRequests
|
|
482
571
|
*/
|
|
483
572
|
readonly filter?: string
|
|
484
573
|
|
|
485
574
|
/**
|
|
486
|
-
*
|
|
575
|
+
* Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: code, paymentRequestNumber, financialEntityCode, financialEntityNumber, domainEntityCode, domainEntityNumber</i>
|
|
487
576
|
* @type {string}
|
|
488
577
|
* @memberof PaymentRequestsApiListPaymentRequests
|
|
489
578
|
*/
|
|
490
579
|
readonly search?: string
|
|
491
580
|
|
|
492
581
|
/**
|
|
493
|
-
* 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>
|
|
582
|
+
* Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, paymentRequestNumber, financialEntityNumber, domainEntityNumber, createdAt, status</i>
|
|
494
583
|
* @type {string}
|
|
495
584
|
* @memberof PaymentRequestsApiListPaymentRequests
|
|
496
585
|
*/
|
|
497
586
|
readonly order?: string
|
|
498
587
|
|
|
499
588
|
/**
|
|
500
|
-
* 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/>
|
|
589
|
+
* 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: paymentReceipts<i>
|
|
501
590
|
* @type {string}
|
|
502
591
|
* @memberof PaymentRequestsApiListPaymentRequests
|
|
503
592
|
*/
|
|
504
593
|
readonly expand?: string
|
|
505
594
|
|
|
506
595
|
/**
|
|
507
|
-
* Filters the response by one or multiple fields.
|
|
596
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, paymentRequestNumber, status, direction, financialEntityType, domainEntityType, paymentMethodPsp, paymentMethodType, createdAt</i>
|
|
508
597
|
* @type {string}
|
|
509
598
|
* @memberof PaymentRequestsApiListPaymentRequests
|
|
510
599
|
*/
|
|
@@ -558,6 +647,18 @@ export class PaymentRequestsApi extends BaseAPI {
|
|
|
558
647
|
return PaymentRequestsApiFp(this.configuration).createPaymentRequest(requestParameters.createPaymentRequestRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
559
648
|
}
|
|
560
649
|
|
|
650
|
+
/**
|
|
651
|
+
* This will delete payment request. **Required Permissions** \"payment-management.payments.delete\"
|
|
652
|
+
* @summary Delete the payment request
|
|
653
|
+
* @param {PaymentRequestsApiDeletePaymentRequestRequest} requestParameters Request parameters.
|
|
654
|
+
* @param {*} [options] Override http request option.
|
|
655
|
+
* @throws {RequiredError}
|
|
656
|
+
* @memberof PaymentRequestsApi
|
|
657
|
+
*/
|
|
658
|
+
public deletePaymentRequest(requestParameters: PaymentRequestsApiDeletePaymentRequestRequest, options?: AxiosRequestConfig) {
|
|
659
|
+
return PaymentRequestsApiFp(this.configuration).deletePaymentRequest(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
660
|
+
}
|
|
661
|
+
|
|
561
662
|
/**
|
|
562
663
|
* This will get payment request. **Required Permissions** \"payment-management.payments.view\"
|
|
563
664
|
* @summary Retrieve the payment request
|
package/api/payments-api.ts
CHANGED
|
@@ -199,16 +199,16 @@ export const PaymentsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
199
199
|
};
|
|
200
200
|
},
|
|
201
201
|
/**
|
|
202
|
-
* Returns a list of payments you have previously created.
|
|
202
|
+
* Returns a list of payments you have previously created. The payments are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.payments.view\"
|
|
203
203
|
* @summary List payments
|
|
204
204
|
* @param {string} [authorization] Bearer Token
|
|
205
205
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
206
206
|
* @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.
|
|
207
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
207
|
+
* @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, id, pspCustomerId, psp, type, amount, receivedDate, referenceNumber, productSlug, accountCode, partnerCode</i>
|
|
208
208
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
209
209
|
* @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: id, createdAt, code, amount</i>
|
|
210
210
|
* @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: transactions<i>
|
|
211
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
211
|
+
* @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, id, pspCustomerId, psp, type, amount, receivedDate, referenceNumber, productSlug, accountCode, partnerCode</i>
|
|
212
212
|
* @param {*} [options] Override http request option.
|
|
213
213
|
* @throws {RequiredError}
|
|
214
214
|
*/
|
|
@@ -324,16 +324,16 @@ export const PaymentsApiFp = function(configuration?: Configuration) {
|
|
|
324
324
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
325
325
|
},
|
|
326
326
|
/**
|
|
327
|
-
* Returns a list of payments you have previously created.
|
|
327
|
+
* Returns a list of payments you have previously created. The payments are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.payments.view\"
|
|
328
328
|
* @summary List payments
|
|
329
329
|
* @param {string} [authorization] Bearer Token
|
|
330
330
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
331
331
|
* @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.
|
|
332
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
332
|
+
* @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, id, pspCustomerId, psp, type, amount, receivedDate, referenceNumber, productSlug, accountCode, partnerCode</i>
|
|
333
333
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
334
334
|
* @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: id, createdAt, code, amount</i>
|
|
335
335
|
* @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: transactions<i>
|
|
336
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
336
|
+
* @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, id, pspCustomerId, psp, type, amount, receivedDate, referenceNumber, productSlug, accountCode, partnerCode</i>
|
|
337
337
|
* @param {*} [options] Override http request option.
|
|
338
338
|
* @throws {RequiredError}
|
|
339
339
|
*/
|
|
@@ -388,16 +388,16 @@ export const PaymentsApiFactory = function (configuration?: Configuration, baseP
|
|
|
388
388
|
return localVarFp.getPayment(code, authorization, expand, options).then((request) => request(axios, basePath));
|
|
389
389
|
},
|
|
390
390
|
/**
|
|
391
|
-
* Returns a list of payments you have previously created.
|
|
391
|
+
* Returns a list of payments you have previously created. The payments are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.payments.view\"
|
|
392
392
|
* @summary List payments
|
|
393
393
|
* @param {string} [authorization] Bearer Token
|
|
394
394
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
395
395
|
* @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.
|
|
396
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
396
|
+
* @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, id, pspCustomerId, psp, type, amount, receivedDate, referenceNumber, productSlug, accountCode, partnerCode</i>
|
|
397
397
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
398
398
|
* @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: id, createdAt, code, amount</i>
|
|
399
399
|
* @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: transactions<i>
|
|
400
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
400
|
+
* @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, id, pspCustomerId, psp, type, amount, receivedDate, referenceNumber, productSlug, accountCode, partnerCode</i>
|
|
401
401
|
* @param {*} [options] Override http request option.
|
|
402
402
|
* @throws {RequiredError}
|
|
403
403
|
*/
|
|
@@ -519,7 +519,7 @@ export interface PaymentsApiListPaymentsRequest {
|
|
|
519
519
|
readonly pageToken?: string
|
|
520
520
|
|
|
521
521
|
/**
|
|
522
|
-
* Filter the response by one or multiple fields.
|
|
522
|
+
* 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, id, pspCustomerId, psp, type, amount, receivedDate, referenceNumber, productSlug, accountCode, partnerCode</i>
|
|
523
523
|
* @type {string}
|
|
524
524
|
* @memberof PaymentsApiListPayments
|
|
525
525
|
*/
|
|
@@ -547,7 +547,7 @@ export interface PaymentsApiListPaymentsRequest {
|
|
|
547
547
|
readonly expand?: string
|
|
548
548
|
|
|
549
549
|
/**
|
|
550
|
-
* Filters the response by one or multiple fields.
|
|
550
|
+
* 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, id, pspCustomerId, psp, type, amount, receivedDate, referenceNumber, productSlug, accountCode, partnerCode</i>
|
|
551
551
|
* @type {string}
|
|
552
552
|
* @memberof PaymentsApiListPayments
|
|
553
553
|
*/
|
|
@@ -598,7 +598,7 @@ export class PaymentsApi extends BaseAPI {
|
|
|
598
598
|
}
|
|
599
599
|
|
|
600
600
|
/**
|
|
601
|
-
* Returns a list of payments you have previously created.
|
|
601
|
+
* Returns a list of payments you have previously created. The payments are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.payments.view\"
|
|
602
602
|
* @summary List payments
|
|
603
603
|
* @param {PaymentsApiListPaymentsRequest} requestParameters Request parameters.
|
|
604
604
|
* @param {*} [options] Override http request option.
|