@emilgroup/payment-sdk-node 1.23.0 → 1.23.1-beta.100
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 +34 -0
- package/README.md +2 -2
- package/api/bank-accounts-api.ts +16 -16
- package/api/bank-orders-api.ts +16 -16
- package/api/bank-transaction-api.ts +12 -12
- package/api/billing-addresses-api.ts +681 -0
- 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 +16 -16
- package/api/payment-requests-api.ts +697 -0
- package/api/payments-api.ts +12 -12
- package/api/payout-methods-api.ts +794 -0
- package/api/refunds-api.ts +12 -12
- package/api/tenant-bank-account-api.ts +16 -16
- package/api/webhooks-api.ts +125 -14
- package/api.ts +10 -0
- package/base.ts +1 -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 +16 -16
- package/dist/api/bank-orders-api.js +14 -14
- 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 +384 -0
- package/dist/api/billing-addresses-api.js +640 -0
- 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 +16 -16
- package/dist/api/payment-reminders-api.js +13 -13
- package/dist/api/payment-requests-api.d.ts +393 -0
- package/dist/api/payment-requests-api.js +648 -0
- 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 +447 -0
- package/dist/api/payout-methods-api.js +738 -0
- 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 +16 -16
- package/dist/api/tenant-bank-account-api.js +13 -13
- package/dist/api/webhooks-api.d.ts +73 -9
- package/dist/api/webhooks-api.js +100 -11
- package/dist/api.d.ts +5 -0
- package/dist/api.js +5 -0
- package/dist/base.d.ts +2 -1
- package/dist/base.js +1 -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/bank-order-class.d.ts +3 -3
- package/dist/models/bank-order-entity.d.ts +3 -2
- package/dist/models/bank-order-entity.js +2 -1
- package/dist/models/billing-address-class.d.ts +108 -0
- package/dist/models/billing-address-class.js +15 -0
- package/dist/models/create-bank-order-request-dto.d.ts +4 -3
- package/dist/models/create-bank-order-request-dto.js +2 -1
- package/dist/models/create-billing-address-request-dto.d.ts +66 -0
- package/dist/models/create-billing-address-request-dto.js +15 -0
- package/dist/models/create-billing-address-response-class.d.ts +25 -0
- package/dist/models/create-billing-address-response-class.js +15 -0
- package/dist/models/create-payment-receipt-request-dto.d.ts +65 -0
- package/dist/models/create-payment-receipt-request-dto.js +20 -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 +109 -0
- package/dist/models/create-payment-request-request-dto.js +30 -0
- package/dist/models/create-payment-request-response-class.d.ts +25 -0
- package/dist/models/create-payment-request-response-class.js +15 -0
- 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 +66 -0
- package/dist/models/create-payout-method-request-dto.js +15 -0
- package/dist/models/create-payout-method-response-class.d.ts +25 -0
- package/dist/models/create-payout-method-response-class.js +15 -0
- package/dist/models/create-tenant-bank-account-request-dto.d.ts +17 -0
- package/dist/models/create-tenant-bank-account-request-dto.js +11 -1
- package/dist/models/get-billing-address-response-class.d.ts +25 -0
- package/dist/models/get-billing-address-response-class.js +15 -0
- 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/get-payment-request-response-class.d.ts +25 -0
- package/dist/models/get-payment-request-response-class.js +15 -0
- package/dist/models/get-payout-method-response-class.d.ts +25 -0
- package/dist/models/get-payout-method-response-class.js +15 -0
- package/dist/models/index.d.ts +29 -0
- package/dist/models/index.js +29 -0
- package/dist/models/list-billing-addresses-response-class.d.ts +43 -0
- package/dist/models/list-billing-addresses-response-class.js +15 -0
- package/dist/models/list-exceeding-credits-response-class.d.ts +18 -6
- 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/list-payment-requests-response-class.d.ts +43 -0
- package/dist/models/list-payment-requests-response-class.js +15 -0
- package/dist/models/list-payout-methods-response-class.d.ts +43 -0
- package/dist/models/list-payout-methods-response-class.js +15 -0
- package/dist/models/list-refunds-response-class.d.ts +18 -6
- package/dist/models/payment-receipt-class.d.ts +101 -0
- package/dist/models/payment-receipt-class.js +20 -0
- package/dist/models/payment-request-class.d.ts +155 -0
- package/dist/models/payment-request-class.js +38 -0
- package/dist/models/payout-method-class.d.ts +121 -0
- package/dist/models/payout-method-class.js +15 -0
- package/dist/models/tenant-bank-account-class-without-expand-properties.d.ts +17 -0
- package/dist/models/tenant-bank-account-class-without-expand-properties.js +11 -1
- package/dist/models/tenant-bank-account-class.d.ts +17 -0
- package/dist/models/tenant-bank-account-class.js +11 -1
- package/dist/models/tenant-bank-account-entity.d.ts +17 -0
- package/dist/models/tenant-bank-account-entity.js +11 -1
- package/dist/models/update-bank-order-request-dto.d.ts +3 -3
- package/dist/models/update-billing-address-request-dto.d.ts +66 -0
- package/dist/models/update-billing-address-request-dto.js +15 -0
- package/dist/models/update-billing-address-response-class.d.ts +25 -0
- package/dist/models/update-billing-address-response-class.js +15 -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 +39 -0
- package/dist/models/update-payment-request-request-dto.js +24 -0
- package/dist/models/update-payment-request-response-class.d.ts +25 -0
- package/dist/models/update-payment-request-response-class.js +15 -0
- package/dist/models/update-tenant-bank-account-rest-request-dto.d.ts +17 -0
- package/dist/models/update-tenant-bank-account-rest-request-dto.js +11 -1
- 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/bank-order-class.ts +3 -3
- package/models/bank-order-entity.ts +4 -3
- package/models/billing-address-class.ts +114 -0
- package/models/create-bank-order-request-dto.ts +5 -4
- package/models/create-billing-address-request-dto.ts +72 -0
- package/models/create-billing-address-response-class.ts +31 -0
- package/models/create-payment-receipt-request-dto.ts +74 -0
- package/models/create-payment-receipt-response-class.ts +31 -0
- package/models/create-payment-request-request-dto.ts +118 -0
- package/models/create-payment-request-response-class.ts +31 -0
- package/models/create-payout-method-by-bank-account-request-dto.ts +42 -0
- package/models/create-payout-method-request-dto.ts +72 -0
- package/models/create-payout-method-response-class.ts +31 -0
- package/models/create-tenant-bank-account-request-dto.ts +18 -0
- package/models/get-billing-address-response-class.ts +31 -0
- package/models/get-payment-receipt-response-class.ts +31 -0
- package/models/get-payment-request-response-class.ts +31 -0
- package/models/get-payout-method-response-class.ts +31 -0
- package/models/index.ts +29 -0
- package/models/list-billing-addresses-response-class.ts +49 -0
- package/models/list-exceeding-credits-response-class.ts +18 -6
- package/models/list-payment-receipts-response-class.ts +49 -0
- package/models/list-payment-requests-response-class.ts +49 -0
- package/models/list-payout-methods-response-class.ts +49 -0
- package/models/list-refunds-response-class.ts +18 -6
- package/models/payment-receipt-class.ts +110 -0
- package/models/payment-request-class.ts +165 -0
- package/models/payout-method-class.ts +127 -0
- package/models/tenant-bank-account-class-without-expand-properties.ts +18 -0
- package/models/tenant-bank-account-class.ts +18 -0
- package/models/tenant-bank-account-entity.ts +18 -0
- package/models/update-bank-order-request-dto.ts +3 -3
- package/models/update-billing-address-request-dto.ts +72 -0
- package/models/update-billing-address-response-class.ts +31 -0
- package/models/update-payment-receipt-response-class.ts +31 -0
- package/models/update-payment-request-request-dto.ts +48 -0
- package/models/update-payment-request-response-class.ts +31 -0
- package/models/update-tenant-bank-account-rest-request-dto.ts +18 -0
- package/models/validate-iban-request-dto.ts +30 -0
- package/models/validate-iban-response-class.ts +37 -0
- package/package.json +3 -3
|
@@ -52,16 +52,16 @@ export declare const PaymentRemindersApiAxiosParamCreator: (configuration?: Conf
|
|
|
52
52
|
*/
|
|
53
53
|
getPaymentReminder: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
54
54
|
/**
|
|
55
|
-
* Returns a list of payment reminders you have previously created.
|
|
55
|
+
* 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\"
|
|
56
56
|
* @summary List payment reminders
|
|
57
57
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
58
58
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
59
59
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
60
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
60
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, id, policyCode, nextReminderDate, isActive</i>
|
|
61
61
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
62
|
-
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, updatedAt</i>
|
|
62
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, updatedAt, isActive</i>
|
|
63
63
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
64
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
64
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, id, policyCode, nextReminderDate, isActive</i>
|
|
65
65
|
* @param {*} [options] Override http request option.
|
|
66
66
|
* @throws {RequiredError}
|
|
67
67
|
*/
|
|
@@ -101,16 +101,16 @@ export declare const PaymentRemindersApiFp: (configuration?: Configuration) => {
|
|
|
101
101
|
*/
|
|
102
102
|
getPaymentReminder(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPaymentReminderResponseClass>>;
|
|
103
103
|
/**
|
|
104
|
-
* Returns a list of payment reminders you have previously created.
|
|
104
|
+
* 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\"
|
|
105
105
|
* @summary List payment reminders
|
|
106
106
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
107
107
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
108
108
|
* @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.
|
|
109
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
109
|
+
* @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, isActive</i>
|
|
110
110
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
111
|
-
* @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>
|
|
111
|
+
* @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, isActive</i>
|
|
112
112
|
* @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/>
|
|
113
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
113
|
+
* @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, isActive</i>
|
|
114
114
|
* @param {*} [options] Override http request option.
|
|
115
115
|
* @throws {RequiredError}
|
|
116
116
|
*/
|
|
@@ -150,16 +150,16 @@ export declare const PaymentRemindersApiFactory: (configuration?: Configuration,
|
|
|
150
150
|
*/
|
|
151
151
|
getPaymentReminder(code: string, authorization?: string, options?: any): AxiosPromise<GetPaymentReminderResponseClass>;
|
|
152
152
|
/**
|
|
153
|
-
* Returns a list of payment reminders you have previously created.
|
|
153
|
+
* 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\"
|
|
154
154
|
* @summary List payment reminders
|
|
155
155
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
156
156
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
157
157
|
* @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.
|
|
158
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
158
|
+
* @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, isActive</i>
|
|
159
159
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
160
|
-
* @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>
|
|
160
|
+
* @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, isActive</i>
|
|
161
161
|
* @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/>
|
|
162
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
162
|
+
* @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, isActive</i>
|
|
163
163
|
* @param {*} [options] Override http request option.
|
|
164
164
|
* @throws {RequiredError}
|
|
165
165
|
*/
|
|
@@ -253,7 +253,7 @@ export interface PaymentRemindersApiListPaymentRemindersRequest {
|
|
|
253
253
|
*/
|
|
254
254
|
readonly pageToken?: string;
|
|
255
255
|
/**
|
|
256
|
-
* Filter the response by one or multiple fields.
|
|
256
|
+
* 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, isActive</i>
|
|
257
257
|
* @type {string}
|
|
258
258
|
* @memberof PaymentRemindersApiListPaymentReminders
|
|
259
259
|
*/
|
|
@@ -265,7 +265,7 @@ export interface PaymentRemindersApiListPaymentRemindersRequest {
|
|
|
265
265
|
*/
|
|
266
266
|
readonly search?: string;
|
|
267
267
|
/**
|
|
268
|
-
* 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>
|
|
268
|
+
* 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, isActive</i>
|
|
269
269
|
* @type {string}
|
|
270
270
|
* @memberof PaymentRemindersApiListPaymentReminders
|
|
271
271
|
*/
|
|
@@ -277,7 +277,7 @@ export interface PaymentRemindersApiListPaymentRemindersRequest {
|
|
|
277
277
|
*/
|
|
278
278
|
readonly expand?: string;
|
|
279
279
|
/**
|
|
280
|
-
* Filters the response by one or multiple fields.
|
|
280
|
+
* 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, isActive</i>
|
|
281
281
|
* @type {string}
|
|
282
282
|
* @memberof PaymentRemindersApiListPaymentReminders
|
|
283
283
|
*/
|
|
@@ -318,7 +318,7 @@ export declare class PaymentRemindersApi extends BaseAPI {
|
|
|
318
318
|
*/
|
|
319
319
|
getPaymentReminder(requestParameters: PaymentRemindersApiGetPaymentReminderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPaymentReminderResponseClass, any, {}>>;
|
|
320
320
|
/**
|
|
321
|
-
* Returns a list of payment reminders you have previously created.
|
|
321
|
+
* 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\"
|
|
322
322
|
* @summary List payment reminders
|
|
323
323
|
* @param {PaymentRemindersApiListPaymentRemindersRequest} requestParameters Request parameters.
|
|
324
324
|
* @param {*} [options] Override http request option.
|
|
@@ -247,16 +247,16 @@ var PaymentRemindersApiAxiosParamCreator = function (configuration) {
|
|
|
247
247
|
});
|
|
248
248
|
},
|
|
249
249
|
/**
|
|
250
|
-
* Returns a list of payment reminders you have previously created.
|
|
250
|
+
* 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\"
|
|
251
251
|
* @summary List payment reminders
|
|
252
252
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
253
253
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
254
254
|
* @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.
|
|
255
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
255
|
+
* @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, isActive</i>
|
|
256
256
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
257
|
-
* @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>
|
|
257
|
+
* @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, isActive</i>
|
|
258
258
|
* @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/>
|
|
259
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
259
|
+
* @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, isActive</i>
|
|
260
260
|
* @param {*} [options] Override http request option.
|
|
261
261
|
* @throws {RequiredError}
|
|
262
262
|
*/
|
|
@@ -393,16 +393,16 @@ var PaymentRemindersApiFp = function (configuration) {
|
|
|
393
393
|
});
|
|
394
394
|
},
|
|
395
395
|
/**
|
|
396
|
-
* Returns a list of payment reminders you have previously created.
|
|
396
|
+
* 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\"
|
|
397
397
|
* @summary List payment reminders
|
|
398
398
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
399
399
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
400
400
|
* @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.
|
|
401
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
401
|
+
* @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, isActive</i>
|
|
402
402
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
403
|
-
* @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>
|
|
403
|
+
* @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, isActive</i>
|
|
404
404
|
* @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/>
|
|
405
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
405
|
+
* @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, isActive</i>
|
|
406
406
|
* @param {*} [options] Override http request option.
|
|
407
407
|
* @throws {RequiredError}
|
|
408
408
|
*/
|
|
@@ -464,16 +464,16 @@ var PaymentRemindersApiFactory = function (configuration, basePath, axios) {
|
|
|
464
464
|
return localVarFp.getPaymentReminder(code, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
465
465
|
},
|
|
466
466
|
/**
|
|
467
|
-
* Returns a list of payment reminders you have previously created.
|
|
467
|
+
* 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\"
|
|
468
468
|
* @summary List payment reminders
|
|
469
469
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
470
470
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
471
471
|
* @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.
|
|
472
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
472
|
+
* @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, isActive</i>
|
|
473
473
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
474
|
-
* @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>
|
|
474
|
+
* @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, isActive</i>
|
|
475
475
|
* @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/>
|
|
476
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
476
|
+
* @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, isActive</i>
|
|
477
477
|
* @param {*} [options] Override http request option.
|
|
478
478
|
* @throws {RequiredError}
|
|
479
479
|
*/
|
|
@@ -531,7 +531,7 @@ var PaymentRemindersApi = /** @class */ (function (_super) {
|
|
|
531
531
|
return (0, exports.PaymentRemindersApiFp)(this.configuration).getPaymentReminder(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
532
532
|
};
|
|
533
533
|
/**
|
|
534
|
-
* Returns a list of payment reminders you have previously created.
|
|
534
|
+
* 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\"
|
|
535
535
|
* @summary List payment reminders
|
|
536
536
|
* @param {PaymentRemindersApiListPaymentRemindersRequest} requestParameters Request parameters.
|
|
537
537
|
* @param {*} [options] Override http request option.
|
|
@@ -0,0 +1,393 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Emil Payment Service
|
|
3
|
+
* This service directly communicates with the various Payment Service Providers (PSPs) in order to charge or refund customers. This service will automatically connect to the PSP linked in your admin configuration; meaning if you configured Stripe, it will automatically create a payment on Stripe when you create it in Emil.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0
|
|
6
|
+
* Contact: kontakt@emil.de
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
13
|
+
import { Configuration } from '../configuration';
|
|
14
|
+
import { RequestArgs, BaseAPI } from '../base';
|
|
15
|
+
import { CreatePaymentRequestRequestDto } from '../models';
|
|
16
|
+
import { CreatePaymentRequestResponseClass } from '../models';
|
|
17
|
+
import { GetPaymentRequestResponseClass } from '../models';
|
|
18
|
+
import { ListPaymentRequestsResponseClass } from '../models';
|
|
19
|
+
import { UpdatePaymentRequestRequestDto } from '../models';
|
|
20
|
+
import { UpdatePaymentRequestResponseClass } from '../models';
|
|
21
|
+
/**
|
|
22
|
+
* PaymentRequestsApi - axios parameter creator
|
|
23
|
+
* @export
|
|
24
|
+
*/
|
|
25
|
+
export declare const PaymentRequestsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
26
|
+
/**
|
|
27
|
+
* This will create payment request. **Required Permissions** \"payment-management.payments.create\"
|
|
28
|
+
* @summary Create the payment request
|
|
29
|
+
* @param {CreatePaymentRequestRequestDto} createPaymentRequestRequestDto
|
|
30
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
31
|
+
* @param {*} [options] Override http request option.
|
|
32
|
+
* @throws {RequiredError}
|
|
33
|
+
*/
|
|
34
|
+
createPaymentRequest: (createPaymentRequestRequestDto: CreatePaymentRequestRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
35
|
+
/**
|
|
36
|
+
* This will delete payment request. **Required Permissions** \"payment-management.payments.delete\"
|
|
37
|
+
* @summary Delete the payment request
|
|
38
|
+
* @param {string} code Unique identifier for the object.
|
|
39
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
40
|
+
* @param {*} [options] Override http request option.
|
|
41
|
+
* @throws {RequiredError}
|
|
42
|
+
*/
|
|
43
|
+
deletePaymentRequest: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
44
|
+
/**
|
|
45
|
+
* This will get payment request. **Required Permissions** \"payment-management.payments.view\"
|
|
46
|
+
* @summary Retrieve the payment request
|
|
47
|
+
* @param {string} code Unique identifier for the object.
|
|
48
|
+
* @param {string} expand
|
|
49
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
50
|
+
* @param {*} [options] Override http request option.
|
|
51
|
+
* @throws {RequiredError}
|
|
52
|
+
*/
|
|
53
|
+
getPaymentRequest: (code: string, expand: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
54
|
+
/**
|
|
55
|
+
* Retrieves a list of paymentrequests. **Required Permissions** \"payment-management.payments.view\"
|
|
56
|
+
* @summary List payment requests
|
|
57
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
58
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
59
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
60
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, paymentRequestNumber, status, direction, financialEntityType, domainEntityType, paymentMethodPsp, paymentMethodType, createdAt</i>
|
|
61
|
+
* @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>
|
|
62
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, paymentRequestNumber, financialEntityNumber, domainEntityNumber, createdAt, status</i>
|
|
63
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: paymentReceipts<i>
|
|
64
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, paymentRequestNumber, status, direction, financialEntityType, domainEntityType, paymentMethodPsp, paymentMethodType, createdAt</i>
|
|
65
|
+
* @param {*} [options] Override http request option.
|
|
66
|
+
* @throws {RequiredError}
|
|
67
|
+
*/
|
|
68
|
+
listPaymentRequests: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
69
|
+
/**
|
|
70
|
+
* This will update payment request. **Required Permissions** \"payment-management.payments.update\"
|
|
71
|
+
* @summary Update the payment request
|
|
72
|
+
* @param {string} code Unique identifier for the object.
|
|
73
|
+
* @param {UpdatePaymentRequestRequestDto} updatePaymentRequestRequestDto
|
|
74
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
75
|
+
* @param {*} [options] Override http request option.
|
|
76
|
+
* @throws {RequiredError}
|
|
77
|
+
*/
|
|
78
|
+
updatePaymentRequest: (code: string, updatePaymentRequestRequestDto: UpdatePaymentRequestRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
79
|
+
};
|
|
80
|
+
/**
|
|
81
|
+
* PaymentRequestsApi - functional programming interface
|
|
82
|
+
* @export
|
|
83
|
+
*/
|
|
84
|
+
export declare const PaymentRequestsApiFp: (configuration?: Configuration) => {
|
|
85
|
+
/**
|
|
86
|
+
* This will create payment request. **Required Permissions** \"payment-management.payments.create\"
|
|
87
|
+
* @summary Create the payment request
|
|
88
|
+
* @param {CreatePaymentRequestRequestDto} createPaymentRequestRequestDto
|
|
89
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
90
|
+
* @param {*} [options] Override http request option.
|
|
91
|
+
* @throws {RequiredError}
|
|
92
|
+
*/
|
|
93
|
+
createPaymentRequest(createPaymentRequestRequestDto: CreatePaymentRequestRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePaymentRequestResponseClass>>;
|
|
94
|
+
/**
|
|
95
|
+
* This will delete payment request. **Required Permissions** \"payment-management.payments.delete\"
|
|
96
|
+
* @summary Delete the payment request
|
|
97
|
+
* @param {string} code Unique identifier for the object.
|
|
98
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
99
|
+
* @param {*} [options] Override http request option.
|
|
100
|
+
* @throws {RequiredError}
|
|
101
|
+
*/
|
|
102
|
+
deletePaymentRequest(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
103
|
+
/**
|
|
104
|
+
* This will get payment request. **Required Permissions** \"payment-management.payments.view\"
|
|
105
|
+
* @summary Retrieve the payment request
|
|
106
|
+
* @param {string} code Unique identifier for the object.
|
|
107
|
+
* @param {string} expand
|
|
108
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
109
|
+
* @param {*} [options] Override http request option.
|
|
110
|
+
* @throws {RequiredError}
|
|
111
|
+
*/
|
|
112
|
+
getPaymentRequest(code: string, expand: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPaymentRequestResponseClass>>;
|
|
113
|
+
/**
|
|
114
|
+
* Retrieves a list of paymentrequests. **Required Permissions** \"payment-management.payments.view\"
|
|
115
|
+
* @summary List payment requests
|
|
116
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
117
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
118
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
119
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, paymentRequestNumber, status, direction, financialEntityType, domainEntityType, paymentMethodPsp, paymentMethodType, createdAt</i>
|
|
120
|
+
* @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>
|
|
121
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, paymentRequestNumber, financialEntityNumber, domainEntityNumber, createdAt, status</i>
|
|
122
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: paymentReceipts<i>
|
|
123
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, paymentRequestNumber, status, direction, financialEntityType, domainEntityType, paymentMethodPsp, paymentMethodType, createdAt</i>
|
|
124
|
+
* @param {*} [options] Override http request option.
|
|
125
|
+
* @throws {RequiredError}
|
|
126
|
+
*/
|
|
127
|
+
listPaymentRequests(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPaymentRequestsResponseClass>>;
|
|
128
|
+
/**
|
|
129
|
+
* This will update payment request. **Required Permissions** \"payment-management.payments.update\"
|
|
130
|
+
* @summary Update the payment request
|
|
131
|
+
* @param {string} code Unique identifier for the object.
|
|
132
|
+
* @param {UpdatePaymentRequestRequestDto} updatePaymentRequestRequestDto
|
|
133
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
134
|
+
* @param {*} [options] Override http request option.
|
|
135
|
+
* @throws {RequiredError}
|
|
136
|
+
*/
|
|
137
|
+
updatePaymentRequest(code: string, updatePaymentRequestRequestDto: UpdatePaymentRequestRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdatePaymentRequestResponseClass>>;
|
|
138
|
+
};
|
|
139
|
+
/**
|
|
140
|
+
* PaymentRequestsApi - factory interface
|
|
141
|
+
* @export
|
|
142
|
+
*/
|
|
143
|
+
export declare const PaymentRequestsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
144
|
+
/**
|
|
145
|
+
* This will create payment request. **Required Permissions** \"payment-management.payments.create\"
|
|
146
|
+
* @summary Create the payment request
|
|
147
|
+
* @param {CreatePaymentRequestRequestDto} createPaymentRequestRequestDto
|
|
148
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
149
|
+
* @param {*} [options] Override http request option.
|
|
150
|
+
* @throws {RequiredError}
|
|
151
|
+
*/
|
|
152
|
+
createPaymentRequest(createPaymentRequestRequestDto: CreatePaymentRequestRequestDto, authorization?: string, options?: any): AxiosPromise<CreatePaymentRequestResponseClass>;
|
|
153
|
+
/**
|
|
154
|
+
* This will delete payment request. **Required Permissions** \"payment-management.payments.delete\"
|
|
155
|
+
* @summary Delete the payment request
|
|
156
|
+
* @param {string} code Unique identifier for the object.
|
|
157
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
158
|
+
* @param {*} [options] Override http request option.
|
|
159
|
+
* @throws {RequiredError}
|
|
160
|
+
*/
|
|
161
|
+
deletePaymentRequest(code: string, authorization?: string, options?: any): AxiosPromise<object>;
|
|
162
|
+
/**
|
|
163
|
+
* This will get payment request. **Required Permissions** \"payment-management.payments.view\"
|
|
164
|
+
* @summary Retrieve the payment request
|
|
165
|
+
* @param {string} code Unique identifier for the object.
|
|
166
|
+
* @param {string} expand
|
|
167
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
168
|
+
* @param {*} [options] Override http request option.
|
|
169
|
+
* @throws {RequiredError}
|
|
170
|
+
*/
|
|
171
|
+
getPaymentRequest(code: string, expand: string, authorization?: string, options?: any): AxiosPromise<GetPaymentRequestResponseClass>;
|
|
172
|
+
/**
|
|
173
|
+
* Retrieves a list of paymentrequests. **Required Permissions** \"payment-management.payments.view\"
|
|
174
|
+
* @summary List payment requests
|
|
175
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
176
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
177
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
178
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, paymentRequestNumber, status, direction, financialEntityType, domainEntityType, paymentMethodPsp, paymentMethodType, createdAt</i>
|
|
179
|
+
* @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>
|
|
180
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, paymentRequestNumber, financialEntityNumber, domainEntityNumber, createdAt, status</i>
|
|
181
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: paymentReceipts<i>
|
|
182
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, paymentRequestNumber, status, direction, financialEntityType, domainEntityType, paymentMethodPsp, paymentMethodType, createdAt</i>
|
|
183
|
+
* @param {*} [options] Override http request option.
|
|
184
|
+
* @throws {RequiredError}
|
|
185
|
+
*/
|
|
186
|
+
listPaymentRequests(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPaymentRequestsResponseClass>;
|
|
187
|
+
/**
|
|
188
|
+
* This will update payment request. **Required Permissions** \"payment-management.payments.update\"
|
|
189
|
+
* @summary Update the payment request
|
|
190
|
+
* @param {string} code Unique identifier for the object.
|
|
191
|
+
* @param {UpdatePaymentRequestRequestDto} updatePaymentRequestRequestDto
|
|
192
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
193
|
+
* @param {*} [options] Override http request option.
|
|
194
|
+
* @throws {RequiredError}
|
|
195
|
+
*/
|
|
196
|
+
updatePaymentRequest(code: string, updatePaymentRequestRequestDto: UpdatePaymentRequestRequestDto, authorization?: string, options?: any): AxiosPromise<UpdatePaymentRequestResponseClass>;
|
|
197
|
+
};
|
|
198
|
+
/**
|
|
199
|
+
* Request parameters for createPaymentRequest operation in PaymentRequestsApi.
|
|
200
|
+
* @export
|
|
201
|
+
* @interface PaymentRequestsApiCreatePaymentRequestRequest
|
|
202
|
+
*/
|
|
203
|
+
export interface PaymentRequestsApiCreatePaymentRequestRequest {
|
|
204
|
+
/**
|
|
205
|
+
*
|
|
206
|
+
* @type {CreatePaymentRequestRequestDto}
|
|
207
|
+
* @memberof PaymentRequestsApiCreatePaymentRequest
|
|
208
|
+
*/
|
|
209
|
+
readonly createPaymentRequestRequestDto: CreatePaymentRequestRequestDto;
|
|
210
|
+
/**
|
|
211
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
212
|
+
* @type {string}
|
|
213
|
+
* @memberof PaymentRequestsApiCreatePaymentRequest
|
|
214
|
+
*/
|
|
215
|
+
readonly authorization?: string;
|
|
216
|
+
}
|
|
217
|
+
/**
|
|
218
|
+
* Request parameters for deletePaymentRequest operation in PaymentRequestsApi.
|
|
219
|
+
* @export
|
|
220
|
+
* @interface PaymentRequestsApiDeletePaymentRequestRequest
|
|
221
|
+
*/
|
|
222
|
+
export interface PaymentRequestsApiDeletePaymentRequestRequest {
|
|
223
|
+
/**
|
|
224
|
+
* Unique identifier for the object.
|
|
225
|
+
* @type {string}
|
|
226
|
+
* @memberof PaymentRequestsApiDeletePaymentRequest
|
|
227
|
+
*/
|
|
228
|
+
readonly code: string;
|
|
229
|
+
/**
|
|
230
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
231
|
+
* @type {string}
|
|
232
|
+
* @memberof PaymentRequestsApiDeletePaymentRequest
|
|
233
|
+
*/
|
|
234
|
+
readonly authorization?: string;
|
|
235
|
+
}
|
|
236
|
+
/**
|
|
237
|
+
* Request parameters for getPaymentRequest operation in PaymentRequestsApi.
|
|
238
|
+
* @export
|
|
239
|
+
* @interface PaymentRequestsApiGetPaymentRequestRequest
|
|
240
|
+
*/
|
|
241
|
+
export interface PaymentRequestsApiGetPaymentRequestRequest {
|
|
242
|
+
/**
|
|
243
|
+
* Unique identifier for the object.
|
|
244
|
+
* @type {string}
|
|
245
|
+
* @memberof PaymentRequestsApiGetPaymentRequest
|
|
246
|
+
*/
|
|
247
|
+
readonly code: string;
|
|
248
|
+
/**
|
|
249
|
+
*
|
|
250
|
+
* @type {string}
|
|
251
|
+
* @memberof PaymentRequestsApiGetPaymentRequest
|
|
252
|
+
*/
|
|
253
|
+
readonly expand: string;
|
|
254
|
+
/**
|
|
255
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
256
|
+
* @type {string}
|
|
257
|
+
* @memberof PaymentRequestsApiGetPaymentRequest
|
|
258
|
+
*/
|
|
259
|
+
readonly authorization?: string;
|
|
260
|
+
}
|
|
261
|
+
/**
|
|
262
|
+
* Request parameters for listPaymentRequests operation in PaymentRequestsApi.
|
|
263
|
+
* @export
|
|
264
|
+
* @interface PaymentRequestsApiListPaymentRequestsRequest
|
|
265
|
+
*/
|
|
266
|
+
export interface PaymentRequestsApiListPaymentRequestsRequest {
|
|
267
|
+
/**
|
|
268
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
269
|
+
* @type {string}
|
|
270
|
+
* @memberof PaymentRequestsApiListPaymentRequests
|
|
271
|
+
*/
|
|
272
|
+
readonly authorization?: string;
|
|
273
|
+
/**
|
|
274
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
275
|
+
* @type {number}
|
|
276
|
+
* @memberof PaymentRequestsApiListPaymentRequests
|
|
277
|
+
*/
|
|
278
|
+
readonly pageSize?: number;
|
|
279
|
+
/**
|
|
280
|
+
* A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
281
|
+
* @type {string}
|
|
282
|
+
* @memberof PaymentRequestsApiListPaymentRequests
|
|
283
|
+
*/
|
|
284
|
+
readonly pageToken?: string;
|
|
285
|
+
/**
|
|
286
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, paymentRequestNumber, status, direction, financialEntityType, domainEntityType, paymentMethodPsp, paymentMethodType, createdAt</i>
|
|
287
|
+
* @type {string}
|
|
288
|
+
* @memberof PaymentRequestsApiListPaymentRequests
|
|
289
|
+
*/
|
|
290
|
+
readonly filter?: string;
|
|
291
|
+
/**
|
|
292
|
+
* 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>
|
|
293
|
+
* @type {string}
|
|
294
|
+
* @memberof PaymentRequestsApiListPaymentRequests
|
|
295
|
+
*/
|
|
296
|
+
readonly search?: string;
|
|
297
|
+
/**
|
|
298
|
+
* Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, paymentRequestNumber, financialEntityNumber, domainEntityNumber, createdAt, status</i>
|
|
299
|
+
* @type {string}
|
|
300
|
+
* @memberof PaymentRequestsApiListPaymentRequests
|
|
301
|
+
*/
|
|
302
|
+
readonly order?: string;
|
|
303
|
+
/**
|
|
304
|
+
* 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>
|
|
305
|
+
* @type {string}
|
|
306
|
+
* @memberof PaymentRequestsApiListPaymentRequests
|
|
307
|
+
*/
|
|
308
|
+
readonly expand?: string;
|
|
309
|
+
/**
|
|
310
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, paymentRequestNumber, status, direction, financialEntityType, domainEntityType, paymentMethodPsp, paymentMethodType, createdAt</i>
|
|
311
|
+
* @type {string}
|
|
312
|
+
* @memberof PaymentRequestsApiListPaymentRequests
|
|
313
|
+
*/
|
|
314
|
+
readonly filters?: string;
|
|
315
|
+
}
|
|
316
|
+
/**
|
|
317
|
+
* Request parameters for updatePaymentRequest operation in PaymentRequestsApi.
|
|
318
|
+
* @export
|
|
319
|
+
* @interface PaymentRequestsApiUpdatePaymentRequestRequest
|
|
320
|
+
*/
|
|
321
|
+
export interface PaymentRequestsApiUpdatePaymentRequestRequest {
|
|
322
|
+
/**
|
|
323
|
+
* Unique identifier for the object.
|
|
324
|
+
* @type {string}
|
|
325
|
+
* @memberof PaymentRequestsApiUpdatePaymentRequest
|
|
326
|
+
*/
|
|
327
|
+
readonly code: string;
|
|
328
|
+
/**
|
|
329
|
+
*
|
|
330
|
+
* @type {UpdatePaymentRequestRequestDto}
|
|
331
|
+
* @memberof PaymentRequestsApiUpdatePaymentRequest
|
|
332
|
+
*/
|
|
333
|
+
readonly updatePaymentRequestRequestDto: UpdatePaymentRequestRequestDto;
|
|
334
|
+
/**
|
|
335
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
336
|
+
* @type {string}
|
|
337
|
+
* @memberof PaymentRequestsApiUpdatePaymentRequest
|
|
338
|
+
*/
|
|
339
|
+
readonly authorization?: string;
|
|
340
|
+
}
|
|
341
|
+
/**
|
|
342
|
+
* PaymentRequestsApi - object-oriented interface
|
|
343
|
+
* @export
|
|
344
|
+
* @class PaymentRequestsApi
|
|
345
|
+
* @extends {BaseAPI}
|
|
346
|
+
*/
|
|
347
|
+
export declare class PaymentRequestsApi extends BaseAPI {
|
|
348
|
+
/**
|
|
349
|
+
* This will create payment request. **Required Permissions** \"payment-management.payments.create\"
|
|
350
|
+
* @summary Create the payment request
|
|
351
|
+
* @param {PaymentRequestsApiCreatePaymentRequestRequest} requestParameters Request parameters.
|
|
352
|
+
* @param {*} [options] Override http request option.
|
|
353
|
+
* @throws {RequiredError}
|
|
354
|
+
* @memberof PaymentRequestsApi
|
|
355
|
+
*/
|
|
356
|
+
createPaymentRequest(requestParameters: PaymentRequestsApiCreatePaymentRequestRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePaymentRequestResponseClass, any, {}>>;
|
|
357
|
+
/**
|
|
358
|
+
* This will delete payment request. **Required Permissions** \"payment-management.payments.delete\"
|
|
359
|
+
* @summary Delete the payment request
|
|
360
|
+
* @param {PaymentRequestsApiDeletePaymentRequestRequest} requestParameters Request parameters.
|
|
361
|
+
* @param {*} [options] Override http request option.
|
|
362
|
+
* @throws {RequiredError}
|
|
363
|
+
* @memberof PaymentRequestsApi
|
|
364
|
+
*/
|
|
365
|
+
deletePaymentRequest(requestParameters: PaymentRequestsApiDeletePaymentRequestRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any, {}>>;
|
|
366
|
+
/**
|
|
367
|
+
* This will get payment request. **Required Permissions** \"payment-management.payments.view\"
|
|
368
|
+
* @summary Retrieve the payment request
|
|
369
|
+
* @param {PaymentRequestsApiGetPaymentRequestRequest} requestParameters Request parameters.
|
|
370
|
+
* @param {*} [options] Override http request option.
|
|
371
|
+
* @throws {RequiredError}
|
|
372
|
+
* @memberof PaymentRequestsApi
|
|
373
|
+
*/
|
|
374
|
+
getPaymentRequest(requestParameters: PaymentRequestsApiGetPaymentRequestRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPaymentRequestResponseClass, any, {}>>;
|
|
375
|
+
/**
|
|
376
|
+
* Retrieves a list of paymentrequests. **Required Permissions** \"payment-management.payments.view\"
|
|
377
|
+
* @summary List payment requests
|
|
378
|
+
* @param {PaymentRequestsApiListPaymentRequestsRequest} requestParameters Request parameters.
|
|
379
|
+
* @param {*} [options] Override http request option.
|
|
380
|
+
* @throws {RequiredError}
|
|
381
|
+
* @memberof PaymentRequestsApi
|
|
382
|
+
*/
|
|
383
|
+
listPaymentRequests(requestParameters?: PaymentRequestsApiListPaymentRequestsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListPaymentRequestsResponseClass, any, {}>>;
|
|
384
|
+
/**
|
|
385
|
+
* This will update payment request. **Required Permissions** \"payment-management.payments.update\"
|
|
386
|
+
* @summary Update the payment request
|
|
387
|
+
* @param {PaymentRequestsApiUpdatePaymentRequestRequest} requestParameters Request parameters.
|
|
388
|
+
* @param {*} [options] Override http request option.
|
|
389
|
+
* @throws {RequiredError}
|
|
390
|
+
* @memberof PaymentRequestsApi
|
|
391
|
+
*/
|
|
392
|
+
updatePaymentRequest(requestParameters: PaymentRequestsApiUpdatePaymentRequestRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdatePaymentRequestResponseClass, any, {}>>;
|
|
393
|
+
}
|