@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
package/api/refunds-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
|
|
@@ -35,7 +35,8 @@ import { ListRefundsResponseClass } from '../models';
|
|
|
35
35
|
export const RefundsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
36
36
|
return {
|
|
37
37
|
/**
|
|
38
|
-
*
|
|
38
|
+
* This will create a refund in the database.
|
|
39
|
+
* @summary Create the refund
|
|
39
40
|
* @param {CreateRefundRequestDto} createRefundRequestDto
|
|
40
41
|
* @param {string} [authorization] Bearer Token
|
|
41
42
|
* @param {*} [options] Override http request option.
|
|
@@ -81,21 +82,17 @@ export const RefundsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
81
82
|
};
|
|
82
83
|
},
|
|
83
84
|
/**
|
|
84
|
-
*
|
|
85
|
+
* Retrieves the details of the refund that was previously created. Supply the unique refund code that was returned when you created it and Emil Api will return the corresponding refund information.
|
|
86
|
+
* @summary Retrieve the refund
|
|
85
87
|
* @param {string} code
|
|
86
|
-
* @param {string} code2 Unique identifier for the object.
|
|
87
|
-
* @param {string} expand Fields to expand response by
|
|
88
88
|
* @param {string} [authorization] Bearer Token
|
|
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: refundItems<i>
|
|
89
90
|
* @param {*} [options] Override http request option.
|
|
90
91
|
* @throws {RequiredError}
|
|
91
92
|
*/
|
|
92
|
-
getRefund: async (code: string,
|
|
93
|
+
getRefund: async (code: string, authorization?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
93
94
|
// verify required parameter 'code' is not null or undefined
|
|
94
95
|
assertParamExists('getRefund', 'code', code)
|
|
95
|
-
// verify required parameter 'code2' is not null or undefined
|
|
96
|
-
assertParamExists('getRefund', 'code2', code2)
|
|
97
|
-
// verify required parameter 'expand' is not null or undefined
|
|
98
|
-
assertParamExists('getRefund', 'expand', expand)
|
|
99
96
|
const localVarPath = `/paymentservice/v1/refunds/{code}`
|
|
100
97
|
.replace(`{${"code"}}`, encodeURIComponent(String(code)));
|
|
101
98
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -115,10 +112,6 @@ export const RefundsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
115
112
|
// http bearer authentication required
|
|
116
113
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
117
114
|
|
|
118
|
-
if (code2 !== undefined) {
|
|
119
|
-
localVarQueryParameter['code'] = code2;
|
|
120
|
-
}
|
|
121
|
-
|
|
122
115
|
if (expand !== undefined) {
|
|
123
116
|
localVarQueryParameter['expand'] = expand;
|
|
124
117
|
}
|
|
@@ -139,19 +132,18 @@ export const RefundsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
139
132
|
};
|
|
140
133
|
},
|
|
141
134
|
/**
|
|
142
|
-
*
|
|
135
|
+
* Returns a list of refunds you have previously created. The refunds are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
136
|
+
* @summary List refunds
|
|
143
137
|
* @param {string} [authorization] Bearer Token
|
|
144
|
-
* @param {
|
|
145
|
-
* @param {
|
|
146
|
-
* @param {
|
|
147
|
-
* @param {
|
|
148
|
-
* @param {
|
|
149
|
-
* @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.
|
|
150
|
-
* @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.
|
|
138
|
+
* @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, status, reason, psp, accountCode, invoiceCode</i>
|
|
139
|
+
* @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, status, reason, psp, accountCode, invoiceCode</i>
|
|
140
|
+
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: id, createdAt, updatedAt, amount, psp, accountCode, invoiceCode, reason, status</i>
|
|
141
|
+
* @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, amount</i>
|
|
142
|
+
* @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: refundItems<i>
|
|
151
143
|
* @param {*} [options] Override http request option.
|
|
152
144
|
* @throws {RequiredError}
|
|
153
145
|
*/
|
|
154
|
-
listRefunds: async (authorization?: string,
|
|
146
|
+
listRefunds: async (authorization?: string, filter?: string, filters?: string, search?: string, order?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
155
147
|
const localVarPath = `/paymentservice/v1/refunds`;
|
|
156
148
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
157
149
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -170,18 +162,14 @@ export const RefundsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
170
162
|
// http bearer authentication required
|
|
171
163
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
172
164
|
|
|
173
|
-
if (pageSize !== undefined) {
|
|
174
|
-
localVarQueryParameter['pageSize'] = pageSize;
|
|
175
|
-
}
|
|
176
|
-
|
|
177
|
-
if (pageToken !== undefined) {
|
|
178
|
-
localVarQueryParameter['pageToken'] = pageToken;
|
|
179
|
-
}
|
|
180
|
-
|
|
181
165
|
if (filter !== undefined) {
|
|
182
166
|
localVarQueryParameter['filter'] = filter;
|
|
183
167
|
}
|
|
184
168
|
|
|
169
|
+
if (filters !== undefined) {
|
|
170
|
+
localVarQueryParameter['filters'] = filters;
|
|
171
|
+
}
|
|
172
|
+
|
|
185
173
|
if (search !== undefined) {
|
|
186
174
|
localVarQueryParameter['search'] = search;
|
|
187
175
|
}
|
|
@@ -194,10 +182,6 @@ export const RefundsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
194
182
|
localVarQueryParameter['expand'] = expand;
|
|
195
183
|
}
|
|
196
184
|
|
|
197
|
-
if (filters !== undefined) {
|
|
198
|
-
localVarQueryParameter['filters'] = filters;
|
|
199
|
-
}
|
|
200
|
-
|
|
201
185
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
202
186
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
203
187
|
}
|
|
@@ -224,7 +208,8 @@ export const RefundsApiFp = function(configuration?: Configuration) {
|
|
|
224
208
|
const localVarAxiosParamCreator = RefundsApiAxiosParamCreator(configuration)
|
|
225
209
|
return {
|
|
226
210
|
/**
|
|
227
|
-
*
|
|
211
|
+
* This will create a refund in the database.
|
|
212
|
+
* @summary Create the refund
|
|
228
213
|
* @param {CreateRefundRequestDto} createRefundRequestDto
|
|
229
214
|
* @param {string} [authorization] Bearer Token
|
|
230
215
|
* @param {*} [options] Override http request option.
|
|
@@ -235,33 +220,32 @@ export const RefundsApiFp = function(configuration?: Configuration) {
|
|
|
235
220
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
236
221
|
},
|
|
237
222
|
/**
|
|
238
|
-
*
|
|
223
|
+
* Retrieves the details of the refund that was previously created. Supply the unique refund code that was returned when you created it and Emil Api will return the corresponding refund information.
|
|
224
|
+
* @summary Retrieve the refund
|
|
239
225
|
* @param {string} code
|
|
240
|
-
* @param {string} code2 Unique identifier for the object.
|
|
241
|
-
* @param {string} expand Fields to expand response by
|
|
242
226
|
* @param {string} [authorization] Bearer Token
|
|
227
|
+
* @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: refundItems<i>
|
|
243
228
|
* @param {*} [options] Override http request option.
|
|
244
229
|
* @throws {RequiredError}
|
|
245
230
|
*/
|
|
246
|
-
async getRefund(code: string,
|
|
247
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getRefund(code,
|
|
231
|
+
async getRefund(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetRefundResponseClass>> {
|
|
232
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getRefund(code, authorization, expand, options);
|
|
248
233
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
249
234
|
},
|
|
250
235
|
/**
|
|
251
|
-
*
|
|
236
|
+
* Returns a list of refunds you have previously created. The refunds are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
237
|
+
* @summary List refunds
|
|
252
238
|
* @param {string} [authorization] Bearer Token
|
|
253
|
-
* @param {
|
|
254
|
-
* @param {
|
|
255
|
-
* @param {
|
|
256
|
-
* @param {
|
|
257
|
-
* @param {
|
|
258
|
-
* @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.
|
|
259
|
-
* @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.
|
|
239
|
+
* @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, status, reason, psp, accountCode, invoiceCode</i>
|
|
240
|
+
* @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, status, reason, psp, accountCode, invoiceCode</i>
|
|
241
|
+
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: id, createdAt, updatedAt, amount, psp, accountCode, invoiceCode, reason, status</i>
|
|
242
|
+
* @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, amount</i>
|
|
243
|
+
* @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: refundItems<i>
|
|
260
244
|
* @param {*} [options] Override http request option.
|
|
261
245
|
* @throws {RequiredError}
|
|
262
246
|
*/
|
|
263
|
-
async listRefunds(authorization?: string,
|
|
264
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listRefunds(authorization,
|
|
247
|
+
async listRefunds(authorization?: string, filter?: string, filters?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListRefundsResponseClass>> {
|
|
248
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listRefunds(authorization, filter, filters, search, order, expand, options);
|
|
265
249
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
266
250
|
},
|
|
267
251
|
}
|
|
@@ -275,7 +259,8 @@ export const RefundsApiFactory = function (configuration?: Configuration, basePa
|
|
|
275
259
|
const localVarFp = RefundsApiFp(configuration)
|
|
276
260
|
return {
|
|
277
261
|
/**
|
|
278
|
-
*
|
|
262
|
+
* This will create a refund in the database.
|
|
263
|
+
* @summary Create the refund
|
|
279
264
|
* @param {CreateRefundRequestDto} createRefundRequestDto
|
|
280
265
|
* @param {string} [authorization] Bearer Token
|
|
281
266
|
* @param {*} [options] Override http request option.
|
|
@@ -285,32 +270,31 @@ export const RefundsApiFactory = function (configuration?: Configuration, basePa
|
|
|
285
270
|
return localVarFp.createRefund(createRefundRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
286
271
|
},
|
|
287
272
|
/**
|
|
288
|
-
*
|
|
273
|
+
* Retrieves the details of the refund that was previously created. Supply the unique refund code that was returned when you created it and Emil Api will return the corresponding refund information.
|
|
274
|
+
* @summary Retrieve the refund
|
|
289
275
|
* @param {string} code
|
|
290
|
-
* @param {string} code2 Unique identifier for the object.
|
|
291
|
-
* @param {string} expand Fields to expand response by
|
|
292
276
|
* @param {string} [authorization] Bearer Token
|
|
277
|
+
* @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: refundItems<i>
|
|
293
278
|
* @param {*} [options] Override http request option.
|
|
294
279
|
* @throws {RequiredError}
|
|
295
280
|
*/
|
|
296
|
-
getRefund(code: string,
|
|
297
|
-
return localVarFp.getRefund(code,
|
|
281
|
+
getRefund(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetRefundResponseClass> {
|
|
282
|
+
return localVarFp.getRefund(code, authorization, expand, options).then((request) => request(axios, basePath));
|
|
298
283
|
},
|
|
299
284
|
/**
|
|
300
|
-
*
|
|
285
|
+
* Returns a list of refunds you have previously created. The refunds are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
286
|
+
* @summary List refunds
|
|
301
287
|
* @param {string} [authorization] Bearer Token
|
|
302
|
-
* @param {
|
|
303
|
-
* @param {
|
|
304
|
-
* @param {
|
|
305
|
-
* @param {
|
|
306
|
-
* @param {
|
|
307
|
-
* @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.
|
|
308
|
-
* @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.
|
|
288
|
+
* @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, status, reason, psp, accountCode, invoiceCode</i>
|
|
289
|
+
* @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, status, reason, psp, accountCode, invoiceCode</i>
|
|
290
|
+
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: id, createdAt, updatedAt, amount, psp, accountCode, invoiceCode, reason, status</i>
|
|
291
|
+
* @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, amount</i>
|
|
292
|
+
* @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: refundItems<i>
|
|
309
293
|
* @param {*} [options] Override http request option.
|
|
310
294
|
* @throws {RequiredError}
|
|
311
295
|
*/
|
|
312
|
-
listRefunds(authorization?: string,
|
|
313
|
-
return localVarFp.listRefunds(authorization,
|
|
296
|
+
listRefunds(authorization?: string, filter?: string, filters?: string, search?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListRefundsResponseClass> {
|
|
297
|
+
return localVarFp.listRefunds(authorization, filter, filters, search, order, expand, options).then((request) => request(axios, basePath));
|
|
314
298
|
},
|
|
315
299
|
};
|
|
316
300
|
};
|
|
@@ -350,25 +334,18 @@ export interface RefundsApiGetRefundRequest {
|
|
|
350
334
|
readonly code: string
|
|
351
335
|
|
|
352
336
|
/**
|
|
353
|
-
*
|
|
354
|
-
* @type {string}
|
|
355
|
-
* @memberof RefundsApiGetRefund
|
|
356
|
-
*/
|
|
357
|
-
readonly code2: string
|
|
358
|
-
|
|
359
|
-
/**
|
|
360
|
-
* Fields to expand response by
|
|
337
|
+
* Bearer Token
|
|
361
338
|
* @type {string}
|
|
362
339
|
* @memberof RefundsApiGetRefund
|
|
363
340
|
*/
|
|
364
|
-
readonly
|
|
341
|
+
readonly authorization?: string
|
|
365
342
|
|
|
366
343
|
/**
|
|
367
|
-
*
|
|
344
|
+
* 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: refundItems<i>
|
|
368
345
|
* @type {string}
|
|
369
346
|
* @memberof RefundsApiGetRefund
|
|
370
347
|
*/
|
|
371
|
-
readonly
|
|
348
|
+
readonly expand?: string
|
|
372
349
|
}
|
|
373
350
|
|
|
374
351
|
/**
|
|
@@ -385,53 +362,39 @@ export interface RefundsApiListRefundsRequest {
|
|
|
385
362
|
readonly authorization?: string
|
|
386
363
|
|
|
387
364
|
/**
|
|
388
|
-
*
|
|
389
|
-
* @type {
|
|
390
|
-
* @memberof RefundsApiListRefunds
|
|
391
|
-
*/
|
|
392
|
-
readonly pageSize?: any
|
|
393
|
-
|
|
394
|
-
/**
|
|
395
|
-
* A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
396
|
-
* @type {any}
|
|
397
|
-
* @memberof RefundsApiListRefunds
|
|
398
|
-
*/
|
|
399
|
-
readonly pageToken?: any
|
|
400
|
-
|
|
401
|
-
/**
|
|
402
|
-
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
403
|
-
* @type {any}
|
|
365
|
+
* 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, status, reason, psp, accountCode, invoiceCode</i>
|
|
366
|
+
* @type {string}
|
|
404
367
|
* @memberof RefundsApiListRefunds
|
|
405
368
|
*/
|
|
406
|
-
readonly filter?:
|
|
369
|
+
readonly filter?: string
|
|
407
370
|
|
|
408
371
|
/**
|
|
409
|
-
*
|
|
410
|
-
* @type {
|
|
372
|
+
* 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, status, reason, psp, accountCode, invoiceCode</i>
|
|
373
|
+
* @type {string}
|
|
411
374
|
* @memberof RefundsApiListRefunds
|
|
412
375
|
*/
|
|
413
|
-
readonly
|
|
376
|
+
readonly filters?: string
|
|
414
377
|
|
|
415
378
|
/**
|
|
416
|
-
*
|
|
417
|
-
* @type {
|
|
379
|
+
* Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: id, createdAt, updatedAt, amount, psp, accountCode, invoiceCode, reason, status</i>
|
|
380
|
+
* @type {string}
|
|
418
381
|
* @memberof RefundsApiListRefunds
|
|
419
382
|
*/
|
|
420
|
-
readonly
|
|
383
|
+
readonly search?: string
|
|
421
384
|
|
|
422
385
|
/**
|
|
423
|
-
*
|
|
424
|
-
* @type {
|
|
386
|
+
* 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, amount</i>
|
|
387
|
+
* @type {string}
|
|
425
388
|
* @memberof RefundsApiListRefunds
|
|
426
389
|
*/
|
|
427
|
-
readonly
|
|
390
|
+
readonly order?: string
|
|
428
391
|
|
|
429
392
|
/**
|
|
430
|
-
*
|
|
431
|
-
* @type {
|
|
393
|
+
* 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: refundItems<i>
|
|
394
|
+
* @type {string}
|
|
432
395
|
* @memberof RefundsApiListRefunds
|
|
433
396
|
*/
|
|
434
|
-
readonly
|
|
397
|
+
readonly expand?: string
|
|
435
398
|
}
|
|
436
399
|
|
|
437
400
|
/**
|
|
@@ -442,7 +405,8 @@ export interface RefundsApiListRefundsRequest {
|
|
|
442
405
|
*/
|
|
443
406
|
export class RefundsApi extends BaseAPI {
|
|
444
407
|
/**
|
|
445
|
-
*
|
|
408
|
+
* This will create a refund in the database.
|
|
409
|
+
* @summary Create the refund
|
|
446
410
|
* @param {RefundsApiCreateRefundRequest} requestParameters Request parameters.
|
|
447
411
|
* @param {*} [options] Override http request option.
|
|
448
412
|
* @throws {RequiredError}
|
|
@@ -453,24 +417,26 @@ export class RefundsApi extends BaseAPI {
|
|
|
453
417
|
}
|
|
454
418
|
|
|
455
419
|
/**
|
|
456
|
-
*
|
|
420
|
+
* Retrieves the details of the refund that was previously created. Supply the unique refund code that was returned when you created it and Emil Api will return the corresponding refund information.
|
|
421
|
+
* @summary Retrieve the refund
|
|
457
422
|
* @param {RefundsApiGetRefundRequest} requestParameters Request parameters.
|
|
458
423
|
* @param {*} [options] Override http request option.
|
|
459
424
|
* @throws {RequiredError}
|
|
460
425
|
* @memberof RefundsApi
|
|
461
426
|
*/
|
|
462
427
|
public getRefund(requestParameters: RefundsApiGetRefundRequest, options?: AxiosRequestConfig) {
|
|
463
|
-
return RefundsApiFp(this.configuration).getRefund(requestParameters.code, requestParameters.
|
|
428
|
+
return RefundsApiFp(this.configuration).getRefund(requestParameters.code, requestParameters.authorization, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
|
|
464
429
|
}
|
|
465
430
|
|
|
466
431
|
/**
|
|
467
|
-
*
|
|
432
|
+
* Returns a list of refunds you have previously created. The refunds are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
433
|
+
* @summary List refunds
|
|
468
434
|
* @param {RefundsApiListRefundsRequest} requestParameters Request parameters.
|
|
469
435
|
* @param {*} [options] Override http request option.
|
|
470
436
|
* @throws {RequiredError}
|
|
471
437
|
* @memberof RefundsApi
|
|
472
438
|
*/
|
|
473
439
|
public listRefunds(requestParameters: RefundsApiListRefundsRequest = {}, options?: AxiosRequestConfig) {
|
|
474
|
-
return RefundsApiFp(this.configuration).listRefunds(requestParameters.authorization, requestParameters.
|
|
440
|
+
return RefundsApiFp(this.configuration).listRefunds(requestParameters.authorization, requestParameters.filter, requestParameters.filters, requestParameters.search, requestParameters.order, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
|
|
475
441
|
}
|
|
476
442
|
}
|