@emilgroup/payment-sdk 1.4.1-beta.9 → 1.5.1-beta.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 +11 -11
- package/README.md +2 -2
- package/api/bank-accounts-api.ts +500 -88
- package/api/bank-transaction-api.ts +93 -123
- package/api/{default-api.ts → health-check-api.ts} +22 -18
- package/api/payment-methods-api.ts +61 -242
- package/api/payment-reminders-api.ts +57 -99
- package/api/payment-setup-api.ts +17 -9
- package/api/payments-api.ts +72 -135
- package/api/refunds-api.ts +80 -120
- package/api/tenant-bank-account-api.ts +96 -118
- package/api/webhooks-api.ts +38 -21
- 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 +292 -69
- package/dist/api/bank-accounts-api.js +432 -62
- package/dist/api/bank-transaction-api.d.ts +84 -104
- 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 +51 -151
- package/dist/api/payment-methods-api.js +48 -178
- package/dist/api/payment-reminders-api.d.ts +52 -79
- package/dist/api/payment-reminders-api.js +44 -62
- package/dist/api/payment-setup-api.d.ts +17 -9
- package/dist/api/payment-setup-api.js +17 -9
- package/dist/api/payments-api.d.ts +62 -98
- package/dist/api/payments-api.js +55 -85
- package/dist/api/refunds-api.d.ts +73 -91
- package/dist/api/refunds-api.js +58 -68
- package/dist/api/tenant-bank-account-api.d.ts +90 -105
- package/dist/api/tenant-bank-account-api.js +63 -75
- package/dist/api/webhooks-api.d.ts +29 -16
- package/dist/api/webhooks-api.js +29 -19
- 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-transaction-response-class.d.ts → bank-transaction-class-without-expand-properties.d.ts} +31 -33
- package/dist/models/{bank-transaction-response-class.js → bank-transaction-class-without-expand-properties.js} +1 -1
- package/dist/models/create-bank-account-request-dto.d.ts +42 -0
- package/dist/models/{get-refund-response-class.js → 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 +3 -3
- 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/{create-refund-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 +10 -10
- package/dist/models/index.js +10 -10
- 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/list-tenant-bank-account-response-class.d.ts +31 -0
- package/dist/models/{get-bank-transactions-response-class.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} +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/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 +1 -1
- package/dist/models/validate-pspconfig-request-dto.js +1 -1
- package/index.ts +1 -1
- package/models/{bank-transaction-response-class.ts → bank-transaction-class-without-expand-properties.ts} +31 -33
- package/models/create-bank-account-request-dto.ts +48 -0
- package/models/create-payment-reminder-request-dto.ts +1 -1
- package/models/create-payment-request-dto.ts +3 -3
- 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 +10 -10
- 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/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} +23 -11
- package/models/tenant-bank-account-class.ts +91 -0
- package/models/unlink-bank-transaction-request-dto-rest.ts +2 -2
- 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 +1 -1
- package/package.json +1 -1
- package/dist/api/default-api.d.ts +0 -66
- package/dist/models/create-refund-response-class.d.ts +0 -25
- package/dist/models/get-bank-transactions-response-class.d.ts +0 -25
- package/dist/models/get-refund-response-class.d.ts +0 -25
- package/dist/models/get-request-dto.d.ts +0 -30
- package/dist/models/get-request-dto.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-refunds-response-class.d.ts +0 -31
- package/dist/models/list-refunds-response-class.js +0 -15
- package/dist/models/refund-class.d.ts +0 -104
- package/dist/models/refund-class.js +0 -28
- 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/create-refund-response-class.ts +0 -31
- package/models/get-bank-transactions-response-class.ts +0 -31
- package/models/get-refund-response-class.ts +0 -31
- package/models/get-request-dto.ts +0 -36
- package/models/list-bank-transactions-response-class.ts +0 -37
- package/models/list-refunds-response-class.ts +0 -37
- package/models/refund-class.ts +0 -114
- package/models/transaction-class.ts +0 -60
package/api/payments-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
|
|
@@ -29,8 +29,8 @@ import { CreatePaymentRequestDto } from '../models';
|
|
|
29
29
|
export const PaymentsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
30
30
|
return {
|
|
31
31
|
/**
|
|
32
|
-
*
|
|
33
|
-
* @summary Create
|
|
32
|
+
* This will create a payment for a specified account. This function is idempotent.
|
|
33
|
+
* @summary Create the payment
|
|
34
34
|
* @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
|
|
35
35
|
* @param {CreatePaymentRequestDto} createPaymentRequestDto
|
|
36
36
|
* @param {string} [authorization] Bearer Token
|
|
@@ -83,23 +83,19 @@ export const PaymentsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
83
83
|
};
|
|
84
84
|
},
|
|
85
85
|
/**
|
|
86
|
-
* Retrieves the details of
|
|
87
|
-
* @summary Retrieve
|
|
88
|
-
* @param {string} code
|
|
89
|
-
* @param {string} expand Fields to expand response by
|
|
90
|
-
* @param {string} expand2 Fields to expand response by
|
|
86
|
+
* 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.
|
|
87
|
+
* @summary Retrieve the payment
|
|
88
|
+
* @param {string} code
|
|
91
89
|
* @param {string} [authorization] Bearer Token
|
|
90
|
+
* @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>
|
|
92
91
|
* @param {*} [options] Override http request option.
|
|
93
92
|
* @throws {RequiredError}
|
|
94
93
|
*/
|
|
95
|
-
getPayment: async (code: string,
|
|
94
|
+
getPayment: async (code: string, authorization?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
96
95
|
// verify required parameter 'code' is not null or undefined
|
|
97
96
|
assertParamExists('getPayment', 'code', code)
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
// verify required parameter 'expand2' is not null or undefined
|
|
101
|
-
assertParamExists('getPayment', 'expand2', expand2)
|
|
102
|
-
const localVarPath = `/paymentservice/v1/payments/{code}`;
|
|
97
|
+
const localVarPath = `/paymentservice/v1/payments/{code}`
|
|
98
|
+
.replace(`{${"code"}}`, encodeURIComponent(String(code)));
|
|
103
99
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
104
100
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
105
101
|
let baseOptions;
|
|
@@ -117,18 +113,10 @@ export const PaymentsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
117
113
|
// http bearer authentication required
|
|
118
114
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
119
115
|
|
|
120
|
-
if (code !== undefined) {
|
|
121
|
-
localVarQueryParameter['code'] = code;
|
|
122
|
-
}
|
|
123
|
-
|
|
124
116
|
if (expand !== undefined) {
|
|
125
117
|
localVarQueryParameter['expand'] = expand;
|
|
126
118
|
}
|
|
127
119
|
|
|
128
|
-
if (expand2 !== undefined) {
|
|
129
|
-
localVarQueryParameter['expand'] = expand2;
|
|
130
|
-
}
|
|
131
|
-
|
|
132
120
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
133
121
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
134
122
|
}
|
|
@@ -145,20 +133,17 @@ export const PaymentsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
145
133
|
};
|
|
146
134
|
},
|
|
147
135
|
/**
|
|
148
|
-
* Returns a list of payments you
|
|
136
|
+
* 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.
|
|
149
137
|
* @summary List payments
|
|
150
138
|
* @param {string} [authorization] Bearer Token
|
|
151
|
-
* @param {
|
|
152
|
-
* @param {
|
|
153
|
-
* @param {
|
|
154
|
-
* @param {
|
|
155
|
-
* @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.
|
|
156
|
-
* @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.
|
|
157
|
-
* @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.
|
|
139
|
+
* @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>
|
|
140
|
+
* @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>
|
|
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, code, 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: transactions<i>
|
|
158
143
|
* @param {*} [options] Override http request option.
|
|
159
144
|
* @throws {RequiredError}
|
|
160
145
|
*/
|
|
161
|
-
listPayments: async (authorization?: string,
|
|
146
|
+
listPayments: async (authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
162
147
|
const localVarPath = `/paymentservice/v1/payments`;
|
|
163
148
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
164
149
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -177,20 +162,12 @@ export const PaymentsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
177
162
|
// http bearer authentication required
|
|
178
163
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
179
164
|
|
|
180
|
-
if (pageSize !== undefined) {
|
|
181
|
-
localVarQueryParameter['pageSize'] = pageSize;
|
|
182
|
-
}
|
|
183
|
-
|
|
184
|
-
if (pageToken !== undefined) {
|
|
185
|
-
localVarQueryParameter['pageToken'] = pageToken;
|
|
186
|
-
}
|
|
187
|
-
|
|
188
165
|
if (filter !== undefined) {
|
|
189
166
|
localVarQueryParameter['filter'] = filter;
|
|
190
167
|
}
|
|
191
168
|
|
|
192
|
-
if (
|
|
193
|
-
localVarQueryParameter['
|
|
169
|
+
if (filters !== undefined) {
|
|
170
|
+
localVarQueryParameter['filters'] = filters;
|
|
194
171
|
}
|
|
195
172
|
|
|
196
173
|
if (order !== undefined) {
|
|
@@ -201,10 +178,6 @@ export const PaymentsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
201
178
|
localVarQueryParameter['expand'] = expand;
|
|
202
179
|
}
|
|
203
180
|
|
|
204
|
-
if (filters !== undefined) {
|
|
205
|
-
localVarQueryParameter['filters'] = filters;
|
|
206
|
-
}
|
|
207
|
-
|
|
208
181
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
209
182
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
210
183
|
}
|
|
@@ -231,8 +204,8 @@ export const PaymentsApiFp = function(configuration?: Configuration) {
|
|
|
231
204
|
const localVarAxiosParamCreator = PaymentsApiAxiosParamCreator(configuration)
|
|
232
205
|
return {
|
|
233
206
|
/**
|
|
234
|
-
*
|
|
235
|
-
* @summary Create
|
|
207
|
+
* This will create a payment for a specified account. This function is idempotent.
|
|
208
|
+
* @summary Create the payment
|
|
236
209
|
* @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
|
|
237
210
|
* @param {CreatePaymentRequestDto} createPaymentRequestDto
|
|
238
211
|
* @param {string} [authorization] Bearer Token
|
|
@@ -244,35 +217,31 @@ export const PaymentsApiFp = function(configuration?: Configuration) {
|
|
|
244
217
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
245
218
|
},
|
|
246
219
|
/**
|
|
247
|
-
* Retrieves the details of
|
|
248
|
-
* @summary Retrieve
|
|
249
|
-
* @param {string} code
|
|
250
|
-
* @param {string} expand Fields to expand response by
|
|
251
|
-
* @param {string} expand2 Fields to expand response by
|
|
220
|
+
* 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.
|
|
221
|
+
* @summary Retrieve the payment
|
|
222
|
+
* @param {string} code
|
|
252
223
|
* @param {string} [authorization] Bearer Token
|
|
224
|
+
* @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>
|
|
253
225
|
* @param {*} [options] Override http request option.
|
|
254
226
|
* @throws {RequiredError}
|
|
255
227
|
*/
|
|
256
|
-
async getPayment(code: string,
|
|
257
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getPayment(code,
|
|
228
|
+
async getPayment(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
229
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getPayment(code, authorization, expand, options);
|
|
258
230
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
259
231
|
},
|
|
260
232
|
/**
|
|
261
|
-
* Returns a list of payments you
|
|
233
|
+
* 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.
|
|
262
234
|
* @summary List payments
|
|
263
235
|
* @param {string} [authorization] Bearer Token
|
|
264
|
-
* @param {
|
|
265
|
-
* @param {
|
|
266
|
-
* @param {
|
|
267
|
-
* @param {
|
|
268
|
-
* @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.
|
|
269
|
-
* @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.
|
|
270
|
-
* @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.
|
|
236
|
+
* @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>
|
|
237
|
+
* @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>
|
|
238
|
+
* @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>
|
|
239
|
+
* @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>
|
|
271
240
|
* @param {*} [options] Override http request option.
|
|
272
241
|
* @throws {RequiredError}
|
|
273
242
|
*/
|
|
274
|
-
async listPayments(authorization?: string,
|
|
275
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listPayments(authorization,
|
|
243
|
+
async listPayments(authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
244
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listPayments(authorization, filter, filters, order, expand, options);
|
|
276
245
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
277
246
|
},
|
|
278
247
|
}
|
|
@@ -286,8 +255,8 @@ export const PaymentsApiFactory = function (configuration?: Configuration, baseP
|
|
|
286
255
|
const localVarFp = PaymentsApiFp(configuration)
|
|
287
256
|
return {
|
|
288
257
|
/**
|
|
289
|
-
*
|
|
290
|
-
* @summary Create
|
|
258
|
+
* This will create a payment for a specified account. This function is idempotent.
|
|
259
|
+
* @summary Create the payment
|
|
291
260
|
* @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
|
|
292
261
|
* @param {CreatePaymentRequestDto} createPaymentRequestDto
|
|
293
262
|
* @param {string} [authorization] Bearer Token
|
|
@@ -298,34 +267,30 @@ export const PaymentsApiFactory = function (configuration?: Configuration, baseP
|
|
|
298
267
|
return localVarFp.createPayment(idempotencyKey, createPaymentRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
299
268
|
},
|
|
300
269
|
/**
|
|
301
|
-
* Retrieves the details of
|
|
302
|
-
* @summary Retrieve
|
|
303
|
-
* @param {string} code
|
|
304
|
-
* @param {string} expand Fields to expand response by
|
|
305
|
-
* @param {string} expand2 Fields to expand response by
|
|
270
|
+
* 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.
|
|
271
|
+
* @summary Retrieve the payment
|
|
272
|
+
* @param {string} code
|
|
306
273
|
* @param {string} [authorization] Bearer Token
|
|
274
|
+
* @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>
|
|
307
275
|
* @param {*} [options] Override http request option.
|
|
308
276
|
* @throws {RequiredError}
|
|
309
277
|
*/
|
|
310
|
-
getPayment(code: string,
|
|
311
|
-
return localVarFp.getPayment(code,
|
|
278
|
+
getPayment(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<void> {
|
|
279
|
+
return localVarFp.getPayment(code, authorization, expand, options).then((request) => request(axios, basePath));
|
|
312
280
|
},
|
|
313
281
|
/**
|
|
314
|
-
* Returns a list of payments you
|
|
282
|
+
* 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.
|
|
315
283
|
* @summary List payments
|
|
316
284
|
* @param {string} [authorization] Bearer Token
|
|
317
|
-
* @param {
|
|
318
|
-
* @param {
|
|
319
|
-
* @param {
|
|
320
|
-
* @param {
|
|
321
|
-
* @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.
|
|
322
|
-
* @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.
|
|
323
|
-
* @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.
|
|
285
|
+
* @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>
|
|
286
|
+
* @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>
|
|
287
|
+
* @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>
|
|
288
|
+
* @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>
|
|
324
289
|
* @param {*} [options] Override http request option.
|
|
325
290
|
* @throws {RequiredError}
|
|
326
291
|
*/
|
|
327
|
-
listPayments(authorization?: string,
|
|
328
|
-
return localVarFp.listPayments(authorization,
|
|
292
|
+
listPayments(authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: any): AxiosPromise<void> {
|
|
293
|
+
return localVarFp.listPayments(authorization, filter, filters, order, expand, options).then((request) => request(axios, basePath));
|
|
329
294
|
},
|
|
330
295
|
};
|
|
331
296
|
};
|
|
@@ -365,32 +330,25 @@ export interface PaymentsApiCreatePaymentRequest {
|
|
|
365
330
|
*/
|
|
366
331
|
export interface PaymentsApiGetPaymentRequest {
|
|
367
332
|
/**
|
|
368
|
-
*
|
|
333
|
+
*
|
|
369
334
|
* @type {string}
|
|
370
335
|
* @memberof PaymentsApiGetPayment
|
|
371
336
|
*/
|
|
372
337
|
readonly code: string
|
|
373
338
|
|
|
374
339
|
/**
|
|
375
|
-
*
|
|
376
|
-
* @type {string}
|
|
377
|
-
* @memberof PaymentsApiGetPayment
|
|
378
|
-
*/
|
|
379
|
-
readonly expand: string
|
|
380
|
-
|
|
381
|
-
/**
|
|
382
|
-
* Fields to expand response by
|
|
340
|
+
* Bearer Token
|
|
383
341
|
* @type {string}
|
|
384
342
|
* @memberof PaymentsApiGetPayment
|
|
385
343
|
*/
|
|
386
|
-
readonly
|
|
344
|
+
readonly authorization?: string
|
|
387
345
|
|
|
388
346
|
/**
|
|
389
|
-
*
|
|
347
|
+
* 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>
|
|
390
348
|
* @type {string}
|
|
391
349
|
* @memberof PaymentsApiGetPayment
|
|
392
350
|
*/
|
|
393
|
-
readonly
|
|
351
|
+
readonly expand?: string
|
|
394
352
|
}
|
|
395
353
|
|
|
396
354
|
/**
|
|
@@ -407,53 +365,32 @@ export interface PaymentsApiListPaymentsRequest {
|
|
|
407
365
|
readonly authorization?: string
|
|
408
366
|
|
|
409
367
|
/**
|
|
410
|
-
*
|
|
411
|
-
* @type {
|
|
412
|
-
* @memberof PaymentsApiListPayments
|
|
413
|
-
*/
|
|
414
|
-
readonly pageSize?: any
|
|
415
|
-
|
|
416
|
-
/**
|
|
417
|
-
* 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.
|
|
418
|
-
* @type {any}
|
|
419
|
-
* @memberof PaymentsApiListPayments
|
|
420
|
-
*/
|
|
421
|
-
readonly pageToken?: any
|
|
422
|
-
|
|
423
|
-
/**
|
|
424
|
-
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
425
|
-
* @type {any}
|
|
426
|
-
* @memberof PaymentsApiListPayments
|
|
427
|
-
*/
|
|
428
|
-
readonly filter?: any
|
|
429
|
-
|
|
430
|
-
/**
|
|
431
|
-
* Search the list by any field. For instance, if you want to search by code add code=xxx in order to fetch the result.
|
|
432
|
-
* @type {any}
|
|
368
|
+
* 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>
|
|
369
|
+
* @type {string}
|
|
433
370
|
* @memberof PaymentsApiListPayments
|
|
434
371
|
*/
|
|
435
|
-
readonly
|
|
372
|
+
readonly filter?: string
|
|
436
373
|
|
|
437
374
|
/**
|
|
438
|
-
*
|
|
439
|
-
* @type {
|
|
375
|
+
* 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>
|
|
376
|
+
* @type {string}
|
|
440
377
|
* @memberof PaymentsApiListPayments
|
|
441
378
|
*/
|
|
442
|
-
readonly
|
|
379
|
+
readonly filters?: string
|
|
443
380
|
|
|
444
381
|
/**
|
|
445
|
-
*
|
|
446
|
-
* @type {
|
|
382
|
+
* 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>
|
|
383
|
+
* @type {string}
|
|
447
384
|
* @memberof PaymentsApiListPayments
|
|
448
385
|
*/
|
|
449
|
-
readonly
|
|
386
|
+
readonly order?: string
|
|
450
387
|
|
|
451
388
|
/**
|
|
452
|
-
*
|
|
453
|
-
* @type {
|
|
389
|
+
* 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>
|
|
390
|
+
* @type {string}
|
|
454
391
|
* @memberof PaymentsApiListPayments
|
|
455
392
|
*/
|
|
456
|
-
readonly
|
|
393
|
+
readonly expand?: string
|
|
457
394
|
}
|
|
458
395
|
|
|
459
396
|
/**
|
|
@@ -464,8 +401,8 @@ export interface PaymentsApiListPaymentsRequest {
|
|
|
464
401
|
*/
|
|
465
402
|
export class PaymentsApi extends BaseAPI {
|
|
466
403
|
/**
|
|
467
|
-
*
|
|
468
|
-
* @summary Create
|
|
404
|
+
* This will create a payment for a specified account. This function is idempotent.
|
|
405
|
+
* @summary Create the payment
|
|
469
406
|
* @param {PaymentsApiCreatePaymentRequest} requestParameters Request parameters.
|
|
470
407
|
* @param {*} [options] Override http request option.
|
|
471
408
|
* @throws {RequiredError}
|
|
@@ -476,19 +413,19 @@ export class PaymentsApi extends BaseAPI {
|
|
|
476
413
|
}
|
|
477
414
|
|
|
478
415
|
/**
|
|
479
|
-
* Retrieves the details of
|
|
480
|
-
* @summary Retrieve
|
|
416
|
+
* 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.
|
|
417
|
+
* @summary Retrieve the payment
|
|
481
418
|
* @param {PaymentsApiGetPaymentRequest} requestParameters Request parameters.
|
|
482
419
|
* @param {*} [options] Override http request option.
|
|
483
420
|
* @throws {RequiredError}
|
|
484
421
|
* @memberof PaymentsApi
|
|
485
422
|
*/
|
|
486
423
|
public getPayment(requestParameters: PaymentsApiGetPaymentRequest, options?: AxiosRequestConfig) {
|
|
487
|
-
return PaymentsApiFp(this.configuration).getPayment(requestParameters.code, requestParameters.
|
|
424
|
+
return PaymentsApiFp(this.configuration).getPayment(requestParameters.code, requestParameters.authorization, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
|
|
488
425
|
}
|
|
489
426
|
|
|
490
427
|
/**
|
|
491
|
-
* Returns a list of payments you
|
|
428
|
+
* 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.
|
|
492
429
|
* @summary List payments
|
|
493
430
|
* @param {PaymentsApiListPaymentsRequest} requestParameters Request parameters.
|
|
494
431
|
* @param {*} [options] Override http request option.
|
|
@@ -496,6 +433,6 @@ export class PaymentsApi extends BaseAPI {
|
|
|
496
433
|
* @memberof PaymentsApi
|
|
497
434
|
*/
|
|
498
435
|
public listPayments(requestParameters: PaymentsApiListPaymentsRequest = {}, options?: AxiosRequestConfig) {
|
|
499
|
-
return PaymentsApiFp(this.configuration).listPayments(requestParameters.authorization, requestParameters.
|
|
436
|
+
return PaymentsApiFp(this.configuration).listPayments(requestParameters.authorization, requestParameters.filter, requestParameters.filters, requestParameters.order, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
|
|
500
437
|
}
|
|
501
438
|
}
|