@emilgroup/payment-sdk-node 1.13.1-beta.8 → 1.14.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 +18 -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 +17 -9
- 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 +5 -3
- package/dist/base.js +27 -21
- 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
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* Emil Payment Service
|
|
5
|
-
* This service directly communicates with the various Payment Service Providers (PSPs)
|
|
5
|
+
* 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.
|
|
6
6
|
*
|
|
7
7
|
* The version of the OpenAPI document: 1.0
|
|
8
8
|
* Contact: kontakt@emil.de
|
|
@@ -23,7 +23,15 @@ import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } fr
|
|
|
23
23
|
// @ts-ignore
|
|
24
24
|
import { CreatePaymentReminderRequestDto } from '../models';
|
|
25
25
|
// @ts-ignore
|
|
26
|
+
import { CreatePaymentReminderResponseClass } from '../models';
|
|
27
|
+
// @ts-ignore
|
|
26
28
|
import { DeactivatePaymentReminderRequestDto } from '../models';
|
|
29
|
+
// @ts-ignore
|
|
30
|
+
import { DeactivatePaymentReminderResponseClass } from '../models';
|
|
31
|
+
// @ts-ignore
|
|
32
|
+
import { GetPaymentReminderResponseClass } from '../models';
|
|
33
|
+
// @ts-ignore
|
|
34
|
+
import { ListPaymentRemindersResponseClass } from '../models';
|
|
27
35
|
// URLSearchParams not necessarily used
|
|
28
36
|
// @ts-ignore
|
|
29
37
|
import { URL, URLSearchParams } from 'url';
|
|
@@ -36,7 +44,7 @@ export const PaymentRemindersApiAxiosParamCreator = function (configuration?: Co
|
|
|
36
44
|
return {
|
|
37
45
|
/**
|
|
38
46
|
* This will create a payment reminder in the database.
|
|
39
|
-
* @summary Create the payment
|
|
47
|
+
* @summary Create the payment reminder
|
|
40
48
|
* @param {CreatePaymentReminderRequestDto} createPaymentReminderRequestDto
|
|
41
49
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
42
50
|
* @param {*} [options] Override http request option.
|
|
@@ -82,8 +90,8 @@ export const PaymentRemindersApiAxiosParamCreator = function (configuration?: Co
|
|
|
82
90
|
};
|
|
83
91
|
},
|
|
84
92
|
/**
|
|
85
|
-
*
|
|
86
|
-
* @summary
|
|
93
|
+
* This will deactivate the payment reminder
|
|
94
|
+
* @summary Deactivate payment reminder
|
|
87
95
|
* @param {string} code Unique identifier for the object.
|
|
88
96
|
* @param {DeactivatePaymentReminderRequestDto} deactivatePaymentReminderRequestDto
|
|
89
97
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -133,9 +141,9 @@ export const PaymentRemindersApiAxiosParamCreator = function (configuration?: Co
|
|
|
133
141
|
};
|
|
134
142
|
},
|
|
135
143
|
/**
|
|
136
|
-
* Retrieves the details of the payment reminder that was previously created. Supply the unique payment reminder code
|
|
144
|
+
* 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.
|
|
137
145
|
* @summary Retrieve the payment reminder
|
|
138
|
-
* @param {string} code
|
|
146
|
+
* @param {string} code
|
|
139
147
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
140
148
|
* @param {*} [options] Override http request option.
|
|
141
149
|
* @throws {RequiredError}
|
|
@@ -178,20 +186,17 @@ export const PaymentRemindersApiAxiosParamCreator = function (configuration?: Co
|
|
|
178
186
|
};
|
|
179
187
|
},
|
|
180
188
|
/**
|
|
181
|
-
* Returns a list of payment reminders you have previously created.
|
|
189
|
+
* Returns a list of payment reminders you have previously created. The payment reminders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
182
190
|
* @summary List payment reminders
|
|
183
191
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
184
|
-
* @param {
|
|
185
|
-
* @param {
|
|
186
|
-
* @param {
|
|
187
|
-
* @param {
|
|
188
|
-
* @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.
|
|
189
|
-
* @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.
|
|
190
|
-
* @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.
|
|
192
|
+
* @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>
|
|
193
|
+
* @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>
|
|
194
|
+
* @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>
|
|
195
|
+
* @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>
|
|
191
196
|
* @param {*} [options] Override http request option.
|
|
192
197
|
* @throws {RequiredError}
|
|
193
198
|
*/
|
|
194
|
-
listPaymentReminders: async (authorization?: string,
|
|
199
|
+
listPaymentReminders: async (authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
195
200
|
const localVarPath = `/paymentservice/v1/payment-reminders`;
|
|
196
201
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
197
202
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -210,20 +215,12 @@ export const PaymentRemindersApiAxiosParamCreator = function (configuration?: Co
|
|
|
210
215
|
// http bearer authentication required
|
|
211
216
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
212
217
|
|
|
213
|
-
if (pageSize !== undefined) {
|
|
214
|
-
localVarQueryParameter['pageSize'] = pageSize;
|
|
215
|
-
}
|
|
216
|
-
|
|
217
|
-
if (pageToken !== undefined) {
|
|
218
|
-
localVarQueryParameter['pageToken'] = pageToken;
|
|
219
|
-
}
|
|
220
|
-
|
|
221
218
|
if (filter !== undefined) {
|
|
222
219
|
localVarQueryParameter['filter'] = filter;
|
|
223
220
|
}
|
|
224
221
|
|
|
225
|
-
if (
|
|
226
|
-
localVarQueryParameter['
|
|
222
|
+
if (filters !== undefined) {
|
|
223
|
+
localVarQueryParameter['filters'] = filters;
|
|
227
224
|
}
|
|
228
225
|
|
|
229
226
|
if (order !== undefined) {
|
|
@@ -234,10 +231,6 @@ export const PaymentRemindersApiAxiosParamCreator = function (configuration?: Co
|
|
|
234
231
|
localVarQueryParameter['expand'] = expand;
|
|
235
232
|
}
|
|
236
233
|
|
|
237
|
-
if (filters !== undefined) {
|
|
238
|
-
localVarQueryParameter['filters'] = filters;
|
|
239
|
-
}
|
|
240
|
-
|
|
241
234
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
242
235
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
243
236
|
}
|
|
@@ -265,57 +258,54 @@ export const PaymentRemindersApiFp = function(configuration?: Configuration) {
|
|
|
265
258
|
return {
|
|
266
259
|
/**
|
|
267
260
|
* This will create a payment reminder in the database.
|
|
268
|
-
* @summary Create the payment
|
|
261
|
+
* @summary Create the payment reminder
|
|
269
262
|
* @param {CreatePaymentReminderRequestDto} createPaymentReminderRequestDto
|
|
270
263
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
271
264
|
* @param {*} [options] Override http request option.
|
|
272
265
|
* @throws {RequiredError}
|
|
273
266
|
*/
|
|
274
|
-
async createPaymentReminder(createPaymentReminderRequestDto: CreatePaymentReminderRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
267
|
+
async createPaymentReminder(createPaymentReminderRequestDto: CreatePaymentReminderRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePaymentReminderResponseClass>> {
|
|
275
268
|
const localVarAxiosArgs = await localVarAxiosParamCreator.createPaymentReminder(createPaymentReminderRequestDto, authorization, options);
|
|
276
269
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
277
270
|
},
|
|
278
271
|
/**
|
|
279
|
-
*
|
|
280
|
-
* @summary
|
|
272
|
+
* This will deactivate the payment reminder
|
|
273
|
+
* @summary Deactivate payment reminder
|
|
281
274
|
* @param {string} code Unique identifier for the object.
|
|
282
275
|
* @param {DeactivatePaymentReminderRequestDto} deactivatePaymentReminderRequestDto
|
|
283
276
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
284
277
|
* @param {*} [options] Override http request option.
|
|
285
278
|
* @throws {RequiredError}
|
|
286
279
|
*/
|
|
287
|
-
async deactivatePaymentReminder(code: string, deactivatePaymentReminderRequestDto: DeactivatePaymentReminderRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
280
|
+
async deactivatePaymentReminder(code: string, deactivatePaymentReminderRequestDto: DeactivatePaymentReminderRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeactivatePaymentReminderResponseClass>> {
|
|
288
281
|
const localVarAxiosArgs = await localVarAxiosParamCreator.deactivatePaymentReminder(code, deactivatePaymentReminderRequestDto, authorization, options);
|
|
289
282
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
290
283
|
},
|
|
291
284
|
/**
|
|
292
|
-
* Retrieves the details of the payment reminder that was previously created. Supply the unique payment reminder code
|
|
285
|
+
* 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.
|
|
293
286
|
* @summary Retrieve the payment reminder
|
|
294
|
-
* @param {string} code
|
|
287
|
+
* @param {string} code
|
|
295
288
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
296
289
|
* @param {*} [options] Override http request option.
|
|
297
290
|
* @throws {RequiredError}
|
|
298
291
|
*/
|
|
299
|
-
async getPolicy(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
292
|
+
async getPolicy(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPaymentReminderResponseClass>> {
|
|
300
293
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getPolicy(code, authorization, options);
|
|
301
294
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
302
295
|
},
|
|
303
296
|
/**
|
|
304
|
-
* Returns a list of payment reminders you have previously created.
|
|
297
|
+
* 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.
|
|
305
298
|
* @summary List payment reminders
|
|
306
299
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
307
|
-
* @param {
|
|
308
|
-
* @param {
|
|
309
|
-
* @param {
|
|
310
|
-
* @param {
|
|
311
|
-
* @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.
|
|
312
|
-
* @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.
|
|
313
|
-
* @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.
|
|
300
|
+
* @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>
|
|
301
|
+
* @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>
|
|
302
|
+
* @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>
|
|
303
|
+
* @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>
|
|
314
304
|
* @param {*} [options] Override http request option.
|
|
315
305
|
* @throws {RequiredError}
|
|
316
306
|
*/
|
|
317
|
-
async listPaymentReminders(authorization?: string,
|
|
318
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listPaymentReminders(authorization,
|
|
307
|
+
async listPaymentReminders(authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPaymentRemindersResponseClass>> {
|
|
308
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listPaymentReminders(authorization, filter, filters, order, expand, options);
|
|
319
309
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
320
310
|
},
|
|
321
311
|
}
|
|
@@ -330,54 +320,51 @@ export const PaymentRemindersApiFactory = function (configuration?: Configuratio
|
|
|
330
320
|
return {
|
|
331
321
|
/**
|
|
332
322
|
* This will create a payment reminder in the database.
|
|
333
|
-
* @summary Create the payment
|
|
323
|
+
* @summary Create the payment reminder
|
|
334
324
|
* @param {CreatePaymentReminderRequestDto} createPaymentReminderRequestDto
|
|
335
325
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
336
326
|
* @param {*} [options] Override http request option.
|
|
337
327
|
* @throws {RequiredError}
|
|
338
328
|
*/
|
|
339
|
-
createPaymentReminder(createPaymentReminderRequestDto: CreatePaymentReminderRequestDto, authorization?: string, options?: any): AxiosPromise<
|
|
329
|
+
createPaymentReminder(createPaymentReminderRequestDto: CreatePaymentReminderRequestDto, authorization?: string, options?: any): AxiosPromise<CreatePaymentReminderResponseClass> {
|
|
340
330
|
return localVarFp.createPaymentReminder(createPaymentReminderRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
341
331
|
},
|
|
342
332
|
/**
|
|
343
|
-
*
|
|
344
|
-
* @summary
|
|
333
|
+
* This will deactivate the payment reminder
|
|
334
|
+
* @summary Deactivate payment reminder
|
|
345
335
|
* @param {string} code Unique identifier for the object.
|
|
346
336
|
* @param {DeactivatePaymentReminderRequestDto} deactivatePaymentReminderRequestDto
|
|
347
337
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
348
338
|
* @param {*} [options] Override http request option.
|
|
349
339
|
* @throws {RequiredError}
|
|
350
340
|
*/
|
|
351
|
-
deactivatePaymentReminder(code: string, deactivatePaymentReminderRequestDto: DeactivatePaymentReminderRequestDto, authorization?: string, options?: any): AxiosPromise<
|
|
341
|
+
deactivatePaymentReminder(code: string, deactivatePaymentReminderRequestDto: DeactivatePaymentReminderRequestDto, authorization?: string, options?: any): AxiosPromise<DeactivatePaymentReminderResponseClass> {
|
|
352
342
|
return localVarFp.deactivatePaymentReminder(code, deactivatePaymentReminderRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
353
343
|
},
|
|
354
344
|
/**
|
|
355
|
-
* Retrieves the details of the payment reminder that was previously created. Supply the unique payment reminder code
|
|
345
|
+
* 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.
|
|
356
346
|
* @summary Retrieve the payment reminder
|
|
357
|
-
* @param {string} code
|
|
347
|
+
* @param {string} code
|
|
358
348
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
359
349
|
* @param {*} [options] Override http request option.
|
|
360
350
|
* @throws {RequiredError}
|
|
361
351
|
*/
|
|
362
|
-
getPolicy(code: string, authorization?: string, options?: any): AxiosPromise<
|
|
352
|
+
getPolicy(code: string, authorization?: string, options?: any): AxiosPromise<GetPaymentReminderResponseClass> {
|
|
363
353
|
return localVarFp.getPolicy(code, authorization, options).then((request) => request(axios, basePath));
|
|
364
354
|
},
|
|
365
355
|
/**
|
|
366
|
-
* Returns a list of payment reminders you have previously created.
|
|
356
|
+
* 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.
|
|
367
357
|
* @summary List payment reminders
|
|
368
358
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
369
|
-
* @param {
|
|
370
|
-
* @param {
|
|
371
|
-
* @param {
|
|
372
|
-
* @param {
|
|
373
|
-
* @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.
|
|
374
|
-
* @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.
|
|
375
|
-
* @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.
|
|
359
|
+
* @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>
|
|
360
|
+
* @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>
|
|
361
|
+
* @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>
|
|
362
|
+
* @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>
|
|
376
363
|
* @param {*} [options] Override http request option.
|
|
377
364
|
* @throws {RequiredError}
|
|
378
365
|
*/
|
|
379
|
-
listPaymentReminders(authorization?: string,
|
|
380
|
-
return localVarFp.listPaymentReminders(authorization,
|
|
366
|
+
listPaymentReminders(authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListPaymentRemindersResponseClass> {
|
|
367
|
+
return localVarFp.listPaymentReminders(authorization, filter, filters, order, expand, options).then((request) => request(axios, basePath));
|
|
381
368
|
},
|
|
382
369
|
};
|
|
383
370
|
};
|
|
@@ -438,7 +425,7 @@ export interface PaymentRemindersApiDeactivatePaymentReminderRequest {
|
|
|
438
425
|
*/
|
|
439
426
|
export interface PaymentRemindersApiGetPolicyRequest {
|
|
440
427
|
/**
|
|
441
|
-
*
|
|
428
|
+
*
|
|
442
429
|
* @type {string}
|
|
443
430
|
* @memberof PaymentRemindersApiGetPolicy
|
|
444
431
|
*/
|
|
@@ -466,53 +453,32 @@ export interface PaymentRemindersApiListPaymentRemindersRequest {
|
|
|
466
453
|
readonly authorization?: string
|
|
467
454
|
|
|
468
455
|
/**
|
|
469
|
-
*
|
|
470
|
-
* @type {
|
|
471
|
-
* @memberof PaymentRemindersApiListPaymentReminders
|
|
472
|
-
*/
|
|
473
|
-
readonly pageSize?: any
|
|
474
|
-
|
|
475
|
-
/**
|
|
476
|
-
* 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.
|
|
477
|
-
* @type {any}
|
|
478
|
-
* @memberof PaymentRemindersApiListPaymentReminders
|
|
479
|
-
*/
|
|
480
|
-
readonly pageToken?: any
|
|
481
|
-
|
|
482
|
-
/**
|
|
483
|
-
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
484
|
-
* @type {any}
|
|
485
|
-
* @memberof PaymentRemindersApiListPaymentReminders
|
|
486
|
-
*/
|
|
487
|
-
readonly filter?: any
|
|
488
|
-
|
|
489
|
-
/**
|
|
490
|
-
* Search the list by any field. For instance, if you want to search by code add code=xxx in order to fetch the result.
|
|
491
|
-
* @type {any}
|
|
456
|
+
* 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>
|
|
457
|
+
* @type {string}
|
|
492
458
|
* @memberof PaymentRemindersApiListPaymentReminders
|
|
493
459
|
*/
|
|
494
|
-
readonly
|
|
460
|
+
readonly filter?: string
|
|
495
461
|
|
|
496
462
|
/**
|
|
497
|
-
*
|
|
498
|
-
* @type {
|
|
463
|
+
* 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>
|
|
464
|
+
* @type {string}
|
|
499
465
|
* @memberof PaymentRemindersApiListPaymentReminders
|
|
500
466
|
*/
|
|
501
|
-
readonly
|
|
467
|
+
readonly filters?: string
|
|
502
468
|
|
|
503
469
|
/**
|
|
504
|
-
*
|
|
505
|
-
* @type {
|
|
470
|
+
* 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>
|
|
471
|
+
* @type {string}
|
|
506
472
|
* @memberof PaymentRemindersApiListPaymentReminders
|
|
507
473
|
*/
|
|
508
|
-
readonly
|
|
474
|
+
readonly order?: string
|
|
509
475
|
|
|
510
476
|
/**
|
|
511
|
-
*
|
|
512
|
-
* @type {
|
|
477
|
+
* 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>
|
|
478
|
+
* @type {string}
|
|
513
479
|
* @memberof PaymentRemindersApiListPaymentReminders
|
|
514
480
|
*/
|
|
515
|
-
readonly
|
|
481
|
+
readonly expand?: string
|
|
516
482
|
}
|
|
517
483
|
|
|
518
484
|
/**
|
|
@@ -524,7 +490,7 @@ export interface PaymentRemindersApiListPaymentRemindersRequest {
|
|
|
524
490
|
export class PaymentRemindersApi extends BaseAPI {
|
|
525
491
|
/**
|
|
526
492
|
* This will create a payment reminder in the database.
|
|
527
|
-
* @summary Create the payment
|
|
493
|
+
* @summary Create the payment reminder
|
|
528
494
|
* @param {PaymentRemindersApiCreatePaymentReminderRequest} requestParameters Request parameters.
|
|
529
495
|
* @param {*} [options] Override http request option.
|
|
530
496
|
* @throws {RequiredError}
|
|
@@ -535,8 +501,8 @@ export class PaymentRemindersApi extends BaseAPI {
|
|
|
535
501
|
}
|
|
536
502
|
|
|
537
503
|
/**
|
|
538
|
-
*
|
|
539
|
-
* @summary
|
|
504
|
+
* This will deactivate the payment reminder
|
|
505
|
+
* @summary Deactivate payment reminder
|
|
540
506
|
* @param {PaymentRemindersApiDeactivatePaymentReminderRequest} requestParameters Request parameters.
|
|
541
507
|
* @param {*} [options] Override http request option.
|
|
542
508
|
* @throws {RequiredError}
|
|
@@ -547,7 +513,7 @@ export class PaymentRemindersApi extends BaseAPI {
|
|
|
547
513
|
}
|
|
548
514
|
|
|
549
515
|
/**
|
|
550
|
-
* Retrieves the details of the payment reminder that was previously created. Supply the unique payment reminder code
|
|
516
|
+
* 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.
|
|
551
517
|
* @summary Retrieve the payment reminder
|
|
552
518
|
* @param {PaymentRemindersApiGetPolicyRequest} requestParameters Request parameters.
|
|
553
519
|
* @param {*} [options] Override http request option.
|
|
@@ -559,7 +525,7 @@ export class PaymentRemindersApi extends BaseAPI {
|
|
|
559
525
|
}
|
|
560
526
|
|
|
561
527
|
/**
|
|
562
|
-
* Returns a list of payment reminders you have previously created.
|
|
528
|
+
* 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.
|
|
563
529
|
* @summary List payment reminders
|
|
564
530
|
* @param {PaymentRemindersApiListPaymentRemindersRequest} requestParameters Request parameters.
|
|
565
531
|
* @param {*} [options] Override http request option.
|
|
@@ -567,6 +533,6 @@ export class PaymentRemindersApi extends BaseAPI {
|
|
|
567
533
|
* @memberof PaymentRemindersApi
|
|
568
534
|
*/
|
|
569
535
|
public listPaymentReminders(requestParameters: PaymentRemindersApiListPaymentRemindersRequest = {}, options?: AxiosRequestConfig) {
|
|
570
|
-
return PaymentRemindersApiFp(this.configuration).listPaymentReminders(requestParameters.authorization, requestParameters.
|
|
536
|
+
return PaymentRemindersApiFp(this.configuration).listPaymentReminders(requestParameters.authorization, requestParameters.filter, requestParameters.filters, requestParameters.order, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
|
|
571
537
|
}
|
|
572
538
|
}
|
package/api/payment-setup-api.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* Emil Payment Service
|
|
5
|
-
* This service directly communicates with the various Payment Service Providers (PSPs)
|
|
5
|
+
* 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.
|
|
6
6
|
*
|
|
7
7
|
* The version of the OpenAPI document: 1.0
|
|
8
8
|
* Contact: kontakt@emil.de
|
|
@@ -20,6 +20,14 @@ import { Configuration } from '../configuration';
|
|
|
20
20
|
import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
|
|
21
21
|
// @ts-ignore
|
|
22
22
|
import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
|
|
23
|
+
// @ts-ignore
|
|
24
|
+
import { CompletePaymentSetupRequestDto } from '../models';
|
|
25
|
+
// @ts-ignore
|
|
26
|
+
import { CompletePaymentSetupResponseClass } from '../models';
|
|
27
|
+
// @ts-ignore
|
|
28
|
+
import { InitiatePaymentSetupRequestDto } from '../models';
|
|
29
|
+
// @ts-ignore
|
|
30
|
+
import { InitiatePaymentSetupResponseClass } from '../models';
|
|
23
31
|
// URLSearchParams not necessarily used
|
|
24
32
|
// @ts-ignore
|
|
25
33
|
import { URL, URLSearchParams } from 'url';
|
|
@@ -31,15 +39,16 @@ const FormData = require('form-data');
|
|
|
31
39
|
export const PaymentSetupApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
32
40
|
return {
|
|
33
41
|
/**
|
|
34
|
-
*
|
|
35
|
-
* @
|
|
42
|
+
* 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.
|
|
43
|
+
* @summary Complete a payment setup
|
|
44
|
+
* @param {CompletePaymentSetupRequestDto} completePaymentSetupRequestDto
|
|
36
45
|
* @param {string} [authorization] Bearer Token
|
|
37
46
|
* @param {*} [options] Override http request option.
|
|
38
47
|
* @throws {RequiredError}
|
|
39
48
|
*/
|
|
40
|
-
completePaymentSetup: async (
|
|
41
|
-
// verify required parameter '
|
|
42
|
-
assertParamExists('completePaymentSetup', '
|
|
49
|
+
completePaymentSetup: async (completePaymentSetupRequestDto: CompletePaymentSetupRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
50
|
+
// verify required parameter 'completePaymentSetupRequestDto' is not null or undefined
|
|
51
|
+
assertParamExists('completePaymentSetup', 'completePaymentSetupRequestDto', completePaymentSetupRequestDto)
|
|
43
52
|
const localVarPath = `/paymentservice/v1/payment-setup/complete`;
|
|
44
53
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
45
54
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -69,7 +78,7 @@ export const PaymentSetupApiAxiosParamCreator = function (configuration?: Config
|
|
|
69
78
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
70
79
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
71
80
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
72
|
-
localVarRequestOptions.data = serializeDataIfNeeded(
|
|
81
|
+
localVarRequestOptions.data = serializeDataIfNeeded(completePaymentSetupRequestDto, localVarRequestOptions, configuration)
|
|
73
82
|
|
|
74
83
|
return {
|
|
75
84
|
url: toPathString(localVarUrlObj),
|
|
@@ -77,15 +86,16 @@ export const PaymentSetupApiAxiosParamCreator = function (configuration?: Config
|
|
|
77
86
|
};
|
|
78
87
|
},
|
|
79
88
|
/**
|
|
80
|
-
*
|
|
81
|
-
* @
|
|
89
|
+
* This initiates an account within the configured payment service provider, whichgenerates a secret token, allowing the user to add their payment information.
|
|
90
|
+
* @summary Initiate a payment setup
|
|
91
|
+
* @param {InitiatePaymentSetupRequestDto} initiatePaymentSetupRequestDto
|
|
82
92
|
* @param {string} [authorization] Bearer Token
|
|
83
93
|
* @param {*} [options] Override http request option.
|
|
84
94
|
* @throws {RequiredError}
|
|
85
95
|
*/
|
|
86
|
-
initiatePaymentSetup: async (
|
|
87
|
-
// verify required parameter '
|
|
88
|
-
assertParamExists('initiatePaymentSetup', '
|
|
96
|
+
initiatePaymentSetup: async (initiatePaymentSetupRequestDto: InitiatePaymentSetupRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
97
|
+
// verify required parameter 'initiatePaymentSetupRequestDto' is not null or undefined
|
|
98
|
+
assertParamExists('initiatePaymentSetup', 'initiatePaymentSetupRequestDto', initiatePaymentSetupRequestDto)
|
|
89
99
|
const localVarPath = `/paymentservice/v1/payment-setup/initiate`;
|
|
90
100
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
91
101
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -115,7 +125,7 @@ export const PaymentSetupApiAxiosParamCreator = function (configuration?: Config
|
|
|
115
125
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
116
126
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
117
127
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
118
|
-
localVarRequestOptions.data = serializeDataIfNeeded(
|
|
128
|
+
localVarRequestOptions.data = serializeDataIfNeeded(initiatePaymentSetupRequestDto, localVarRequestOptions, configuration)
|
|
119
129
|
|
|
120
130
|
return {
|
|
121
131
|
url: toPathString(localVarUrlObj),
|
|
@@ -133,25 +143,27 @@ export const PaymentSetupApiFp = function(configuration?: Configuration) {
|
|
|
133
143
|
const localVarAxiosParamCreator = PaymentSetupApiAxiosParamCreator(configuration)
|
|
134
144
|
return {
|
|
135
145
|
/**
|
|
136
|
-
*
|
|
137
|
-
* @
|
|
146
|
+
* 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.
|
|
147
|
+
* @summary Complete a payment setup
|
|
148
|
+
* @param {CompletePaymentSetupRequestDto} completePaymentSetupRequestDto
|
|
138
149
|
* @param {string} [authorization] Bearer Token
|
|
139
150
|
* @param {*} [options] Override http request option.
|
|
140
151
|
* @throws {RequiredError}
|
|
141
152
|
*/
|
|
142
|
-
async completePaymentSetup(
|
|
143
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.completePaymentSetup(
|
|
153
|
+
async completePaymentSetup(completePaymentSetupRequestDto: CompletePaymentSetupRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CompletePaymentSetupResponseClass>> {
|
|
154
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.completePaymentSetup(completePaymentSetupRequestDto, authorization, options);
|
|
144
155
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
145
156
|
},
|
|
146
157
|
/**
|
|
147
|
-
*
|
|
148
|
-
* @
|
|
158
|
+
* This initiates an account within the configured payment service provider, whichgenerates a secret token, allowing the user to add their payment information.
|
|
159
|
+
* @summary Initiate a payment setup
|
|
160
|
+
* @param {InitiatePaymentSetupRequestDto} initiatePaymentSetupRequestDto
|
|
149
161
|
* @param {string} [authorization] Bearer Token
|
|
150
162
|
* @param {*} [options] Override http request option.
|
|
151
163
|
* @throws {RequiredError}
|
|
152
164
|
*/
|
|
153
|
-
async initiatePaymentSetup(
|
|
154
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.initiatePaymentSetup(
|
|
165
|
+
async initiatePaymentSetup(initiatePaymentSetupRequestDto: InitiatePaymentSetupRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InitiatePaymentSetupResponseClass>> {
|
|
166
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.initiatePaymentSetup(initiatePaymentSetupRequestDto, authorization, options);
|
|
155
167
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
156
168
|
},
|
|
157
169
|
}
|
|
@@ -165,24 +177,26 @@ export const PaymentSetupApiFactory = function (configuration?: Configuration, b
|
|
|
165
177
|
const localVarFp = PaymentSetupApiFp(configuration)
|
|
166
178
|
return {
|
|
167
179
|
/**
|
|
168
|
-
*
|
|
169
|
-
* @
|
|
180
|
+
* 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.
|
|
181
|
+
* @summary Complete a payment setup
|
|
182
|
+
* @param {CompletePaymentSetupRequestDto} completePaymentSetupRequestDto
|
|
170
183
|
* @param {string} [authorization] Bearer Token
|
|
171
184
|
* @param {*} [options] Override http request option.
|
|
172
185
|
* @throws {RequiredError}
|
|
173
186
|
*/
|
|
174
|
-
completePaymentSetup(
|
|
175
|
-
return localVarFp.completePaymentSetup(
|
|
187
|
+
completePaymentSetup(completePaymentSetupRequestDto: CompletePaymentSetupRequestDto, authorization?: string, options?: any): AxiosPromise<CompletePaymentSetupResponseClass> {
|
|
188
|
+
return localVarFp.completePaymentSetup(completePaymentSetupRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
176
189
|
},
|
|
177
190
|
/**
|
|
178
|
-
*
|
|
179
|
-
* @
|
|
191
|
+
* This initiates an account within the configured payment service provider, whichgenerates a secret token, allowing the user to add their payment information.
|
|
192
|
+
* @summary Initiate a payment setup
|
|
193
|
+
* @param {InitiatePaymentSetupRequestDto} initiatePaymentSetupRequestDto
|
|
180
194
|
* @param {string} [authorization] Bearer Token
|
|
181
195
|
* @param {*} [options] Override http request option.
|
|
182
196
|
* @throws {RequiredError}
|
|
183
197
|
*/
|
|
184
|
-
initiatePaymentSetup(
|
|
185
|
-
return localVarFp.initiatePaymentSetup(
|
|
198
|
+
initiatePaymentSetup(initiatePaymentSetupRequestDto: InitiatePaymentSetupRequestDto, authorization?: string, options?: any): AxiosPromise<InitiatePaymentSetupResponseClass> {
|
|
199
|
+
return localVarFp.initiatePaymentSetup(initiatePaymentSetupRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
186
200
|
},
|
|
187
201
|
};
|
|
188
202
|
};
|
|
@@ -195,10 +209,10 @@ export const PaymentSetupApiFactory = function (configuration?: Configuration, b
|
|
|
195
209
|
export interface PaymentSetupApiCompletePaymentSetupRequest {
|
|
196
210
|
/**
|
|
197
211
|
*
|
|
198
|
-
* @type {
|
|
212
|
+
* @type {CompletePaymentSetupRequestDto}
|
|
199
213
|
* @memberof PaymentSetupApiCompletePaymentSetup
|
|
200
214
|
*/
|
|
201
|
-
readonly
|
|
215
|
+
readonly completePaymentSetupRequestDto: CompletePaymentSetupRequestDto
|
|
202
216
|
|
|
203
217
|
/**
|
|
204
218
|
* Bearer Token
|
|
@@ -216,10 +230,10 @@ export interface PaymentSetupApiCompletePaymentSetupRequest {
|
|
|
216
230
|
export interface PaymentSetupApiInitiatePaymentSetupRequest {
|
|
217
231
|
/**
|
|
218
232
|
*
|
|
219
|
-
* @type {
|
|
233
|
+
* @type {InitiatePaymentSetupRequestDto}
|
|
220
234
|
* @memberof PaymentSetupApiInitiatePaymentSetup
|
|
221
235
|
*/
|
|
222
|
-
readonly
|
|
236
|
+
readonly initiatePaymentSetupRequestDto: InitiatePaymentSetupRequestDto
|
|
223
237
|
|
|
224
238
|
/**
|
|
225
239
|
* Bearer Token
|
|
@@ -237,24 +251,26 @@ export interface PaymentSetupApiInitiatePaymentSetupRequest {
|
|
|
237
251
|
*/
|
|
238
252
|
export class PaymentSetupApi extends BaseAPI {
|
|
239
253
|
/**
|
|
240
|
-
*
|
|
254
|
+
* 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.
|
|
255
|
+
* @summary Complete a payment setup
|
|
241
256
|
* @param {PaymentSetupApiCompletePaymentSetupRequest} requestParameters Request parameters.
|
|
242
257
|
* @param {*} [options] Override http request option.
|
|
243
258
|
* @throws {RequiredError}
|
|
244
259
|
* @memberof PaymentSetupApi
|
|
245
260
|
*/
|
|
246
261
|
public completePaymentSetup(requestParameters: PaymentSetupApiCompletePaymentSetupRequest, options?: AxiosRequestConfig) {
|
|
247
|
-
return PaymentSetupApiFp(this.configuration).completePaymentSetup(requestParameters.
|
|
262
|
+
return PaymentSetupApiFp(this.configuration).completePaymentSetup(requestParameters.completePaymentSetupRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
248
263
|
}
|
|
249
264
|
|
|
250
265
|
/**
|
|
251
|
-
*
|
|
266
|
+
* This initiates an account within the configured payment service provider, whichgenerates a secret token, allowing the user to add their payment information.
|
|
267
|
+
* @summary Initiate a payment setup
|
|
252
268
|
* @param {PaymentSetupApiInitiatePaymentSetupRequest} requestParameters Request parameters.
|
|
253
269
|
* @param {*} [options] Override http request option.
|
|
254
270
|
* @throws {RequiredError}
|
|
255
271
|
* @memberof PaymentSetupApi
|
|
256
272
|
*/
|
|
257
273
|
public initiatePaymentSetup(requestParameters: PaymentSetupApiInitiatePaymentSetupRequest, options?: AxiosRequestConfig) {
|
|
258
|
-
return PaymentSetupApiFp(this.configuration).initiatePaymentSetup(requestParameters.
|
|
274
|
+
return PaymentSetupApiFp(this.configuration).initiatePaymentSetup(requestParameters.initiatePaymentSetupRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
259
275
|
}
|
|
260
276
|
}
|