@emilgroup/payment-sdk 1.4.1-beta.8 → 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 +95 -115
- 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 +99 -101
- 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 +83 -98
- 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 +93 -88
- package/dist/api/tenant-bank-account-api.js +71 -63
- 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
|
|
@@ -93,21 +93,22 @@ var PaymentSetupApiAxiosParamCreator = function (configuration) {
|
|
|
93
93
|
var _this = this;
|
|
94
94
|
return {
|
|
95
95
|
/**
|
|
96
|
-
*
|
|
97
|
-
* @
|
|
96
|
+
* 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.
|
|
97
|
+
* @summary Complete a payment setup
|
|
98
|
+
* @param {CompletePaymentSetupRequestDto} completePaymentSetupRequestDto
|
|
98
99
|
* @param {string} [authorization] Bearer Token
|
|
99
100
|
* @param {*} [options] Override http request option.
|
|
100
101
|
* @throws {RequiredError}
|
|
101
102
|
*/
|
|
102
|
-
completePaymentSetup: function (
|
|
103
|
+
completePaymentSetup: function (completePaymentSetupRequestDto, authorization, options) {
|
|
103
104
|
if (options === void 0) { options = {}; }
|
|
104
105
|
return __awaiter(_this, void 0, void 0, function () {
|
|
105
106
|
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
106
107
|
return __generator(this, function (_a) {
|
|
107
108
|
switch (_a.label) {
|
|
108
109
|
case 0:
|
|
109
|
-
// verify required parameter '
|
|
110
|
-
(0, common_1.assertParamExists)('completePaymentSetup', '
|
|
110
|
+
// verify required parameter 'completePaymentSetupRequestDto' is not null or undefined
|
|
111
|
+
(0, common_1.assertParamExists)('completePaymentSetup', 'completePaymentSetupRequestDto', completePaymentSetupRequestDto);
|
|
111
112
|
localVarPath = "/paymentservice/v1/payment-setup/complete";
|
|
112
113
|
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
113
114
|
if (configuration) {
|
|
@@ -131,7 +132,7 @@ var PaymentSetupApiAxiosParamCreator = function (configuration) {
|
|
|
131
132
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
132
133
|
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
133
134
|
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
134
|
-
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(
|
|
135
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(completePaymentSetupRequestDto, localVarRequestOptions, configuration);
|
|
135
136
|
return [2 /*return*/, {
|
|
136
137
|
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
137
138
|
options: localVarRequestOptions,
|
|
@@ -141,21 +142,22 @@ var PaymentSetupApiAxiosParamCreator = function (configuration) {
|
|
|
141
142
|
});
|
|
142
143
|
},
|
|
143
144
|
/**
|
|
144
|
-
*
|
|
145
|
-
* @
|
|
145
|
+
* This initiates an account within the configured payment service provider, whichgenerates a secret token, allowing the user to add their payment information.
|
|
146
|
+
* @summary Initiate a payment setup
|
|
147
|
+
* @param {InitiatePaymentSetupRequestDto} initiatePaymentSetupRequestDto
|
|
146
148
|
* @param {string} [authorization] Bearer Token
|
|
147
149
|
* @param {*} [options] Override http request option.
|
|
148
150
|
* @throws {RequiredError}
|
|
149
151
|
*/
|
|
150
|
-
initiatePaymentSetup: function (
|
|
152
|
+
initiatePaymentSetup: function (initiatePaymentSetupRequestDto, authorization, options) {
|
|
151
153
|
if (options === void 0) { options = {}; }
|
|
152
154
|
return __awaiter(_this, void 0, void 0, function () {
|
|
153
155
|
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
154
156
|
return __generator(this, function (_a) {
|
|
155
157
|
switch (_a.label) {
|
|
156
158
|
case 0:
|
|
157
|
-
// verify required parameter '
|
|
158
|
-
(0, common_1.assertParamExists)('initiatePaymentSetup', '
|
|
159
|
+
// verify required parameter 'initiatePaymentSetupRequestDto' is not null or undefined
|
|
160
|
+
(0, common_1.assertParamExists)('initiatePaymentSetup', 'initiatePaymentSetupRequestDto', initiatePaymentSetupRequestDto);
|
|
159
161
|
localVarPath = "/paymentservice/v1/payment-setup/initiate";
|
|
160
162
|
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
161
163
|
if (configuration) {
|
|
@@ -179,7 +181,7 @@ var PaymentSetupApiAxiosParamCreator = function (configuration) {
|
|
|
179
181
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
180
182
|
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
181
183
|
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
182
|
-
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(
|
|
184
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(initiatePaymentSetupRequestDto, localVarRequestOptions, configuration);
|
|
183
185
|
return [2 /*return*/, {
|
|
184
186
|
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
185
187
|
options: localVarRequestOptions,
|
|
@@ -199,18 +201,19 @@ var PaymentSetupApiFp = function (configuration) {
|
|
|
199
201
|
var localVarAxiosParamCreator = (0, exports.PaymentSetupApiAxiosParamCreator)(configuration);
|
|
200
202
|
return {
|
|
201
203
|
/**
|
|
202
|
-
*
|
|
203
|
-
* @
|
|
204
|
+
* 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.
|
|
205
|
+
* @summary Complete a payment setup
|
|
206
|
+
* @param {CompletePaymentSetupRequestDto} completePaymentSetupRequestDto
|
|
204
207
|
* @param {string} [authorization] Bearer Token
|
|
205
208
|
* @param {*} [options] Override http request option.
|
|
206
209
|
* @throws {RequiredError}
|
|
207
210
|
*/
|
|
208
|
-
completePaymentSetup: function (
|
|
211
|
+
completePaymentSetup: function (completePaymentSetupRequestDto, authorization, options) {
|
|
209
212
|
return __awaiter(this, void 0, void 0, function () {
|
|
210
213
|
var localVarAxiosArgs;
|
|
211
214
|
return __generator(this, function (_a) {
|
|
212
215
|
switch (_a.label) {
|
|
213
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.completePaymentSetup(
|
|
216
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.completePaymentSetup(completePaymentSetupRequestDto, authorization, options)];
|
|
214
217
|
case 1:
|
|
215
218
|
localVarAxiosArgs = _a.sent();
|
|
216
219
|
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
@@ -219,18 +222,19 @@ var PaymentSetupApiFp = function (configuration) {
|
|
|
219
222
|
});
|
|
220
223
|
},
|
|
221
224
|
/**
|
|
222
|
-
*
|
|
223
|
-
* @
|
|
225
|
+
* This initiates an account within the configured payment service provider, whichgenerates a secret token, allowing the user to add their payment information.
|
|
226
|
+
* @summary Initiate a payment setup
|
|
227
|
+
* @param {InitiatePaymentSetupRequestDto} initiatePaymentSetupRequestDto
|
|
224
228
|
* @param {string} [authorization] Bearer Token
|
|
225
229
|
* @param {*} [options] Override http request option.
|
|
226
230
|
* @throws {RequiredError}
|
|
227
231
|
*/
|
|
228
|
-
initiatePaymentSetup: function (
|
|
232
|
+
initiatePaymentSetup: function (initiatePaymentSetupRequestDto, authorization, options) {
|
|
229
233
|
return __awaiter(this, void 0, void 0, function () {
|
|
230
234
|
var localVarAxiosArgs;
|
|
231
235
|
return __generator(this, function (_a) {
|
|
232
236
|
switch (_a.label) {
|
|
233
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.initiatePaymentSetup(
|
|
237
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.initiatePaymentSetup(initiatePaymentSetupRequestDto, authorization, options)];
|
|
234
238
|
case 1:
|
|
235
239
|
localVarAxiosArgs = _a.sent();
|
|
236
240
|
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
@@ -249,24 +253,26 @@ var PaymentSetupApiFactory = function (configuration, basePath, axios) {
|
|
|
249
253
|
var localVarFp = (0, exports.PaymentSetupApiFp)(configuration);
|
|
250
254
|
return {
|
|
251
255
|
/**
|
|
252
|
-
*
|
|
253
|
-
* @
|
|
256
|
+
* 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.
|
|
257
|
+
* @summary Complete a payment setup
|
|
258
|
+
* @param {CompletePaymentSetupRequestDto} completePaymentSetupRequestDto
|
|
254
259
|
* @param {string} [authorization] Bearer Token
|
|
255
260
|
* @param {*} [options] Override http request option.
|
|
256
261
|
* @throws {RequiredError}
|
|
257
262
|
*/
|
|
258
|
-
completePaymentSetup: function (
|
|
259
|
-
return localVarFp.completePaymentSetup(
|
|
263
|
+
completePaymentSetup: function (completePaymentSetupRequestDto, authorization, options) {
|
|
264
|
+
return localVarFp.completePaymentSetup(completePaymentSetupRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
260
265
|
},
|
|
261
266
|
/**
|
|
262
|
-
*
|
|
263
|
-
* @
|
|
267
|
+
* This initiates an account within the configured payment service provider, whichgenerates a secret token, allowing the user to add their payment information.
|
|
268
|
+
* @summary Initiate a payment setup
|
|
269
|
+
* @param {InitiatePaymentSetupRequestDto} initiatePaymentSetupRequestDto
|
|
264
270
|
* @param {string} [authorization] Bearer Token
|
|
265
271
|
* @param {*} [options] Override http request option.
|
|
266
272
|
* @throws {RequiredError}
|
|
267
273
|
*/
|
|
268
|
-
initiatePaymentSetup: function (
|
|
269
|
-
return localVarFp.initiatePaymentSetup(
|
|
274
|
+
initiatePaymentSetup: function (initiatePaymentSetupRequestDto, authorization, options) {
|
|
275
|
+
return localVarFp.initiatePaymentSetup(initiatePaymentSetupRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
270
276
|
},
|
|
271
277
|
};
|
|
272
278
|
};
|
|
@@ -283,7 +289,8 @@ var PaymentSetupApi = /** @class */ (function (_super) {
|
|
|
283
289
|
return _super !== null && _super.apply(this, arguments) || this;
|
|
284
290
|
}
|
|
285
291
|
/**
|
|
286
|
-
*
|
|
292
|
+
* 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.
|
|
293
|
+
* @summary Complete a payment setup
|
|
287
294
|
* @param {PaymentSetupApiCompletePaymentSetupRequest} requestParameters Request parameters.
|
|
288
295
|
* @param {*} [options] Override http request option.
|
|
289
296
|
* @throws {RequiredError}
|
|
@@ -291,10 +298,11 @@ var PaymentSetupApi = /** @class */ (function (_super) {
|
|
|
291
298
|
*/
|
|
292
299
|
PaymentSetupApi.prototype.completePaymentSetup = function (requestParameters, options) {
|
|
293
300
|
var _this = this;
|
|
294
|
-
return (0, exports.PaymentSetupApiFp)(this.configuration).completePaymentSetup(requestParameters.
|
|
301
|
+
return (0, exports.PaymentSetupApiFp)(this.configuration).completePaymentSetup(requestParameters.completePaymentSetupRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
295
302
|
};
|
|
296
303
|
/**
|
|
297
|
-
*
|
|
304
|
+
* This initiates an account within the configured payment service provider, whichgenerates a secret token, allowing the user to add their payment information.
|
|
305
|
+
* @summary Initiate a payment setup
|
|
298
306
|
* @param {PaymentSetupApiInitiatePaymentSetupRequest} requestParameters Request parameters.
|
|
299
307
|
* @param {*} [options] Override http request option.
|
|
300
308
|
* @throws {RequiredError}
|
|
@@ -302,7 +310,7 @@ var PaymentSetupApi = /** @class */ (function (_super) {
|
|
|
302
310
|
*/
|
|
303
311
|
PaymentSetupApi.prototype.initiatePaymentSetup = function (requestParameters, options) {
|
|
304
312
|
var _this = this;
|
|
305
|
-
return (0, exports.PaymentSetupApiFp)(this.configuration).initiatePaymentSetup(requestParameters.
|
|
313
|
+
return (0, exports.PaymentSetupApiFp)(this.configuration).initiatePaymentSetup(requestParameters.initiatePaymentSetupRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
306
314
|
};
|
|
307
315
|
return PaymentSetupApi;
|
|
308
316
|
}(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
|
|
@@ -13,14 +13,17 @@ import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
|
13
13
|
import { Configuration } from '../configuration';
|
|
14
14
|
import { RequestArgs, BaseAPI } from '../base';
|
|
15
15
|
import { CreatePaymentRequestDto } from '../models';
|
|
16
|
+
import { CreatePaymentResponseClass } from '../models';
|
|
17
|
+
import { GetPaymentResponseClass } from '../models';
|
|
18
|
+
import { ListPaymentsResponseClass } from '../models';
|
|
16
19
|
/**
|
|
17
20
|
* PaymentsApi - axios parameter creator
|
|
18
21
|
* @export
|
|
19
22
|
*/
|
|
20
23
|
export declare const PaymentsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
21
24
|
/**
|
|
22
|
-
*
|
|
23
|
-
* @summary Create
|
|
25
|
+
* This will create a payment for a specified account. This function is idempotent.
|
|
26
|
+
* @summary Create the payment
|
|
24
27
|
* @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
|
|
25
28
|
* @param {CreatePaymentRequestDto} createPaymentRequestDto
|
|
26
29
|
* @param {string} [authorization] Bearer Token
|
|
@@ -29,31 +32,27 @@ export declare const PaymentsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
29
32
|
*/
|
|
30
33
|
createPayment: (idempotencyKey: string, createPaymentRequestDto: CreatePaymentRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
31
34
|
/**
|
|
32
|
-
* Retrieves the details of
|
|
33
|
-
* @summary Retrieve
|
|
34
|
-
* @param {string} code
|
|
35
|
-
* @param {string} expand Fields to expand response by
|
|
36
|
-
* @param {string} expand2 Fields to expand response by
|
|
35
|
+
* Retrieves the details of the payment that was previously created. Supply the unique payment code that was returned when you created it and Emil Api will return the corresponding payment information.
|
|
36
|
+
* @summary Retrieve the payment
|
|
37
|
+
* @param {string} code
|
|
37
38
|
* @param {string} [authorization] Bearer Token
|
|
39
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: transactions<i>
|
|
38
40
|
* @param {*} [options] Override http request option.
|
|
39
41
|
* @throws {RequiredError}
|
|
40
42
|
*/
|
|
41
|
-
getPayment: (code: string,
|
|
43
|
+
getPayment: (code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
42
44
|
/**
|
|
43
|
-
* Returns a list of payments you
|
|
45
|
+
* Returns a list of payments you have previously created. The payments are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
44
46
|
* @summary List payments
|
|
45
47
|
* @param {string} [authorization] Bearer Token
|
|
46
|
-
* @param {
|
|
47
|
-
* @param {
|
|
48
|
-
* @param {
|
|
49
|
-
* @param {
|
|
50
|
-
* @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.
|
|
51
|
-
* @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.
|
|
52
|
-
* @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.
|
|
48
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, id, pspCustomerId, psp, type, amount, receivedDate, referenceNumber</i>
|
|
49
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, id, pspCustomerId, psp, type, amount, receivedDate, referenceNumber</i>
|
|
50
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, code, amount</i>
|
|
51
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: transactions<i>
|
|
53
52
|
* @param {*} [options] Override http request option.
|
|
54
53
|
* @throws {RequiredError}
|
|
55
54
|
*/
|
|
56
|
-
listPayments: (authorization?: string,
|
|
55
|
+
listPayments: (authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
57
56
|
};
|
|
58
57
|
/**
|
|
59
58
|
* PaymentsApi - functional programming interface
|
|
@@ -61,41 +60,37 @@ export declare const PaymentsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
61
60
|
*/
|
|
62
61
|
export declare const PaymentsApiFp: (configuration?: Configuration) => {
|
|
63
62
|
/**
|
|
64
|
-
*
|
|
65
|
-
* @summary Create
|
|
63
|
+
* This will create a payment for a specified account. This function is idempotent.
|
|
64
|
+
* @summary Create the payment
|
|
66
65
|
* @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
|
|
67
66
|
* @param {CreatePaymentRequestDto} createPaymentRequestDto
|
|
68
67
|
* @param {string} [authorization] Bearer Token
|
|
69
68
|
* @param {*} [options] Override http request option.
|
|
70
69
|
* @throws {RequiredError}
|
|
71
70
|
*/
|
|
72
|
-
createPayment(idempotencyKey: string, createPaymentRequestDto: CreatePaymentRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
71
|
+
createPayment(idempotencyKey: string, createPaymentRequestDto: CreatePaymentRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePaymentResponseClass>>;
|
|
73
72
|
/**
|
|
74
|
-
* Retrieves the details of
|
|
75
|
-
* @summary Retrieve
|
|
76
|
-
* @param {string} code
|
|
77
|
-
* @param {string} expand Fields to expand response by
|
|
78
|
-
* @param {string} expand2 Fields to expand response by
|
|
73
|
+
* Retrieves the details of the payment that was previously created. Supply the unique payment code that was returned when you created it and Emil Api will return the corresponding payment information.
|
|
74
|
+
* @summary Retrieve the payment
|
|
75
|
+
* @param {string} code
|
|
79
76
|
* @param {string} [authorization] Bearer Token
|
|
77
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: transactions<i>
|
|
80
78
|
* @param {*} [options] Override http request option.
|
|
81
79
|
* @throws {RequiredError}
|
|
82
80
|
*/
|
|
83
|
-
getPayment(code: string,
|
|
81
|
+
getPayment(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPaymentResponseClass>>;
|
|
84
82
|
/**
|
|
85
|
-
* Returns a list of payments you
|
|
83
|
+
* Returns a list of payments you have previously created. The payments are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
86
84
|
* @summary List payments
|
|
87
85
|
* @param {string} [authorization] Bearer Token
|
|
88
|
-
* @param {
|
|
89
|
-
* @param {
|
|
90
|
-
* @param {
|
|
91
|
-
* @param {
|
|
92
|
-
* @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.
|
|
93
|
-
* @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.
|
|
94
|
-
* @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.
|
|
86
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, id, pspCustomerId, psp, type, amount, receivedDate, referenceNumber</i>
|
|
87
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, id, pspCustomerId, psp, type, amount, receivedDate, referenceNumber</i>
|
|
88
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, code, amount</i>
|
|
89
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: transactions<i>
|
|
95
90
|
* @param {*} [options] Override http request option.
|
|
96
91
|
* @throws {RequiredError}
|
|
97
92
|
*/
|
|
98
|
-
listPayments(authorization?: string,
|
|
93
|
+
listPayments(authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPaymentsResponseClass>>;
|
|
99
94
|
};
|
|
100
95
|
/**
|
|
101
96
|
* PaymentsApi - factory interface
|
|
@@ -103,41 +98,37 @@ export declare const PaymentsApiFp: (configuration?: Configuration) => {
|
|
|
103
98
|
*/
|
|
104
99
|
export declare const PaymentsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
105
100
|
/**
|
|
106
|
-
*
|
|
107
|
-
* @summary Create
|
|
101
|
+
* This will create a payment for a specified account. This function is idempotent.
|
|
102
|
+
* @summary Create the payment
|
|
108
103
|
* @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
|
|
109
104
|
* @param {CreatePaymentRequestDto} createPaymentRequestDto
|
|
110
105
|
* @param {string} [authorization] Bearer Token
|
|
111
106
|
* @param {*} [options] Override http request option.
|
|
112
107
|
* @throws {RequiredError}
|
|
113
108
|
*/
|
|
114
|
-
createPayment(idempotencyKey: string, createPaymentRequestDto: CreatePaymentRequestDto, authorization?: string, options?: any): AxiosPromise<
|
|
109
|
+
createPayment(idempotencyKey: string, createPaymentRequestDto: CreatePaymentRequestDto, authorization?: string, options?: any): AxiosPromise<CreatePaymentResponseClass>;
|
|
115
110
|
/**
|
|
116
|
-
* Retrieves the details of
|
|
117
|
-
* @summary Retrieve
|
|
118
|
-
* @param {string} code
|
|
119
|
-
* @param {string} expand Fields to expand response by
|
|
120
|
-
* @param {string} expand2 Fields to expand response by
|
|
111
|
+
* Retrieves the details of the payment that was previously created. Supply the unique payment code that was returned when you created it and Emil Api will return the corresponding payment information.
|
|
112
|
+
* @summary Retrieve the payment
|
|
113
|
+
* @param {string} code
|
|
121
114
|
* @param {string} [authorization] Bearer Token
|
|
115
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: transactions<i>
|
|
122
116
|
* @param {*} [options] Override http request option.
|
|
123
117
|
* @throws {RequiredError}
|
|
124
118
|
*/
|
|
125
|
-
getPayment(code: string,
|
|
119
|
+
getPayment(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetPaymentResponseClass>;
|
|
126
120
|
/**
|
|
127
|
-
* Returns a list of payments you
|
|
121
|
+
* Returns a list of payments you have previously created. The payments are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
128
122
|
* @summary List payments
|
|
129
123
|
* @param {string} [authorization] Bearer Token
|
|
130
|
-
* @param {
|
|
131
|
-
* @param {
|
|
132
|
-
* @param {
|
|
133
|
-
* @param {
|
|
134
|
-
* @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.
|
|
135
|
-
* @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.
|
|
136
|
-
* @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.
|
|
124
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, id, pspCustomerId, psp, type, amount, receivedDate, referenceNumber</i>
|
|
125
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, id, pspCustomerId, psp, type, amount, receivedDate, referenceNumber</i>
|
|
126
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, code, amount</i>
|
|
127
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: transactions<i>
|
|
137
128
|
* @param {*} [options] Override http request option.
|
|
138
129
|
* @throws {RequiredError}
|
|
139
130
|
*/
|
|
140
|
-
listPayments(authorization?: string,
|
|
131
|
+
listPayments(authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListPaymentsResponseClass>;
|
|
141
132
|
};
|
|
142
133
|
/**
|
|
143
134
|
* Request parameters for createPayment operation in PaymentsApi.
|
|
@@ -171,29 +162,23 @@ export interface PaymentsApiCreatePaymentRequest {
|
|
|
171
162
|
*/
|
|
172
163
|
export interface PaymentsApiGetPaymentRequest {
|
|
173
164
|
/**
|
|
174
|
-
*
|
|
165
|
+
*
|
|
175
166
|
* @type {string}
|
|
176
167
|
* @memberof PaymentsApiGetPayment
|
|
177
168
|
*/
|
|
178
169
|
readonly code: string;
|
|
179
170
|
/**
|
|
180
|
-
*
|
|
181
|
-
* @type {string}
|
|
182
|
-
* @memberof PaymentsApiGetPayment
|
|
183
|
-
*/
|
|
184
|
-
readonly expand: string;
|
|
185
|
-
/**
|
|
186
|
-
* Fields to expand response by
|
|
171
|
+
* Bearer Token
|
|
187
172
|
* @type {string}
|
|
188
173
|
* @memberof PaymentsApiGetPayment
|
|
189
174
|
*/
|
|
190
|
-
readonly
|
|
175
|
+
readonly authorization?: string;
|
|
191
176
|
/**
|
|
192
|
-
*
|
|
177
|
+
* Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: transactions<i>
|
|
193
178
|
* @type {string}
|
|
194
179
|
* @memberof PaymentsApiGetPayment
|
|
195
180
|
*/
|
|
196
|
-
readonly
|
|
181
|
+
readonly expand?: string;
|
|
197
182
|
}
|
|
198
183
|
/**
|
|
199
184
|
* Request parameters for listPayments operation in PaymentsApi.
|
|
@@ -208,47 +193,29 @@ export interface PaymentsApiListPaymentsRequest {
|
|
|
208
193
|
*/
|
|
209
194
|
readonly authorization?: string;
|
|
210
195
|
/**
|
|
211
|
-
*
|
|
212
|
-
* @type {
|
|
213
|
-
* @memberof PaymentsApiListPayments
|
|
214
|
-
*/
|
|
215
|
-
readonly pageSize?: any;
|
|
216
|
-
/**
|
|
217
|
-
* 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.
|
|
218
|
-
* @type {any}
|
|
219
|
-
* @memberof PaymentsApiListPayments
|
|
220
|
-
*/
|
|
221
|
-
readonly pageToken?: any;
|
|
222
|
-
/**
|
|
223
|
-
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
224
|
-
* @type {any}
|
|
225
|
-
* @memberof PaymentsApiListPayments
|
|
226
|
-
*/
|
|
227
|
-
readonly filter?: any;
|
|
228
|
-
/**
|
|
229
|
-
* Search the list by any field. For instance, if you want to search by code add code=xxx in order to fetch the result.
|
|
230
|
-
* @type {any}
|
|
196
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, id, pspCustomerId, psp, type, amount, receivedDate, referenceNumber</i>
|
|
197
|
+
* @type {string}
|
|
231
198
|
* @memberof PaymentsApiListPayments
|
|
232
199
|
*/
|
|
233
|
-
readonly
|
|
200
|
+
readonly filter?: string;
|
|
234
201
|
/**
|
|
235
|
-
*
|
|
236
|
-
* @type {
|
|
202
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, id, pspCustomerId, psp, type, amount, receivedDate, referenceNumber</i>
|
|
203
|
+
* @type {string}
|
|
237
204
|
* @memberof PaymentsApiListPayments
|
|
238
205
|
*/
|
|
239
|
-
readonly
|
|
206
|
+
readonly filters?: string;
|
|
240
207
|
/**
|
|
241
|
-
*
|
|
242
|
-
* @type {
|
|
208
|
+
* Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, code, amount</i>
|
|
209
|
+
* @type {string}
|
|
243
210
|
* @memberof PaymentsApiListPayments
|
|
244
211
|
*/
|
|
245
|
-
readonly
|
|
212
|
+
readonly order?: string;
|
|
246
213
|
/**
|
|
247
|
-
*
|
|
248
|
-
* @type {
|
|
214
|
+
* Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: transactions<i>
|
|
215
|
+
* @type {string}
|
|
249
216
|
* @memberof PaymentsApiListPayments
|
|
250
217
|
*/
|
|
251
|
-
readonly
|
|
218
|
+
readonly expand?: string;
|
|
252
219
|
}
|
|
253
220
|
/**
|
|
254
221
|
* PaymentsApi - object-oriented interface
|
|
@@ -258,30 +225,30 @@ export interface PaymentsApiListPaymentsRequest {
|
|
|
258
225
|
*/
|
|
259
226
|
export declare class PaymentsApi extends BaseAPI {
|
|
260
227
|
/**
|
|
261
|
-
*
|
|
262
|
-
* @summary Create
|
|
228
|
+
* This will create a payment for a specified account. This function is idempotent.
|
|
229
|
+
* @summary Create the payment
|
|
263
230
|
* @param {PaymentsApiCreatePaymentRequest} requestParameters Request parameters.
|
|
264
231
|
* @param {*} [options] Override http request option.
|
|
265
232
|
* @throws {RequiredError}
|
|
266
233
|
* @memberof PaymentsApi
|
|
267
234
|
*/
|
|
268
|
-
createPayment(requestParameters: PaymentsApiCreatePaymentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
235
|
+
createPayment(requestParameters: PaymentsApiCreatePaymentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePaymentResponseClass, any>>;
|
|
269
236
|
/**
|
|
270
|
-
* Retrieves the details of
|
|
271
|
-
* @summary Retrieve
|
|
237
|
+
* Retrieves the details of the payment that was previously created. Supply the unique payment code that was returned when you created it and Emil Api will return the corresponding payment information.
|
|
238
|
+
* @summary Retrieve the payment
|
|
272
239
|
* @param {PaymentsApiGetPaymentRequest} requestParameters Request parameters.
|
|
273
240
|
* @param {*} [options] Override http request option.
|
|
274
241
|
* @throws {RequiredError}
|
|
275
242
|
* @memberof PaymentsApi
|
|
276
243
|
*/
|
|
277
|
-
getPayment(requestParameters: PaymentsApiGetPaymentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
244
|
+
getPayment(requestParameters: PaymentsApiGetPaymentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPaymentResponseClass, any>>;
|
|
278
245
|
/**
|
|
279
|
-
* Returns a list of payments you
|
|
246
|
+
* Returns a list of payments you have previously created. The payments are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
280
247
|
* @summary List payments
|
|
281
248
|
* @param {PaymentsApiListPaymentsRequest} requestParameters Request parameters.
|
|
282
249
|
* @param {*} [options] Override http request option.
|
|
283
250
|
* @throws {RequiredError}
|
|
284
251
|
* @memberof PaymentsApi
|
|
285
252
|
*/
|
|
286
|
-
listPayments(requestParameters?: PaymentsApiListPaymentsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
253
|
+
listPayments(requestParameters?: PaymentsApiListPaymentsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListPaymentsResponseClass, any>>;
|
|
287
254
|
}
|