@emilgroup/payment-sdk 1.4.1-beta.3 → 1.4.1-beta.31
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 +12 -39
- package/README.md +2 -2
- package/api/bank-accounts-api.ts +497 -47
- package/api/bank-transaction-api.ts +128 -96
- package/api/{default-api.ts → health-check-api.ts} +22 -18
- package/api/payment-methods-api.ts +74 -203
- package/api/payment-reminders-api.ts +76 -66
- package/api/payment-setup-api.ts +29 -37
- package/api/payments-api.ts +66 -89
- package/api/refunds-api.ts +74 -84
- package/api/tenant-bank-account-api.ts +88 -62
- package/api/webhooks-api.ts +17 -13
- package/api.ts +3 -3
- package/base.ts +6 -2
- package/common.ts +2 -2
- package/configuration.ts +1 -1
- package/dist/api/bank-accounts-api.d.ts +297 -49
- package/dist/api/bank-accounts-api.js +416 -28
- package/dist/api/bank-transaction-api.d.ts +109 -91
- package/dist/api/bank-transaction-api.js +83 -68
- 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 -134
- package/dist/api/payment-methods-api.js +55 -157
- package/dist/api/payment-reminders-api.d.ts +72 -65
- package/dist/api/payment-reminders-api.js +48 -42
- package/dist/api/payment-setup-api.d.ts +19 -23
- package/dist/api/payment-setup-api.js +25 -25
- package/dist/api/payments-api.d.ts +64 -76
- package/dist/api/payments-api.js +47 -55
- package/dist/api/refunds-api.d.ts +74 -74
- package/dist/api/refunds-api.js +52 -48
- package/dist/api/tenant-bank-account-api.d.ts +89 -66
- package/dist/api/tenant-bank-account-api.js +59 -39
- 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 +2 -1
- package/dist/base.js +5 -2
- 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-transaction-response-class.d.ts → bank-transaction-class-without-expand-properties.d.ts} +26 -34
- package/dist/models/{bank-account-class.js → bank-transaction-class-without-expand-properties.js} +1 -1
- package/dist/models/create-bank-account-request-dto.d.ts +15 -3
- package/dist/models/create-bank-account-request-dto.js +1 -1
- 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-request-dto.d.ts +4 -4
- package/dist/models/create-payment-request-dto.js +1 -1
- 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-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/{bank-transaction-response-class.js → create-tenant-bank-account-response-class.js} +1 -1
- 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/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/index.d.ts +11 -38
- package/dist/models/index.js +11 -38
- 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 +24 -0
- package/dist/models/{billing-profile-limited-response-dto.js → link-bank-transaction-request-dto-rest.js} +1 -1
- package/dist/models/list-tenant-bank-account-response-class.d.ts +31 -0
- package/dist/models/{billing-profile-dto.js → list-tenant-bank-account-response-class.js} +1 -1
- 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/{tenant-bank-account-response-class.d.ts → tenant-bank-account-class-without-expand-properties.d.ts} +11 -11
- package/dist/models/tenant-bank-account-class-without-expand-properties.js +15 -0
- package/dist/models/tenant-bank-account-class.d.ts +73 -0
- package/dist/models/tenant-bank-account-class.js +15 -0
- package/dist/models/unlink-bank-transaction-request-dto-rest.d.ts +24 -0
- package/dist/models/unlink-bank-transaction-request-dto-rest.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-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 +2 -9
- package/dist/models/validate-pspconfig-request-dto.js +1 -8
- package/index.ts +1 -1
- package/models/{bank-transaction-response-class.ts → bank-transaction-class-without-expand-properties.ts} +26 -34
- package/models/create-bank-account-request-dto.ts +15 -3
- package/models/create-payment-reminder-request-dto.ts +1 -1
- package/models/create-payment-request-dto.ts +4 -4
- package/models/create-refund-request-dto.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/get-tenant-bank-account-response-class.ts +5 -5
- package/models/index.ts +11 -38
- package/models/inline-response200.ts +1 -1
- package/models/inline-response503.ts +1 -1
- package/models/link-bank-transaction-request-dto-rest.ts +30 -0
- package/models/list-tenant-bank-account-response-class.ts +37 -0
- package/models/set-primary-bank-account-request-dto-rest.ts +30 -0
- package/models/{tenant-bank-account-response-class.ts → tenant-bank-account-class-without-expand-properties.ts} +11 -11
- package/models/tenant-bank-account-class.ts +79 -0
- package/models/unlink-bank-transaction-request-dto-rest.ts +30 -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-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 +2 -12
- package/package.json +1 -1
- package/dist/api/default-api.d.ts +0 -66
- package/dist/models/bank-account-class.d.ts +0 -54
- package/dist/models/billing-profile-dto.d.ts +0 -38
- package/dist/models/billing-profile-limited-response-dto.d.ts +0 -54
- package/dist/models/complete-braintree-payment-setup-request-dto.d.ts +0 -48
- package/dist/models/complete-braintree-payment-setup-request-dto.js +0 -15
- package/dist/models/complete-payment-setup-request-dto.d.ts +0 -32
- package/dist/models/complete-payment-setup-request-dto.js +0 -15
- package/dist/models/complete-payment-setup-response-class.d.ts +0 -25
- package/dist/models/complete-payment-setup-response-class.js +0 -15
- package/dist/models/complete-stripe-payment-setup-request-dto.d.ts +0 -60
- package/dist/models/complete-stripe-payment-setup-request-dto.js +0 -15
- package/dist/models/create-payment-method-response-class.d.ts +0 -25
- package/dist/models/create-payment-method-response-class.js +0 -15
- package/dist/models/create-payment-response-class.d.ts +0 -25
- package/dist/models/create-payment-response-class.js +0 -15
- package/dist/models/create-psp-payment-method-request-dto.d.ts +0 -61
- package/dist/models/create-psp-payment-method-request-dto.js +0 -32
- package/dist/models/create-refund-response-class.d.ts +0 -25
- package/dist/models/create-refund-response-class.js +0 -15
- package/dist/models/deactivate-payment-reminder-response-class.d.ts +0 -25
- package/dist/models/deactivate-payment-reminder-response-class.js +0 -15
- package/dist/models/get-bank-transactions-response-class.d.ts +0 -25
- package/dist/models/get-bank-transactions-response-class.js +0 -15
- package/dist/models/get-payment-method-response-class.d.ts +0 -25
- package/dist/models/get-payment-method-response-class.js +0 -15
- package/dist/models/get-payment-response-class.d.ts +0 -25
- package/dist/models/get-payment-response-class.js +0 -15
- package/dist/models/get-refund-response-class.d.ts +0 -25
- package/dist/models/get-refund-response-class.js +0 -15
- package/dist/models/get-request-dto.d.ts +0 -30
- package/dist/models/get-request-dto.js +0 -15
- package/dist/models/initiate-braintree-payment-setup-request-dto.d.ts +0 -30
- package/dist/models/initiate-braintree-payment-setup-request-dto.js +0 -15
- package/dist/models/initiate-braintree-payment-setup-response-class.d.ts +0 -24
- package/dist/models/initiate-braintree-payment-setup-response-class.js +0 -15
- package/dist/models/initiate-payment-setup-request-dto.d.ts +0 -44
- package/dist/models/initiate-payment-setup-request-dto.js +0 -15
- package/dist/models/initiate-payment-setup-response-class.d.ts +0 -32
- package/dist/models/initiate-payment-setup-response-class.js +0 -15
- package/dist/models/initiate-stripe-payment-setup-request-dto.d.ts +0 -30
- package/dist/models/initiate-stripe-payment-setup-request-dto.js +0 -15
- package/dist/models/initiate-stripe-payment-setup-response-class.d.ts +0 -30
- package/dist/models/initiate-stripe-payment-setup-response-class.js +0 -15
- package/dist/models/list-bank-accounts-response-class.d.ts +0 -31
- package/dist/models/list-bank-accounts-response-class.js +0 -15
- package/dist/models/list-bank-transactions-response-class.d.ts +0 -31
- package/dist/models/list-bank-transactions-response-class.js +0 -15
- package/dist/models/list-payment-methods-response-class.d.ts +0 -31
- package/dist/models/list-payment-methods-response-class.js +0 -15
- package/dist/models/list-payment-reminders-response-class.d.ts +0 -31
- package/dist/models/list-payment-reminders-response-class.js +0 -15
- package/dist/models/list-payments-response-class.d.ts +0 -31
- package/dist/models/list-payments-response-class.js +0 -15
- package/dist/models/list-refunds-response-class.d.ts +0 -31
- package/dist/models/list-refunds-response-class.js +0 -15
- package/dist/models/payment-class.d.ts +0 -103
- package/dist/models/payment-class.js +0 -15
- package/dist/models/payment-method-class.d.ts +0 -66
- package/dist/models/payment-method-class.js +0 -15
- package/dist/models/payment-reminder-class.d.ts +0 -112
- package/dist/models/payment-reminder-class.js +0 -36
- package/dist/models/refund-class.d.ts +0 -104
- package/dist/models/refund-class.js +0 -28
- package/dist/models/sepa-direct-dto.d.ts +0 -24
- package/dist/models/sepa-direct-dto.js +0 -15
- package/dist/models/symphony-profile-limited-response-dto.d.ts +0 -42
- package/dist/models/symphony-profile-limited-response-dto.js +0 -15
- package/dist/models/tenant-bank-account-response-class.js +0 -15
- package/dist/models/transaction-class.d.ts +0 -54
- package/dist/models/transaction-class.js +0 -15
- package/models/bank-account-class.ts +0 -60
- package/models/billing-profile-dto.ts +0 -44
- package/models/billing-profile-limited-response-dto.ts +0 -60
- package/models/complete-braintree-payment-setup-request-dto.ts +0 -54
- package/models/complete-payment-setup-request-dto.ts +0 -38
- package/models/complete-payment-setup-response-class.ts +0 -31
- package/models/complete-stripe-payment-setup-request-dto.ts +0 -66
- package/models/create-payment-method-response-class.ts +0 -31
- package/models/create-payment-response-class.ts +0 -31
- package/models/create-psp-payment-method-request-dto.ts +0 -70
- package/models/create-refund-response-class.ts +0 -31
- package/models/deactivate-payment-reminder-response-class.ts +0 -31
- package/models/get-bank-transactions-response-class.ts +0 -31
- package/models/get-payment-method-response-class.ts +0 -31
- package/models/get-payment-response-class.ts +0 -31
- package/models/get-refund-response-class.ts +0 -31
- package/models/get-request-dto.ts +0 -36
- package/models/initiate-braintree-payment-setup-request-dto.ts +0 -36
- package/models/initiate-braintree-payment-setup-response-class.ts +0 -30
- package/models/initiate-payment-setup-request-dto.ts +0 -50
- package/models/initiate-payment-setup-response-class.ts +0 -38
- package/models/initiate-stripe-payment-setup-request-dto.ts +0 -36
- package/models/initiate-stripe-payment-setup-response-class.ts +0 -36
- package/models/list-bank-accounts-response-class.ts +0 -37
- package/models/list-bank-transactions-response-class.ts +0 -37
- package/models/list-payment-methods-response-class.ts +0 -37
- package/models/list-payment-reminders-response-class.ts +0 -37
- package/models/list-payments-response-class.ts +0 -37
- package/models/list-refunds-response-class.ts +0 -37
- package/models/payment-class.ts +0 -109
- package/models/payment-method-class.ts +0 -72
- package/models/payment-reminder-class.ts +0 -122
- package/models/refund-class.ts +0 -114
- package/models/sepa-direct-dto.ts +0 -30
- package/models/symphony-profile-limited-response-dto.ts +0 -48
- 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
|
|
@@ -22,12 +22,6 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj
|
|
|
22
22
|
import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
|
|
23
23
|
// @ts-ignore
|
|
24
24
|
import { CreateRefundRequestDto } from '../models';
|
|
25
|
-
// @ts-ignore
|
|
26
|
-
import { CreateRefundResponseClass } from '../models';
|
|
27
|
-
// @ts-ignore
|
|
28
|
-
import { GetRefundResponseClass } from '../models';
|
|
29
|
-
// @ts-ignore
|
|
30
|
-
import { ListRefundsResponseClass } from '../models';
|
|
31
25
|
/**
|
|
32
26
|
* RefundsApi - axios parameter creator
|
|
33
27
|
* @export
|
|
@@ -35,7 +29,8 @@ import { ListRefundsResponseClass } from '../models';
|
|
|
35
29
|
export const RefundsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
36
30
|
return {
|
|
37
31
|
/**
|
|
38
|
-
*
|
|
32
|
+
* This will create a refund in the database.
|
|
33
|
+
* @summary Create the refund
|
|
39
34
|
* @param {CreateRefundRequestDto} createRefundRequestDto
|
|
40
35
|
* @param {string} [authorization] Bearer Token
|
|
41
36
|
* @param {*} [options] Override http request option.
|
|
@@ -81,19 +76,17 @@ export const RefundsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
81
76
|
};
|
|
82
77
|
},
|
|
83
78
|
/**
|
|
84
|
-
*
|
|
85
|
-
* @
|
|
86
|
-
* @param {string}
|
|
79
|
+
* 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.
|
|
80
|
+
* @summary Retrieve the refund
|
|
81
|
+
* @param {string} code Unique identifier for the object.
|
|
87
82
|
* @param {string} [authorization] Bearer Token
|
|
88
|
-
* @param {string} [expand]
|
|
83
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: .<i>
|
|
89
84
|
* @param {*} [options] Override http request option.
|
|
90
85
|
* @throws {RequiredError}
|
|
91
86
|
*/
|
|
92
|
-
getRefund: async (code: string,
|
|
87
|
+
getRefund: async (code: string, authorization?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
93
88
|
// verify required parameter 'code' is not null or undefined
|
|
94
89
|
assertParamExists('getRefund', 'code', code)
|
|
95
|
-
// verify required parameter 'code2' is not null or undefined
|
|
96
|
-
assertParamExists('getRefund', 'code2', code2)
|
|
97
90
|
const localVarPath = `/paymentservice/v1/refunds/{code}`
|
|
98
91
|
.replace(`{${"code"}}`, encodeURIComponent(String(code)));
|
|
99
92
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -113,10 +106,6 @@ export const RefundsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
113
106
|
// http bearer authentication required
|
|
114
107
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
115
108
|
|
|
116
|
-
if (code2 !== undefined) {
|
|
117
|
-
localVarQueryParameter['code'] = code2;
|
|
118
|
-
}
|
|
119
|
-
|
|
120
109
|
if (expand !== undefined) {
|
|
121
110
|
localVarQueryParameter['expand'] = expand;
|
|
122
111
|
}
|
|
@@ -137,19 +126,20 @@ export const RefundsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
137
126
|
};
|
|
138
127
|
},
|
|
139
128
|
/**
|
|
140
|
-
*
|
|
129
|
+
* 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.
|
|
130
|
+
* @summary List refunds
|
|
141
131
|
* @param {string} [authorization] Bearer Token
|
|
142
132
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
143
133
|
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
144
|
-
* @param {
|
|
145
|
-
* @param {
|
|
146
|
-
* @param {
|
|
147
|
-
* @param {
|
|
148
|
-
* @param {
|
|
134
|
+
* @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>
|
|
135
|
+
* @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>
|
|
136
|
+
* @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>
|
|
137
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: .<i>
|
|
138
|
+
* @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>
|
|
149
139
|
* @param {*} [options] Override http request option.
|
|
150
140
|
* @throws {RequiredError}
|
|
151
141
|
*/
|
|
152
|
-
listRefunds: async (authorization?: string, pageSize?: any, pageToken?: any, filter?:
|
|
142
|
+
listRefunds: async (authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
153
143
|
const localVarPath = `/paymentservice/v1/refunds`;
|
|
154
144
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
155
145
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -222,43 +212,45 @@ export const RefundsApiFp = function(configuration?: Configuration) {
|
|
|
222
212
|
const localVarAxiosParamCreator = RefundsApiAxiosParamCreator(configuration)
|
|
223
213
|
return {
|
|
224
214
|
/**
|
|
225
|
-
*
|
|
215
|
+
* This will create a refund in the database.
|
|
216
|
+
* @summary Create the refund
|
|
226
217
|
* @param {CreateRefundRequestDto} createRefundRequestDto
|
|
227
218
|
* @param {string} [authorization] Bearer Token
|
|
228
219
|
* @param {*} [options] Override http request option.
|
|
229
220
|
* @throws {RequiredError}
|
|
230
221
|
*/
|
|
231
|
-
async createRefund(createRefundRequestDto: CreateRefundRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
222
|
+
async createRefund(createRefundRequestDto: CreateRefundRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
232
223
|
const localVarAxiosArgs = await localVarAxiosParamCreator.createRefund(createRefundRequestDto, authorization, options);
|
|
233
224
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
234
225
|
},
|
|
235
226
|
/**
|
|
236
|
-
*
|
|
237
|
-
* @
|
|
238
|
-
* @param {string}
|
|
227
|
+
* 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.
|
|
228
|
+
* @summary Retrieve the refund
|
|
229
|
+
* @param {string} code Unique identifier for the object.
|
|
239
230
|
* @param {string} [authorization] Bearer Token
|
|
240
|
-
* @param {string} [expand]
|
|
231
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: .<i>
|
|
241
232
|
* @param {*} [options] Override http request option.
|
|
242
233
|
* @throws {RequiredError}
|
|
243
234
|
*/
|
|
244
|
-
async getRefund(code: string,
|
|
245
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getRefund(code,
|
|
235
|
+
async getRefund(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
236
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getRefund(code, authorization, expand, options);
|
|
246
237
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
247
238
|
},
|
|
248
239
|
/**
|
|
249
|
-
*
|
|
240
|
+
* 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.
|
|
241
|
+
* @summary List refunds
|
|
250
242
|
* @param {string} [authorization] Bearer Token
|
|
251
243
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
252
244
|
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
253
|
-
* @param {
|
|
254
|
-
* @param {
|
|
255
|
-
* @param {
|
|
256
|
-
* @param {
|
|
257
|
-
* @param {
|
|
245
|
+
* @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>
|
|
246
|
+
* @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>
|
|
247
|
+
* @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>
|
|
248
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: .<i>
|
|
249
|
+
* @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>
|
|
258
250
|
* @param {*} [options] Override http request option.
|
|
259
251
|
* @throws {RequiredError}
|
|
260
252
|
*/
|
|
261
|
-
async listRefunds(authorization?: string, pageSize?: any, pageToken?: any, filter?:
|
|
253
|
+
async listRefunds(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
262
254
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listRefunds(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
263
255
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
264
256
|
},
|
|
@@ -273,41 +265,43 @@ export const RefundsApiFactory = function (configuration?: Configuration, basePa
|
|
|
273
265
|
const localVarFp = RefundsApiFp(configuration)
|
|
274
266
|
return {
|
|
275
267
|
/**
|
|
276
|
-
*
|
|
268
|
+
* This will create a refund in the database.
|
|
269
|
+
* @summary Create the refund
|
|
277
270
|
* @param {CreateRefundRequestDto} createRefundRequestDto
|
|
278
271
|
* @param {string} [authorization] Bearer Token
|
|
279
272
|
* @param {*} [options] Override http request option.
|
|
280
273
|
* @throws {RequiredError}
|
|
281
274
|
*/
|
|
282
|
-
createRefund(createRefundRequestDto: CreateRefundRequestDto, authorization?: string, options?: any): AxiosPromise<
|
|
275
|
+
createRefund(createRefundRequestDto: CreateRefundRequestDto, authorization?: string, options?: any): AxiosPromise<void> {
|
|
283
276
|
return localVarFp.createRefund(createRefundRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
284
277
|
},
|
|
285
278
|
/**
|
|
286
|
-
*
|
|
287
|
-
* @
|
|
288
|
-
* @param {string}
|
|
279
|
+
* 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.
|
|
280
|
+
* @summary Retrieve the refund
|
|
281
|
+
* @param {string} code Unique identifier for the object.
|
|
289
282
|
* @param {string} [authorization] Bearer Token
|
|
290
|
-
* @param {string} [expand]
|
|
283
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: .<i>
|
|
291
284
|
* @param {*} [options] Override http request option.
|
|
292
285
|
* @throws {RequiredError}
|
|
293
286
|
*/
|
|
294
|
-
getRefund(code: string,
|
|
295
|
-
return localVarFp.getRefund(code,
|
|
287
|
+
getRefund(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<void> {
|
|
288
|
+
return localVarFp.getRefund(code, authorization, expand, options).then((request) => request(axios, basePath));
|
|
296
289
|
},
|
|
297
290
|
/**
|
|
298
|
-
*
|
|
291
|
+
* 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.
|
|
292
|
+
* @summary List refunds
|
|
299
293
|
* @param {string} [authorization] Bearer Token
|
|
300
294
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
301
295
|
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
302
|
-
* @param {
|
|
303
|
-
* @param {
|
|
304
|
-
* @param {
|
|
305
|
-
* @param {
|
|
306
|
-
* @param {
|
|
296
|
+
* @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>
|
|
297
|
+
* @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>
|
|
298
|
+
* @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>
|
|
299
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: .<i>
|
|
300
|
+
* @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>
|
|
307
301
|
* @param {*} [options] Override http request option.
|
|
308
302
|
* @throws {RequiredError}
|
|
309
303
|
*/
|
|
310
|
-
listRefunds(authorization?: string, pageSize?: any, pageToken?: any, filter?:
|
|
304
|
+
listRefunds(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<void> {
|
|
311
305
|
return localVarFp.listRefunds(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
312
306
|
},
|
|
313
307
|
};
|
|
@@ -340,19 +334,12 @@ export interface RefundsApiCreateRefundRequest {
|
|
|
340
334
|
* @interface RefundsApiGetRefundRequest
|
|
341
335
|
*/
|
|
342
336
|
export interface RefundsApiGetRefundRequest {
|
|
343
|
-
/**
|
|
344
|
-
*
|
|
345
|
-
* @type {string}
|
|
346
|
-
* @memberof RefundsApiGetRefund
|
|
347
|
-
*/
|
|
348
|
-
readonly code: string
|
|
349
|
-
|
|
350
337
|
/**
|
|
351
338
|
* Unique identifier for the object.
|
|
352
339
|
* @type {string}
|
|
353
340
|
* @memberof RefundsApiGetRefund
|
|
354
341
|
*/
|
|
355
|
-
readonly
|
|
342
|
+
readonly code: string
|
|
356
343
|
|
|
357
344
|
/**
|
|
358
345
|
* Bearer Token
|
|
@@ -362,7 +349,7 @@ export interface RefundsApiGetRefundRequest {
|
|
|
362
349
|
readonly authorization?: string
|
|
363
350
|
|
|
364
351
|
/**
|
|
365
|
-
*
|
|
352
|
+
* Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: .<i>
|
|
366
353
|
* @type {string}
|
|
367
354
|
* @memberof RefundsApiGetRefund
|
|
368
355
|
*/
|
|
@@ -397,39 +384,39 @@ export interface RefundsApiListRefundsRequest {
|
|
|
397
384
|
readonly pageToken?: any
|
|
398
385
|
|
|
399
386
|
/**
|
|
400
|
-
* Filter the response by one or multiple fields.
|
|
401
|
-
* @type {
|
|
387
|
+
* 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>
|
|
388
|
+
* @type {string}
|
|
402
389
|
* @memberof RefundsApiListRefunds
|
|
403
390
|
*/
|
|
404
|
-
readonly filter?:
|
|
391
|
+
readonly filter?: string
|
|
405
392
|
|
|
406
393
|
/**
|
|
407
|
-
* Search the
|
|
408
|
-
* @type {
|
|
394
|
+
* 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>
|
|
395
|
+
* @type {string}
|
|
409
396
|
* @memberof RefundsApiListRefunds
|
|
410
397
|
*/
|
|
411
|
-
readonly search?:
|
|
398
|
+
readonly search?: string
|
|
412
399
|
|
|
413
400
|
/**
|
|
414
|
-
*
|
|
415
|
-
* @type {
|
|
401
|
+
* 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>
|
|
402
|
+
* @type {string}
|
|
416
403
|
* @memberof RefundsApiListRefunds
|
|
417
404
|
*/
|
|
418
|
-
readonly order?:
|
|
405
|
+
readonly order?: string
|
|
419
406
|
|
|
420
407
|
/**
|
|
421
|
-
*
|
|
422
|
-
* @type {
|
|
408
|
+
* Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: .<i>
|
|
409
|
+
* @type {string}
|
|
423
410
|
* @memberof RefundsApiListRefunds
|
|
424
411
|
*/
|
|
425
|
-
readonly expand?:
|
|
412
|
+
readonly expand?: string
|
|
426
413
|
|
|
427
414
|
/**
|
|
428
|
-
* Filters the response by one or multiple fields.
|
|
429
|
-
* @type {
|
|
415
|
+
* 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>
|
|
416
|
+
* @type {string}
|
|
430
417
|
* @memberof RefundsApiListRefunds
|
|
431
418
|
*/
|
|
432
|
-
readonly filters?:
|
|
419
|
+
readonly filters?: string
|
|
433
420
|
}
|
|
434
421
|
|
|
435
422
|
/**
|
|
@@ -440,7 +427,8 @@ export interface RefundsApiListRefundsRequest {
|
|
|
440
427
|
*/
|
|
441
428
|
export class RefundsApi extends BaseAPI {
|
|
442
429
|
/**
|
|
443
|
-
*
|
|
430
|
+
* This will create a refund in the database.
|
|
431
|
+
* @summary Create the refund
|
|
444
432
|
* @param {RefundsApiCreateRefundRequest} requestParameters Request parameters.
|
|
445
433
|
* @param {*} [options] Override http request option.
|
|
446
434
|
* @throws {RequiredError}
|
|
@@ -451,18 +439,20 @@ export class RefundsApi extends BaseAPI {
|
|
|
451
439
|
}
|
|
452
440
|
|
|
453
441
|
/**
|
|
454
|
-
*
|
|
442
|
+
* 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.
|
|
443
|
+
* @summary Retrieve the refund
|
|
455
444
|
* @param {RefundsApiGetRefundRequest} requestParameters Request parameters.
|
|
456
445
|
* @param {*} [options] Override http request option.
|
|
457
446
|
* @throws {RequiredError}
|
|
458
447
|
* @memberof RefundsApi
|
|
459
448
|
*/
|
|
460
449
|
public getRefund(requestParameters: RefundsApiGetRefundRequest, options?: AxiosRequestConfig) {
|
|
461
|
-
return RefundsApiFp(this.configuration).getRefund(requestParameters.code, requestParameters.
|
|
450
|
+
return RefundsApiFp(this.configuration).getRefund(requestParameters.code, requestParameters.authorization, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
|
|
462
451
|
}
|
|
463
452
|
|
|
464
453
|
/**
|
|
465
|
-
*
|
|
454
|
+
* 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.
|
|
455
|
+
* @summary List refunds
|
|
466
456
|
* @param {RefundsApiListRefundsRequest} requestParameters Request parameters.
|
|
467
457
|
* @param {*} [options] Override http request option.
|
|
468
458
|
* @throws {RequiredError}
|