@emilgroup/payment-sdk 1.4.1-beta.9 → 1.5.0
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 +55 -5
- package/README.md +2 -2
- package/api/bank-accounts-api.ts +508 -88
- package/api/bank-transaction-api.ts +97 -117
- package/api/{default-api.ts → health-check-api.ts} +22 -18
- package/api/payment-methods-api.ts +83 -256
- package/api/payment-reminders-api.ts +71 -105
- package/api/payment-setup-api.ts +53 -37
- package/api/payments-api.ts +80 -137
- package/api/refunds-api.ts +78 -112
- package/api/tenant-bank-account-api.ts +96 -118
- package/api/webhooks-api.ts +17 -13
- package/api.ts +3 -3
- package/base.ts +22 -10
- package/common.ts +2 -2
- package/configuration.ts +1 -1
- package/dist/api/bank-accounts-api.d.ts +298 -71
- package/dist/api/bank-accounts-api.js +432 -62
- package/dist/api/bank-transaction-api.d.ts +85 -100
- package/dist/api/bank-transaction-api.js +63 -74
- package/dist/api/health-check-api.d.ts +70 -0
- package/dist/api/{default-api.js → health-check-api.js} +31 -27
- package/dist/api/payment-methods-api.d.ts +66 -162
- package/dist/api/payment-methods-api.js +60 -190
- package/dist/api/payment-reminders-api.d.ts +66 -89
- package/dist/api/payment-reminders-api.js +44 -62
- package/dist/api/payment-setup-api.d.ts +39 -27
- package/dist/api/payment-setup-api.js +41 -33
- package/dist/api/payments-api.d.ts +70 -103
- package/dist/api/payments-api.js +55 -85
- package/dist/api/refunds-api.d.ts +68 -83
- package/dist/api/refunds-api.js +58 -68
- package/dist/api/tenant-bank-account-api.d.ts +90 -105
- package/dist/api/tenant-bank-account-api.js +63 -75
- package/dist/api/webhooks-api.d.ts +17 -13
- package/dist/api/webhooks-api.js +15 -11
- package/dist/api.d.ts +2 -2
- package/dist/api.js +2 -2
- package/dist/base.d.ts +6 -3
- package/dist/base.js +31 -22
- package/dist/common.d.ts +2 -2
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/dist/models/bank-account-class-without-expand-properties.d.ts +84 -0
- package/dist/models/{bank-transaction-response-class.js → bank-account-class-without-expand-properties.js} +1 -1
- package/dist/models/bank-account-class.d.ts +91 -0
- package/dist/models/{transaction-class.js → bank-account-class.js} +1 -1
- package/dist/models/bank-transaction-class-without-expand-properties.d.ts +126 -0
- package/dist/models/{get-request-dto.js → bank-transaction-class-without-expand-properties.js} +1 -1
- package/dist/models/{bank-transaction-response-class.d.ts → bank-transaction-class.d.ts} +41 -29
- package/dist/models/{tenant-bank-account-response-class.js → bank-transaction-class.js} +1 -1
- package/dist/models/billing-profile-dto.d.ts +38 -0
- package/dist/models/billing-profile-dto.js +15 -0
- package/dist/models/billing-profile-limited-response-dto.d.ts +54 -0
- package/dist/models/billing-profile-limited-response-dto.js +15 -0
- package/dist/models/complete-braintree-payment-setup-request-dto.d.ts +48 -0
- package/dist/models/complete-braintree-payment-setup-request-dto.js +15 -0
- package/dist/models/complete-payment-setup-request-dto.d.ts +32 -0
- package/dist/models/complete-payment-setup-request-dto.js +15 -0
- package/dist/models/complete-payment-setup-response-class.d.ts +25 -0
- package/dist/models/complete-payment-setup-response-class.js +15 -0
- package/dist/models/complete-stripe-payment-setup-request-dto.d.ts +77 -0
- package/dist/models/complete-stripe-payment-setup-request-dto.js +32 -0
- package/dist/models/create-bank-account-request-dto.d.ts +42 -0
- package/dist/models/create-bank-account-request-dto.js +15 -0
- package/dist/models/create-bank-account-response-class.d.ts +25 -0
- package/dist/models/create-bank-account-response-class.js +15 -0
- package/dist/models/create-payment-method-response-class.d.ts +25 -0
- package/dist/models/create-payment-method-response-class.js +15 -0
- package/dist/models/create-payment-reminder-request-dto.d.ts +1 -1
- package/dist/models/create-payment-reminder-request-dto.js +1 -1
- package/dist/models/create-payment-reminder-response-class.d.ts +25 -0
- package/dist/models/create-payment-reminder-response-class.js +15 -0
- package/dist/models/create-payment-request-dto.d.ts +4 -4
- package/dist/models/create-payment-request-dto.js +1 -1
- package/dist/models/create-payment-response-class.d.ts +25 -0
- package/dist/models/create-payment-response-class.js +15 -0
- package/dist/models/create-psp-payment-method-request-dto.d.ts +61 -0
- package/dist/models/create-psp-payment-method-request-dto.js +32 -0
- package/dist/models/create-refund-request-dto.d.ts +1 -1
- package/dist/models/create-refund-request-dto.js +1 -1
- package/dist/models/create-refund-response-class.d.ts +1 -1
- package/dist/models/create-refund-response-class.js +1 -1
- package/dist/models/create-tenant-bank-account-request-dto.d.ts +1 -1
- package/dist/models/create-tenant-bank-account-request-dto.js +1 -1
- package/dist/models/create-tenant-bank-account-response-class.d.ts +25 -0
- package/dist/models/create-tenant-bank-account-response-class.js +15 -0
- package/dist/models/deactivate-payment-reminder-request-dto.d.ts +1 -1
- package/dist/models/deactivate-payment-reminder-request-dto.js +1 -1
- package/dist/models/deactivate-payment-reminder-response-class.d.ts +25 -0
- package/dist/models/deactivate-payment-reminder-response-class.js +15 -0
- package/dist/models/deactivated-payment-reminder-class.d.ts +102 -0
- package/dist/models/deactivated-payment-reminder-class.js +15 -0
- package/dist/models/get-bank-account-response-class.d.ts +25 -0
- package/dist/models/get-bank-account-response-class.js +15 -0
- package/dist/models/get-bank-transactions-response-class.d.ts +4 -4
- package/dist/models/get-bank-transactions-response-class.js +1 -1
- package/dist/models/get-payment-method-response-class.d.ts +25 -0
- package/dist/models/get-payment-method-response-class.js +15 -0
- package/dist/models/get-payment-reminder-response-class.d.ts +25 -0
- package/dist/models/get-payment-reminder-response-class.js +15 -0
- package/dist/models/get-payment-response-class.d.ts +25 -0
- package/dist/models/get-payment-response-class.js +15 -0
- package/dist/models/get-refund-response-class.d.ts +1 -1
- package/dist/models/get-refund-response-class.js +1 -1
- package/dist/models/get-tenant-bank-account-response-class.d.ts +5 -5
- package/dist/models/get-tenant-bank-account-response-class.js +1 -1
- package/dist/models/import-bank-transactions-response-class.d.ts +25 -0
- package/dist/models/import-bank-transactions-response-class.js +15 -0
- package/dist/models/index.d.ts +54 -4
- package/dist/models/index.js +54 -4
- package/dist/models/initiate-braintree-payment-setup-request-dto.d.ts +30 -0
- package/dist/models/initiate-braintree-payment-setup-request-dto.js +15 -0
- package/dist/models/initiate-braintree-payment-setup-response-class.d.ts +24 -0
- package/dist/models/initiate-braintree-payment-setup-response-class.js +15 -0
- package/dist/models/initiate-payment-setup-request-dto.d.ts +44 -0
- package/dist/models/initiate-payment-setup-request-dto.js +15 -0
- package/dist/models/initiate-payment-setup-response-class.d.ts +32 -0
- package/dist/models/initiate-payment-setup-response-class.js +15 -0
- package/dist/models/initiate-stripe-payment-setup-request-dto.d.ts +30 -0
- package/dist/models/initiate-stripe-payment-setup-request-dto.js +15 -0
- package/dist/models/initiate-stripe-payment-setup-response-class.d.ts +30 -0
- package/dist/models/initiate-stripe-payment-setup-response-class.js +15 -0
- package/dist/models/inline-response200.d.ts +1 -1
- package/dist/models/inline-response200.js +1 -1
- package/dist/models/inline-response503.d.ts +1 -1
- package/dist/models/inline-response503.js +1 -1
- package/dist/models/link-bank-transaction-request-dto-rest.d.ts +1 -1
- package/dist/models/link-bank-transaction-request-dto-rest.js +1 -1
- package/dist/models/link-bank-transactions-response-class.d.ts +25 -0
- package/dist/models/link-bank-transactions-response-class.js +15 -0
- package/dist/models/list-bank-accounts-response-class.d.ts +31 -0
- package/dist/models/list-bank-accounts-response-class.js +15 -0
- package/dist/models/list-bank-transactions-response-class.d.ts +6 -6
- package/dist/models/list-bank-transactions-response-class.js +1 -1
- package/dist/models/list-payment-methods-response-class.d.ts +31 -0
- package/dist/models/list-payment-methods-response-class.js +15 -0
- package/dist/models/list-payment-reminders-response-class.d.ts +31 -0
- package/dist/models/list-payment-reminders-response-class.js +15 -0
- package/dist/models/list-payments-response-class.d.ts +31 -0
- package/dist/models/list-payments-response-class.js +15 -0
- package/dist/models/list-refunds-response-class.d.ts +3 -3
- package/dist/models/list-refunds-response-class.js +1 -1
- package/dist/models/list-tenant-bank-account-response-class.d.ts +31 -0
- package/dist/models/list-tenant-bank-account-response-class.js +15 -0
- package/dist/models/payment-class-without-expand-properties.d.ts +108 -0
- package/dist/models/payment-class-without-expand-properties.js +15 -0
- package/dist/models/payment-class.d.ts +115 -0
- package/dist/models/payment-class.js +15 -0
- package/dist/models/payment-method-class.d.ts +78 -0
- package/dist/models/payment-method-class.js +15 -0
- package/dist/models/payment-reminder-class.d.ts +102 -0
- package/dist/models/payment-reminder-class.js +15 -0
- package/dist/models/primary-bank-account-response-class.d.ts +54 -0
- package/dist/models/primary-bank-account-response-class.js +15 -0
- package/dist/models/refund-class.d.ts +18 -4
- package/dist/models/refund-class.js +3 -2
- package/dist/models/refund-item-class.d.ts +114 -0
- package/dist/models/refund-item-class.js +15 -0
- package/dist/models/sepa-direct-dto.d.ts +24 -0
- package/dist/models/sepa-direct-dto.js +15 -0
- package/dist/models/set-primary-bank-account-request-dto-rest.d.ts +24 -0
- package/dist/models/set-primary-bank-account-request-dto-rest.js +15 -0
- package/dist/models/shared-transaction-class.d.ts +72 -0
- package/dist/models/shared-transaction-class.js +15 -0
- package/dist/models/symphony-profile-limited-response-dto.d.ts +42 -0
- package/dist/models/symphony-profile-limited-response-dto.js +15 -0
- package/dist/models/{tenant-bank-account-response-class.d.ts → tenant-bank-account-class-without-expand-properties.d.ts} +23 -11
- package/dist/models/tenant-bank-account-class-without-expand-properties.js +15 -0
- package/dist/models/tenant-bank-account-class.d.ts +85 -0
- package/dist/models/tenant-bank-account-class.js +15 -0
- package/dist/models/unlink-bank-transaction-request-dto-rest.d.ts +2 -2
- package/dist/models/unlink-bank-transaction-request-dto-rest.js +1 -1
- package/dist/models/unlink-bank-transactions-response-class.d.ts +25 -0
- package/dist/models/unlink-bank-transactions-response-class.js +15 -0
- package/dist/models/unlinked-bank-transaction-response-class.d.ts +108 -0
- package/dist/models/unlinked-bank-transaction-response-class.js +15 -0
- package/dist/models/update-bank-account-request-dto-rest.d.ts +30 -0
- package/dist/models/update-bank-account-request-dto-rest.js +15 -0
- package/dist/models/update-bank-account-request-dto.d.ts +36 -0
- package/dist/models/update-bank-account-request-dto.js +15 -0
- package/dist/models/update-bank-account-response-class.d.ts +25 -0
- package/dist/models/update-bank-account-response-class.js +15 -0
- package/dist/models/update-tenant-bank-account-response-class.d.ts +25 -0
- package/dist/models/update-tenant-bank-account-response-class.js +15 -0
- package/dist/models/update-tenant-bank-account-rest-request-dto.d.ts +1 -1
- package/dist/models/update-tenant-bank-account-rest-request-dto.js +1 -1
- package/dist/models/validate-pspconfig-request-dto.d.ts +9 -2
- package/dist/models/validate-pspconfig-request-dto.js +8 -1
- package/index.ts +1 -1
- package/models/bank-account-class-without-expand-properties.ts +90 -0
- package/models/bank-account-class.ts +97 -0
- package/models/bank-transaction-class-without-expand-properties.ts +132 -0
- package/models/{bank-transaction-response-class.ts → bank-transaction-class.ts} +41 -29
- package/models/billing-profile-dto.ts +44 -0
- package/models/billing-profile-limited-response-dto.ts +60 -0
- package/models/complete-braintree-payment-setup-request-dto.ts +54 -0
- package/models/complete-payment-setup-request-dto.ts +38 -0
- package/models/complete-payment-setup-response-class.ts +31 -0
- package/models/complete-stripe-payment-setup-request-dto.ts +86 -0
- package/models/create-bank-account-request-dto.ts +48 -0
- package/models/create-bank-account-response-class.ts +31 -0
- package/models/create-payment-method-response-class.ts +31 -0
- package/models/create-payment-reminder-request-dto.ts +1 -1
- package/models/create-payment-reminder-response-class.ts +31 -0
- package/models/create-payment-request-dto.ts +4 -4
- package/models/create-payment-response-class.ts +31 -0
- package/models/create-psp-payment-method-request-dto.ts +70 -0
- package/models/create-refund-request-dto.ts +1 -1
- package/models/create-refund-response-class.ts +1 -1
- package/models/create-tenant-bank-account-request-dto.ts +1 -1
- package/models/create-tenant-bank-account-response-class.ts +31 -0
- package/models/deactivate-payment-reminder-request-dto.ts +1 -1
- package/models/deactivate-payment-reminder-response-class.ts +31 -0
- package/models/deactivated-payment-reminder-class.ts +108 -0
- package/models/get-bank-account-response-class.ts +31 -0
- package/models/get-bank-transactions-response-class.ts +4 -4
- package/models/get-payment-method-response-class.ts +31 -0
- package/models/get-payment-reminder-response-class.ts +31 -0
- package/models/get-payment-response-class.ts +31 -0
- package/models/get-refund-response-class.ts +1 -1
- package/models/get-tenant-bank-account-response-class.ts +5 -5
- package/models/import-bank-transactions-response-class.ts +31 -0
- package/models/index.ts +54 -4
- package/models/initiate-braintree-payment-setup-request-dto.ts +36 -0
- package/models/initiate-braintree-payment-setup-response-class.ts +30 -0
- package/models/initiate-payment-setup-request-dto.ts +50 -0
- package/models/initiate-payment-setup-response-class.ts +38 -0
- package/models/initiate-stripe-payment-setup-request-dto.ts +36 -0
- package/models/initiate-stripe-payment-setup-response-class.ts +36 -0
- package/models/inline-response200.ts +1 -1
- package/models/inline-response503.ts +1 -1
- package/models/link-bank-transaction-request-dto-rest.ts +1 -1
- package/models/link-bank-transactions-response-class.ts +31 -0
- package/models/list-bank-accounts-response-class.ts +37 -0
- package/models/list-bank-transactions-response-class.ts +6 -6
- package/models/list-payment-methods-response-class.ts +37 -0
- package/models/list-payment-reminders-response-class.ts +37 -0
- package/models/list-payments-response-class.ts +37 -0
- package/models/list-refunds-response-class.ts +3 -3
- package/models/list-tenant-bank-account-response-class.ts +37 -0
- package/models/payment-class-without-expand-properties.ts +114 -0
- package/models/payment-class.ts +121 -0
- package/models/payment-method-class.ts +84 -0
- package/models/payment-reminder-class.ts +108 -0
- package/models/primary-bank-account-response-class.ts +60 -0
- package/models/refund-class.ts +19 -5
- package/models/refund-item-class.ts +120 -0
- package/models/sepa-direct-dto.ts +30 -0
- package/models/set-primary-bank-account-request-dto-rest.ts +30 -0
- package/models/shared-transaction-class.ts +78 -0
- package/models/symphony-profile-limited-response-dto.ts +48 -0
- package/models/{tenant-bank-account-response-class.ts → tenant-bank-account-class-without-expand-properties.ts} +23 -11
- package/models/tenant-bank-account-class.ts +91 -0
- package/models/unlink-bank-transaction-request-dto-rest.ts +2 -2
- package/models/unlink-bank-transactions-response-class.ts +31 -0
- package/models/unlinked-bank-transaction-response-class.ts +114 -0
- package/models/update-bank-account-request-dto-rest.ts +36 -0
- package/models/update-bank-account-request-dto.ts +42 -0
- package/models/update-bank-account-response-class.ts +31 -0
- package/models/update-tenant-bank-account-response-class.ts +31 -0
- package/models/update-tenant-bank-account-rest-request-dto.ts +1 -1
- package/models/validate-pspconfig-request-dto.ts +12 -2
- package/package.json +1 -1
- package/dist/api/default-api.d.ts +0 -66
- package/dist/models/get-request-dto.d.ts +0 -30
- package/dist/models/transaction-class.d.ts +0 -54
- package/models/get-request-dto.ts +0 -36
- package/models/transaction-class.ts +0 -60
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
/* eslint-disable */
|
|
4
4
|
/**
|
|
5
5
|
* Emil Payment Service
|
|
6
|
-
* This service directly communicates with the various Payment Service Providers (PSPs)
|
|
6
|
+
* 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.
|
|
7
7
|
*
|
|
8
8
|
* The version of the OpenAPI document: 1.0
|
|
9
9
|
* Contact: kontakt@emil.de
|
|
@@ -94,7 +94,7 @@ var PaymentRemindersApiAxiosParamCreator = function (configuration) {
|
|
|
94
94
|
return {
|
|
95
95
|
/**
|
|
96
96
|
* This will create a payment reminder in the database.
|
|
97
|
-
* @summary Create the payment
|
|
97
|
+
* @summary Create the payment reminder
|
|
98
98
|
* @param {CreatePaymentReminderRequestDto} createPaymentReminderRequestDto
|
|
99
99
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
100
100
|
* @param {*} [options] Override http request option.
|
|
@@ -142,8 +142,8 @@ var PaymentRemindersApiAxiosParamCreator = function (configuration) {
|
|
|
142
142
|
});
|
|
143
143
|
},
|
|
144
144
|
/**
|
|
145
|
-
*
|
|
146
|
-
* @summary
|
|
145
|
+
* This will deactivate the payment reminder
|
|
146
|
+
* @summary Deactivate payment reminder
|
|
147
147
|
* @param {string} code Unique identifier for the object.
|
|
148
148
|
* @param {DeactivatePaymentReminderRequestDto} deactivatePaymentReminderRequestDto
|
|
149
149
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -195,9 +195,9 @@ var PaymentRemindersApiAxiosParamCreator = function (configuration) {
|
|
|
195
195
|
});
|
|
196
196
|
},
|
|
197
197
|
/**
|
|
198
|
-
* Retrieves the details of the payment reminder that was previously created. Supply the unique payment reminder code
|
|
198
|
+
* Retrieves the details of the payment reminder that was previously created. Supply the unique payment reminder code that was returned when you created it and Emil Api will return the corresponding payment reminder information.
|
|
199
199
|
* @summary Retrieve the payment reminder
|
|
200
|
-
* @param {string} code
|
|
200
|
+
* @param {string} code
|
|
201
201
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
202
202
|
* @param {*} [options] Override http request option.
|
|
203
203
|
* @throws {RequiredError}
|
|
@@ -243,20 +243,17 @@ var PaymentRemindersApiAxiosParamCreator = function (configuration) {
|
|
|
243
243
|
});
|
|
244
244
|
},
|
|
245
245
|
/**
|
|
246
|
-
* Returns a list of payment reminders you have previously created.
|
|
246
|
+
* 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.
|
|
247
247
|
* @summary List payment reminders
|
|
248
248
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
249
|
-
* @param {
|
|
250
|
-
* @param {
|
|
251
|
-
* @param {
|
|
252
|
-
* @param {
|
|
253
|
-
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
254
|
-
* @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
255
|
-
* @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
249
|
+
* @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>
|
|
250
|
+
* @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>
|
|
251
|
+
* @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>
|
|
252
|
+
* @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: <i>
|
|
256
253
|
* @param {*} [options] Override http request option.
|
|
257
254
|
* @throws {RequiredError}
|
|
258
255
|
*/
|
|
259
|
-
listPaymentReminders: function (authorization,
|
|
256
|
+
listPaymentReminders: function (authorization, filter, filters, order, expand, options) {
|
|
260
257
|
if (options === void 0) { options = {}; }
|
|
261
258
|
return __awaiter(_this, void 0, void 0, function () {
|
|
262
259
|
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
@@ -279,17 +276,11 @@ var PaymentRemindersApiAxiosParamCreator = function (configuration) {
|
|
|
279
276
|
// authentication bearer required
|
|
280
277
|
// http bearer authentication required
|
|
281
278
|
_a.sent();
|
|
282
|
-
if (pageSize !== undefined) {
|
|
283
|
-
localVarQueryParameter['pageSize'] = pageSize;
|
|
284
|
-
}
|
|
285
|
-
if (pageToken !== undefined) {
|
|
286
|
-
localVarQueryParameter['pageToken'] = pageToken;
|
|
287
|
-
}
|
|
288
279
|
if (filter !== undefined) {
|
|
289
280
|
localVarQueryParameter['filter'] = filter;
|
|
290
281
|
}
|
|
291
|
-
if (
|
|
292
|
-
localVarQueryParameter['
|
|
282
|
+
if (filters !== undefined) {
|
|
283
|
+
localVarQueryParameter['filters'] = filters;
|
|
293
284
|
}
|
|
294
285
|
if (order !== undefined) {
|
|
295
286
|
localVarQueryParameter['order'] = order;
|
|
@@ -297,9 +288,6 @@ var PaymentRemindersApiAxiosParamCreator = function (configuration) {
|
|
|
297
288
|
if (expand !== undefined) {
|
|
298
289
|
localVarQueryParameter['expand'] = expand;
|
|
299
290
|
}
|
|
300
|
-
if (filters !== undefined) {
|
|
301
|
-
localVarQueryParameter['filters'] = filters;
|
|
302
|
-
}
|
|
303
291
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
304
292
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
305
293
|
}
|
|
@@ -326,7 +314,7 @@ var PaymentRemindersApiFp = function (configuration) {
|
|
|
326
314
|
return {
|
|
327
315
|
/**
|
|
328
316
|
* This will create a payment reminder in the database.
|
|
329
|
-
* @summary Create the payment
|
|
317
|
+
* @summary Create the payment reminder
|
|
330
318
|
* @param {CreatePaymentReminderRequestDto} createPaymentReminderRequestDto
|
|
331
319
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
332
320
|
* @param {*} [options] Override http request option.
|
|
@@ -346,8 +334,8 @@ var PaymentRemindersApiFp = function (configuration) {
|
|
|
346
334
|
});
|
|
347
335
|
},
|
|
348
336
|
/**
|
|
349
|
-
*
|
|
350
|
-
* @summary
|
|
337
|
+
* This will deactivate the payment reminder
|
|
338
|
+
* @summary Deactivate payment reminder
|
|
351
339
|
* @param {string} code Unique identifier for the object.
|
|
352
340
|
* @param {DeactivatePaymentReminderRequestDto} deactivatePaymentReminderRequestDto
|
|
353
341
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -368,9 +356,9 @@ var PaymentRemindersApiFp = function (configuration) {
|
|
|
368
356
|
});
|
|
369
357
|
},
|
|
370
358
|
/**
|
|
371
|
-
* Retrieves the details of the payment reminder that was previously created. Supply the unique payment reminder code
|
|
359
|
+
* Retrieves the details of the payment reminder that was previously created. Supply the unique payment reminder code that was returned when you created it and Emil Api will return the corresponding payment reminder information.
|
|
372
360
|
* @summary Retrieve the payment reminder
|
|
373
|
-
* @param {string} code
|
|
361
|
+
* @param {string} code
|
|
374
362
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
375
363
|
* @param {*} [options] Override http request option.
|
|
376
364
|
* @throws {RequiredError}
|
|
@@ -389,25 +377,22 @@ var PaymentRemindersApiFp = function (configuration) {
|
|
|
389
377
|
});
|
|
390
378
|
},
|
|
391
379
|
/**
|
|
392
|
-
* Returns a list of payment reminders you have previously created.
|
|
380
|
+
* 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.
|
|
393
381
|
* @summary List payment reminders
|
|
394
382
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
395
|
-
* @param {
|
|
396
|
-
* @param {
|
|
397
|
-
* @param {
|
|
398
|
-
* @param {
|
|
399
|
-
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
400
|
-
* @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
401
|
-
* @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
383
|
+
* @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>
|
|
384
|
+
* @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>
|
|
385
|
+
* @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>
|
|
386
|
+
* @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: <i>
|
|
402
387
|
* @param {*} [options] Override http request option.
|
|
403
388
|
* @throws {RequiredError}
|
|
404
389
|
*/
|
|
405
|
-
listPaymentReminders: function (authorization,
|
|
390
|
+
listPaymentReminders: function (authorization, filter, filters, order, expand, options) {
|
|
406
391
|
return __awaiter(this, void 0, void 0, function () {
|
|
407
392
|
var localVarAxiosArgs;
|
|
408
393
|
return __generator(this, function (_a) {
|
|
409
394
|
switch (_a.label) {
|
|
410
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.listPaymentReminders(authorization,
|
|
395
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.listPaymentReminders(authorization, filter, filters, order, expand, options)];
|
|
411
396
|
case 1:
|
|
412
397
|
localVarAxiosArgs = _a.sent();
|
|
413
398
|
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
@@ -427,7 +412,7 @@ var PaymentRemindersApiFactory = function (configuration, basePath, axios) {
|
|
|
427
412
|
return {
|
|
428
413
|
/**
|
|
429
414
|
* This will create a payment reminder in the database.
|
|
430
|
-
* @summary Create the payment
|
|
415
|
+
* @summary Create the payment reminder
|
|
431
416
|
* @param {CreatePaymentReminderRequestDto} createPaymentReminderRequestDto
|
|
432
417
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
433
418
|
* @param {*} [options] Override http request option.
|
|
@@ -437,8 +422,8 @@ var PaymentRemindersApiFactory = function (configuration, basePath, axios) {
|
|
|
437
422
|
return localVarFp.createPaymentReminder(createPaymentReminderRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
438
423
|
},
|
|
439
424
|
/**
|
|
440
|
-
*
|
|
441
|
-
* @summary
|
|
425
|
+
* This will deactivate the payment reminder
|
|
426
|
+
* @summary Deactivate payment reminder
|
|
442
427
|
* @param {string} code Unique identifier for the object.
|
|
443
428
|
* @param {DeactivatePaymentReminderRequestDto} deactivatePaymentReminderRequestDto
|
|
444
429
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -449,9 +434,9 @@ var PaymentRemindersApiFactory = function (configuration, basePath, axios) {
|
|
|
449
434
|
return localVarFp.deactivatePaymentReminder(code, deactivatePaymentReminderRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
450
435
|
},
|
|
451
436
|
/**
|
|
452
|
-
* Retrieves the details of the payment reminder that was previously created. Supply the unique payment reminder code
|
|
437
|
+
* Retrieves the details of the payment reminder that was previously created. Supply the unique payment reminder code that was returned when you created it and Emil Api will return the corresponding payment reminder information.
|
|
453
438
|
* @summary Retrieve the payment reminder
|
|
454
|
-
* @param {string} code
|
|
439
|
+
* @param {string} code
|
|
455
440
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
456
441
|
* @param {*} [options] Override http request option.
|
|
457
442
|
* @throws {RequiredError}
|
|
@@ -460,21 +445,18 @@ var PaymentRemindersApiFactory = function (configuration, basePath, axios) {
|
|
|
460
445
|
return localVarFp.getPolicy(code, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
461
446
|
},
|
|
462
447
|
/**
|
|
463
|
-
* Returns a list of payment reminders you have previously created.
|
|
448
|
+
* 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.
|
|
464
449
|
* @summary List payment reminders
|
|
465
450
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
466
|
-
* @param {
|
|
467
|
-
* @param {
|
|
468
|
-
* @param {
|
|
469
|
-
* @param {
|
|
470
|
-
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
471
|
-
* @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
472
|
-
* @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
451
|
+
* @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>
|
|
452
|
+
* @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>
|
|
453
|
+
* @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>
|
|
454
|
+
* @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: <i>
|
|
473
455
|
* @param {*} [options] Override http request option.
|
|
474
456
|
* @throws {RequiredError}
|
|
475
457
|
*/
|
|
476
|
-
listPaymentReminders: function (authorization,
|
|
477
|
-
return localVarFp.listPaymentReminders(authorization,
|
|
458
|
+
listPaymentReminders: function (authorization, filter, filters, order, expand, options) {
|
|
459
|
+
return localVarFp.listPaymentReminders(authorization, filter, filters, order, expand, options).then(function (request) { return request(axios, basePath); });
|
|
478
460
|
},
|
|
479
461
|
};
|
|
480
462
|
};
|
|
@@ -492,7 +474,7 @@ var PaymentRemindersApi = /** @class */ (function (_super) {
|
|
|
492
474
|
}
|
|
493
475
|
/**
|
|
494
476
|
* This will create a payment reminder in the database.
|
|
495
|
-
* @summary Create the payment
|
|
477
|
+
* @summary Create the payment reminder
|
|
496
478
|
* @param {PaymentRemindersApiCreatePaymentReminderRequest} requestParameters Request parameters.
|
|
497
479
|
* @param {*} [options] Override http request option.
|
|
498
480
|
* @throws {RequiredError}
|
|
@@ -503,8 +485,8 @@ var PaymentRemindersApi = /** @class */ (function (_super) {
|
|
|
503
485
|
return (0, exports.PaymentRemindersApiFp)(this.configuration).createPaymentReminder(requestParameters.createPaymentReminderRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
504
486
|
};
|
|
505
487
|
/**
|
|
506
|
-
*
|
|
507
|
-
* @summary
|
|
488
|
+
* This will deactivate the payment reminder
|
|
489
|
+
* @summary Deactivate payment reminder
|
|
508
490
|
* @param {PaymentRemindersApiDeactivatePaymentReminderRequest} requestParameters Request parameters.
|
|
509
491
|
* @param {*} [options] Override http request option.
|
|
510
492
|
* @throws {RequiredError}
|
|
@@ -515,7 +497,7 @@ var PaymentRemindersApi = /** @class */ (function (_super) {
|
|
|
515
497
|
return (0, exports.PaymentRemindersApiFp)(this.configuration).deactivatePaymentReminder(requestParameters.code, requestParameters.deactivatePaymentReminderRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
516
498
|
};
|
|
517
499
|
/**
|
|
518
|
-
* Retrieves the details of the payment reminder that was previously created. Supply the unique payment reminder code
|
|
500
|
+
* Retrieves the details of the payment reminder that was previously created. Supply the unique payment reminder code that was returned when you created it and Emil Api will return the corresponding payment reminder information.
|
|
519
501
|
* @summary Retrieve the payment reminder
|
|
520
502
|
* @param {PaymentRemindersApiGetPolicyRequest} requestParameters Request parameters.
|
|
521
503
|
* @param {*} [options] Override http request option.
|
|
@@ -527,7 +509,7 @@ var PaymentRemindersApi = /** @class */ (function (_super) {
|
|
|
527
509
|
return (0, exports.PaymentRemindersApiFp)(this.configuration).getPolicy(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
528
510
|
};
|
|
529
511
|
/**
|
|
530
|
-
* Returns a list of payment reminders you have previously created.
|
|
512
|
+
* 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.
|
|
531
513
|
* @summary List payment reminders
|
|
532
514
|
* @param {PaymentRemindersApiListPaymentRemindersRequest} requestParameters Request parameters.
|
|
533
515
|
* @param {*} [options] Override http request option.
|
|
@@ -537,7 +519,7 @@ var PaymentRemindersApi = /** @class */ (function (_super) {
|
|
|
537
519
|
PaymentRemindersApi.prototype.listPaymentReminders = function (requestParameters, options) {
|
|
538
520
|
var _this = this;
|
|
539
521
|
if (requestParameters === void 0) { requestParameters = {}; }
|
|
540
|
-
return (0, exports.PaymentRemindersApiFp)(this.configuration).listPaymentReminders(requestParameters.authorization, requestParameters.
|
|
522
|
+
return (0, exports.PaymentRemindersApiFp)(this.configuration).listPaymentReminders(requestParameters.authorization, requestParameters.filter, requestParameters.filters, requestParameters.order, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
541
523
|
};
|
|
542
524
|
return PaymentRemindersApi;
|
|
543
525
|
}(base_1.BaseAPI));
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Emil Payment Service
|
|
3
|
-
* This service directly communicates with the various Payment Service Providers (PSPs)
|
|
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
4
|
*
|
|
5
5
|
* The version of the OpenAPI document: 1.0
|
|
6
6
|
* Contact: kontakt@emil.de
|
|
@@ -12,27 +12,33 @@
|
|
|
12
12
|
import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
13
13
|
import { Configuration } from '../configuration';
|
|
14
14
|
import { RequestArgs, BaseAPI } from '../base';
|
|
15
|
+
import { CompletePaymentSetupRequestDto } from '../models';
|
|
16
|
+
import { CompletePaymentSetupResponseClass } from '../models';
|
|
17
|
+
import { InitiatePaymentSetupRequestDto } from '../models';
|
|
18
|
+
import { InitiatePaymentSetupResponseClass } from '../models';
|
|
15
19
|
/**
|
|
16
20
|
* PaymentSetupApi - axios parameter creator
|
|
17
21
|
* @export
|
|
18
22
|
*/
|
|
19
23
|
export declare const PaymentSetupApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
20
24
|
/**
|
|
21
|
-
*
|
|
22
|
-
* @
|
|
25
|
+
* This endpoint is used to save user-provided payment information. The service will send a request to the configured PSP to securely store the payment data.
|
|
26
|
+
* @summary Complete a payment setup
|
|
27
|
+
* @param {CompletePaymentSetupRequestDto} completePaymentSetupRequestDto
|
|
23
28
|
* @param {string} [authorization] Bearer Token
|
|
24
29
|
* @param {*} [options] Override http request option.
|
|
25
30
|
* @throws {RequiredError}
|
|
26
31
|
*/
|
|
27
|
-
completePaymentSetup: (
|
|
32
|
+
completePaymentSetup: (completePaymentSetupRequestDto: CompletePaymentSetupRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
28
33
|
/**
|
|
29
|
-
*
|
|
30
|
-
* @
|
|
34
|
+
* This initiates an account within the configured payment service provider, whichgenerates a secret token, allowing the user to add their payment information.
|
|
35
|
+
* @summary Initiate a payment setup
|
|
36
|
+
* @param {InitiatePaymentSetupRequestDto} initiatePaymentSetupRequestDto
|
|
31
37
|
* @param {string} [authorization] Bearer Token
|
|
32
38
|
* @param {*} [options] Override http request option.
|
|
33
39
|
* @throws {RequiredError}
|
|
34
40
|
*/
|
|
35
|
-
initiatePaymentSetup: (
|
|
41
|
+
initiatePaymentSetup: (initiatePaymentSetupRequestDto: InitiatePaymentSetupRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
36
42
|
};
|
|
37
43
|
/**
|
|
38
44
|
* PaymentSetupApi - functional programming interface
|
|
@@ -40,21 +46,23 @@ export declare const PaymentSetupApiAxiosParamCreator: (configuration?: Configur
|
|
|
40
46
|
*/
|
|
41
47
|
export declare const PaymentSetupApiFp: (configuration?: Configuration) => {
|
|
42
48
|
/**
|
|
43
|
-
*
|
|
44
|
-
* @
|
|
49
|
+
* This endpoint is used to save user-provided payment information. The service will send a request to the configured PSP to securely store the payment data.
|
|
50
|
+
* @summary Complete a payment setup
|
|
51
|
+
* @param {CompletePaymentSetupRequestDto} completePaymentSetupRequestDto
|
|
45
52
|
* @param {string} [authorization] Bearer Token
|
|
46
53
|
* @param {*} [options] Override http request option.
|
|
47
54
|
* @throws {RequiredError}
|
|
48
55
|
*/
|
|
49
|
-
completePaymentSetup(
|
|
56
|
+
completePaymentSetup(completePaymentSetupRequestDto: CompletePaymentSetupRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CompletePaymentSetupResponseClass>>;
|
|
50
57
|
/**
|
|
51
|
-
*
|
|
52
|
-
* @
|
|
58
|
+
* This initiates an account within the configured payment service provider, whichgenerates a secret token, allowing the user to add their payment information.
|
|
59
|
+
* @summary Initiate a payment setup
|
|
60
|
+
* @param {InitiatePaymentSetupRequestDto} initiatePaymentSetupRequestDto
|
|
53
61
|
* @param {string} [authorization] Bearer Token
|
|
54
62
|
* @param {*} [options] Override http request option.
|
|
55
63
|
* @throws {RequiredError}
|
|
56
64
|
*/
|
|
57
|
-
initiatePaymentSetup(
|
|
65
|
+
initiatePaymentSetup(initiatePaymentSetupRequestDto: InitiatePaymentSetupRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InitiatePaymentSetupResponseClass>>;
|
|
58
66
|
};
|
|
59
67
|
/**
|
|
60
68
|
* PaymentSetupApi - factory interface
|
|
@@ -62,21 +70,23 @@ export declare const PaymentSetupApiFp: (configuration?: Configuration) => {
|
|
|
62
70
|
*/
|
|
63
71
|
export declare const PaymentSetupApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
64
72
|
/**
|
|
65
|
-
*
|
|
66
|
-
* @
|
|
73
|
+
* This endpoint is used to save user-provided payment information. The service will send a request to the configured PSP to securely store the payment data.
|
|
74
|
+
* @summary Complete a payment setup
|
|
75
|
+
* @param {CompletePaymentSetupRequestDto} completePaymentSetupRequestDto
|
|
67
76
|
* @param {string} [authorization] Bearer Token
|
|
68
77
|
* @param {*} [options] Override http request option.
|
|
69
78
|
* @throws {RequiredError}
|
|
70
79
|
*/
|
|
71
|
-
completePaymentSetup(
|
|
80
|
+
completePaymentSetup(completePaymentSetupRequestDto: CompletePaymentSetupRequestDto, authorization?: string, options?: any): AxiosPromise<CompletePaymentSetupResponseClass>;
|
|
72
81
|
/**
|
|
73
|
-
*
|
|
74
|
-
* @
|
|
82
|
+
* This initiates an account within the configured payment service provider, whichgenerates a secret token, allowing the user to add their payment information.
|
|
83
|
+
* @summary Initiate a payment setup
|
|
84
|
+
* @param {InitiatePaymentSetupRequestDto} initiatePaymentSetupRequestDto
|
|
75
85
|
* @param {string} [authorization] Bearer Token
|
|
76
86
|
* @param {*} [options] Override http request option.
|
|
77
87
|
* @throws {RequiredError}
|
|
78
88
|
*/
|
|
79
|
-
initiatePaymentSetup(
|
|
89
|
+
initiatePaymentSetup(initiatePaymentSetupRequestDto: InitiatePaymentSetupRequestDto, authorization?: string, options?: any): AxiosPromise<InitiatePaymentSetupResponseClass>;
|
|
80
90
|
};
|
|
81
91
|
/**
|
|
82
92
|
* Request parameters for completePaymentSetup operation in PaymentSetupApi.
|
|
@@ -86,10 +96,10 @@ export declare const PaymentSetupApiFactory: (configuration?: Configuration, bas
|
|
|
86
96
|
export interface PaymentSetupApiCompletePaymentSetupRequest {
|
|
87
97
|
/**
|
|
88
98
|
*
|
|
89
|
-
* @type {
|
|
99
|
+
* @type {CompletePaymentSetupRequestDto}
|
|
90
100
|
* @memberof PaymentSetupApiCompletePaymentSetup
|
|
91
101
|
*/
|
|
92
|
-
readonly
|
|
102
|
+
readonly completePaymentSetupRequestDto: CompletePaymentSetupRequestDto;
|
|
93
103
|
/**
|
|
94
104
|
* Bearer Token
|
|
95
105
|
* @type {string}
|
|
@@ -105,10 +115,10 @@ export interface PaymentSetupApiCompletePaymentSetupRequest {
|
|
|
105
115
|
export interface PaymentSetupApiInitiatePaymentSetupRequest {
|
|
106
116
|
/**
|
|
107
117
|
*
|
|
108
|
-
* @type {
|
|
118
|
+
* @type {InitiatePaymentSetupRequestDto}
|
|
109
119
|
* @memberof PaymentSetupApiInitiatePaymentSetup
|
|
110
120
|
*/
|
|
111
|
-
readonly
|
|
121
|
+
readonly initiatePaymentSetupRequestDto: InitiatePaymentSetupRequestDto;
|
|
112
122
|
/**
|
|
113
123
|
* Bearer Token
|
|
114
124
|
* @type {string}
|
|
@@ -124,19 +134,21 @@ export interface PaymentSetupApiInitiatePaymentSetupRequest {
|
|
|
124
134
|
*/
|
|
125
135
|
export declare class PaymentSetupApi extends BaseAPI {
|
|
126
136
|
/**
|
|
127
|
-
*
|
|
137
|
+
* This endpoint is used to save user-provided payment information. The service will send a request to the configured PSP to securely store the payment data.
|
|
138
|
+
* @summary Complete a payment setup
|
|
128
139
|
* @param {PaymentSetupApiCompletePaymentSetupRequest} requestParameters Request parameters.
|
|
129
140
|
* @param {*} [options] Override http request option.
|
|
130
141
|
* @throws {RequiredError}
|
|
131
142
|
* @memberof PaymentSetupApi
|
|
132
143
|
*/
|
|
133
|
-
completePaymentSetup(requestParameters: PaymentSetupApiCompletePaymentSetupRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
144
|
+
completePaymentSetup(requestParameters: PaymentSetupApiCompletePaymentSetupRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CompletePaymentSetupResponseClass, any>>;
|
|
134
145
|
/**
|
|
135
|
-
*
|
|
146
|
+
* This initiates an account within the configured payment service provider, whichgenerates a secret token, allowing the user to add their payment information.
|
|
147
|
+
* @summary Initiate a payment setup
|
|
136
148
|
* @param {PaymentSetupApiInitiatePaymentSetupRequest} requestParameters Request parameters.
|
|
137
149
|
* @param {*} [options] Override http request option.
|
|
138
150
|
* @throws {RequiredError}
|
|
139
151
|
* @memberof PaymentSetupApi
|
|
140
152
|
*/
|
|
141
|
-
initiatePaymentSetup(requestParameters: PaymentSetupApiInitiatePaymentSetupRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
153
|
+
initiatePaymentSetup(requestParameters: PaymentSetupApiInitiatePaymentSetupRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<InitiatePaymentSetupResponseClass, any>>;
|
|
142
154
|
}
|