@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
|
@@ -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
|
|
@@ -32,7 +32,7 @@ export const PaymentRemindersApiAxiosParamCreator = function (configuration?: Co
|
|
|
32
32
|
return {
|
|
33
33
|
/**
|
|
34
34
|
* This will create a payment reminder in the database.
|
|
35
|
-
* @summary Create the payment
|
|
35
|
+
* @summary Create the payment reminder
|
|
36
36
|
* @param {CreatePaymentReminderRequestDto} createPaymentReminderRequestDto
|
|
37
37
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
38
38
|
* @param {*} [options] Override http request option.
|
|
@@ -78,8 +78,8 @@ export const PaymentRemindersApiAxiosParamCreator = function (configuration?: Co
|
|
|
78
78
|
};
|
|
79
79
|
},
|
|
80
80
|
/**
|
|
81
|
-
*
|
|
82
|
-
* @summary
|
|
81
|
+
* This will deactivate the payment reminder
|
|
82
|
+
* @summary Deactivate payment reminder
|
|
83
83
|
* @param {string} code Unique identifier for the object.
|
|
84
84
|
* @param {DeactivatePaymentReminderRequestDto} deactivatePaymentReminderRequestDto
|
|
85
85
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -129,9 +129,9 @@ export const PaymentRemindersApiAxiosParamCreator = function (configuration?: Co
|
|
|
129
129
|
};
|
|
130
130
|
},
|
|
131
131
|
/**
|
|
132
|
-
* Retrieves the details of the payment reminder that was previously created. Supply the unique payment reminder code
|
|
132
|
+
* Retrieves the details of the payment reminder that was previously created. Supply the unique payment reminder code that was returned when you created it and Emil Api will return the corresponding payment reminder information.
|
|
133
133
|
* @summary Retrieve the payment reminder
|
|
134
|
-
* @param {string} code
|
|
134
|
+
* @param {string} code
|
|
135
135
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
136
136
|
* @param {*} [options] Override http request option.
|
|
137
137
|
* @throws {RequiredError}
|
|
@@ -174,20 +174,17 @@ export const PaymentRemindersApiAxiosParamCreator = function (configuration?: Co
|
|
|
174
174
|
};
|
|
175
175
|
},
|
|
176
176
|
/**
|
|
177
|
-
* Returns a list of payment reminders you have previously created.
|
|
177
|
+
* Returns a list of payment reminders you have previously created. The payment reminders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
178
178
|
* @summary List payment reminders
|
|
179
179
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
180
|
-
* @param {
|
|
181
|
-
* @param {
|
|
182
|
-
* @param {
|
|
183
|
-
* @param {
|
|
184
|
-
* @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.
|
|
185
|
-
* @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.
|
|
186
|
-
* @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.
|
|
180
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, id, policyCode, nextReminderDate</i>
|
|
181
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, id, policyCode, nextReminderDate</i>
|
|
182
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, updatedAt</i>
|
|
183
|
+
* @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>
|
|
187
184
|
* @param {*} [options] Override http request option.
|
|
188
185
|
* @throws {RequiredError}
|
|
189
186
|
*/
|
|
190
|
-
listPaymentReminders: async (authorization?: string,
|
|
187
|
+
listPaymentReminders: async (authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
191
188
|
const localVarPath = `/paymentservice/v1/payment-reminders`;
|
|
192
189
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
193
190
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -206,20 +203,12 @@ export const PaymentRemindersApiAxiosParamCreator = function (configuration?: Co
|
|
|
206
203
|
// http bearer authentication required
|
|
207
204
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
208
205
|
|
|
209
|
-
if (pageSize !== undefined) {
|
|
210
|
-
localVarQueryParameter['pageSize'] = pageSize;
|
|
211
|
-
}
|
|
212
|
-
|
|
213
|
-
if (pageToken !== undefined) {
|
|
214
|
-
localVarQueryParameter['pageToken'] = pageToken;
|
|
215
|
-
}
|
|
216
|
-
|
|
217
206
|
if (filter !== undefined) {
|
|
218
207
|
localVarQueryParameter['filter'] = filter;
|
|
219
208
|
}
|
|
220
209
|
|
|
221
|
-
if (
|
|
222
|
-
localVarQueryParameter['
|
|
210
|
+
if (filters !== undefined) {
|
|
211
|
+
localVarQueryParameter['filters'] = filters;
|
|
223
212
|
}
|
|
224
213
|
|
|
225
214
|
if (order !== undefined) {
|
|
@@ -230,10 +219,6 @@ export const PaymentRemindersApiAxiosParamCreator = function (configuration?: Co
|
|
|
230
219
|
localVarQueryParameter['expand'] = expand;
|
|
231
220
|
}
|
|
232
221
|
|
|
233
|
-
if (filters !== undefined) {
|
|
234
|
-
localVarQueryParameter['filters'] = filters;
|
|
235
|
-
}
|
|
236
|
-
|
|
237
222
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
238
223
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
239
224
|
}
|
|
@@ -261,7 +246,7 @@ export const PaymentRemindersApiFp = function(configuration?: Configuration) {
|
|
|
261
246
|
return {
|
|
262
247
|
/**
|
|
263
248
|
* This will create a payment reminder in the database.
|
|
264
|
-
* @summary Create the payment
|
|
249
|
+
* @summary Create the payment reminder
|
|
265
250
|
* @param {CreatePaymentReminderRequestDto} createPaymentReminderRequestDto
|
|
266
251
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
267
252
|
* @param {*} [options] Override http request option.
|
|
@@ -272,8 +257,8 @@ export const PaymentRemindersApiFp = function(configuration?: Configuration) {
|
|
|
272
257
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
273
258
|
},
|
|
274
259
|
/**
|
|
275
|
-
*
|
|
276
|
-
* @summary
|
|
260
|
+
* This will deactivate the payment reminder
|
|
261
|
+
* @summary Deactivate payment reminder
|
|
277
262
|
* @param {string} code Unique identifier for the object.
|
|
278
263
|
* @param {DeactivatePaymentReminderRequestDto} deactivatePaymentReminderRequestDto
|
|
279
264
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -285,9 +270,9 @@ export const PaymentRemindersApiFp = function(configuration?: Configuration) {
|
|
|
285
270
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
286
271
|
},
|
|
287
272
|
/**
|
|
288
|
-
* Retrieves the details of the payment reminder that was previously created. Supply the unique payment reminder code
|
|
273
|
+
* Retrieves the details of the payment reminder that was previously created. Supply the unique payment reminder code that was returned when you created it and Emil Api will return the corresponding payment reminder information.
|
|
289
274
|
* @summary Retrieve the payment reminder
|
|
290
|
-
* @param {string} code
|
|
275
|
+
* @param {string} code
|
|
291
276
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
292
277
|
* @param {*} [options] Override http request option.
|
|
293
278
|
* @throws {RequiredError}
|
|
@@ -297,21 +282,18 @@ export const PaymentRemindersApiFp = function(configuration?: Configuration) {
|
|
|
297
282
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
298
283
|
},
|
|
299
284
|
/**
|
|
300
|
-
* Returns a list of payment reminders you have previously created.
|
|
285
|
+
* Returns a list of payment reminders you have previously created. The payment reminders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
301
286
|
* @summary List payment reminders
|
|
302
287
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
303
|
-
* @param {
|
|
304
|
-
* @param {
|
|
305
|
-
* @param {
|
|
306
|
-
* @param {
|
|
307
|
-
* @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.
|
|
308
|
-
* @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.
|
|
309
|
-
* @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, policyCode, nextReminderDate</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, policyCode, nextReminderDate</i>
|
|
290
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, updatedAt</i>
|
|
291
|
+
* @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>
|
|
310
292
|
* @param {*} [options] Override http request option.
|
|
311
293
|
* @throws {RequiredError}
|
|
312
294
|
*/
|
|
313
|
-
async listPaymentReminders(authorization?: string,
|
|
314
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listPaymentReminders(authorization,
|
|
295
|
+
async listPaymentReminders(authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
296
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listPaymentReminders(authorization, filter, filters, order, expand, options);
|
|
315
297
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
316
298
|
},
|
|
317
299
|
}
|
|
@@ -326,7 +308,7 @@ export const PaymentRemindersApiFactory = function (configuration?: Configuratio
|
|
|
326
308
|
return {
|
|
327
309
|
/**
|
|
328
310
|
* This will create a payment reminder in the database.
|
|
329
|
-
* @summary Create the payment
|
|
311
|
+
* @summary Create the payment reminder
|
|
330
312
|
* @param {CreatePaymentReminderRequestDto} createPaymentReminderRequestDto
|
|
331
313
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
332
314
|
* @param {*} [options] Override http request option.
|
|
@@ -336,8 +318,8 @@ export const PaymentRemindersApiFactory = function (configuration?: Configuratio
|
|
|
336
318
|
return localVarFp.createPaymentReminder(createPaymentReminderRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
337
319
|
},
|
|
338
320
|
/**
|
|
339
|
-
*
|
|
340
|
-
* @summary
|
|
321
|
+
* This will deactivate the payment reminder
|
|
322
|
+
* @summary Deactivate payment reminder
|
|
341
323
|
* @param {string} code Unique identifier for the object.
|
|
342
324
|
* @param {DeactivatePaymentReminderRequestDto} deactivatePaymentReminderRequestDto
|
|
343
325
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -348,9 +330,9 @@ export const PaymentRemindersApiFactory = function (configuration?: Configuratio
|
|
|
348
330
|
return localVarFp.deactivatePaymentReminder(code, deactivatePaymentReminderRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
349
331
|
},
|
|
350
332
|
/**
|
|
351
|
-
* Retrieves the details of the payment reminder that was previously created. Supply the unique payment reminder code
|
|
333
|
+
* Retrieves the details of the payment reminder that was previously created. Supply the unique payment reminder code that was returned when you created it and Emil Api will return the corresponding payment reminder information.
|
|
352
334
|
* @summary Retrieve the payment reminder
|
|
353
|
-
* @param {string} code
|
|
335
|
+
* @param {string} code
|
|
354
336
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
355
337
|
* @param {*} [options] Override http request option.
|
|
356
338
|
* @throws {RequiredError}
|
|
@@ -359,21 +341,18 @@ export const PaymentRemindersApiFactory = function (configuration?: Configuratio
|
|
|
359
341
|
return localVarFp.getPolicy(code, authorization, options).then((request) => request(axios, basePath));
|
|
360
342
|
},
|
|
361
343
|
/**
|
|
362
|
-
* Returns a list of payment reminders you have previously created.
|
|
344
|
+
* Returns a list of payment reminders you have previously created. The payment reminders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
363
345
|
* @summary List payment reminders
|
|
364
346
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
365
|
-
* @param {
|
|
366
|
-
* @param {
|
|
367
|
-
* @param {
|
|
368
|
-
* @param {
|
|
369
|
-
* @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.
|
|
370
|
-
* @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.
|
|
371
|
-
* @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.
|
|
347
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, id, policyCode, nextReminderDate</i>
|
|
348
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, id, policyCode, nextReminderDate</i>
|
|
349
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, updatedAt</i>
|
|
350
|
+
* @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>
|
|
372
351
|
* @param {*} [options] Override http request option.
|
|
373
352
|
* @throws {RequiredError}
|
|
374
353
|
*/
|
|
375
|
-
listPaymentReminders(authorization?: string,
|
|
376
|
-
return localVarFp.listPaymentReminders(authorization,
|
|
354
|
+
listPaymentReminders(authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: any): AxiosPromise<void> {
|
|
355
|
+
return localVarFp.listPaymentReminders(authorization, filter, filters, order, expand, options).then((request) => request(axios, basePath));
|
|
377
356
|
},
|
|
378
357
|
};
|
|
379
358
|
};
|
|
@@ -434,7 +413,7 @@ export interface PaymentRemindersApiDeactivatePaymentReminderRequest {
|
|
|
434
413
|
*/
|
|
435
414
|
export interface PaymentRemindersApiGetPolicyRequest {
|
|
436
415
|
/**
|
|
437
|
-
*
|
|
416
|
+
*
|
|
438
417
|
* @type {string}
|
|
439
418
|
* @memberof PaymentRemindersApiGetPolicy
|
|
440
419
|
*/
|
|
@@ -462,53 +441,32 @@ export interface PaymentRemindersApiListPaymentRemindersRequest {
|
|
|
462
441
|
readonly authorization?: string
|
|
463
442
|
|
|
464
443
|
/**
|
|
465
|
-
*
|
|
466
|
-
* @type {
|
|
467
|
-
* @memberof PaymentRemindersApiListPaymentReminders
|
|
468
|
-
*/
|
|
469
|
-
readonly pageSize?: any
|
|
470
|
-
|
|
471
|
-
/**
|
|
472
|
-
* 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.
|
|
473
|
-
* @type {any}
|
|
474
|
-
* @memberof PaymentRemindersApiListPaymentReminders
|
|
475
|
-
*/
|
|
476
|
-
readonly pageToken?: any
|
|
477
|
-
|
|
478
|
-
/**
|
|
479
|
-
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
480
|
-
* @type {any}
|
|
481
|
-
* @memberof PaymentRemindersApiListPaymentReminders
|
|
482
|
-
*/
|
|
483
|
-
readonly filter?: any
|
|
484
|
-
|
|
485
|
-
/**
|
|
486
|
-
* Search the list by any field. For instance, if you want to search by code add code=xxx in order to fetch the result.
|
|
487
|
-
* @type {any}
|
|
444
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, id, policyCode, nextReminderDate</i>
|
|
445
|
+
* @type {string}
|
|
488
446
|
* @memberof PaymentRemindersApiListPaymentReminders
|
|
489
447
|
*/
|
|
490
|
-
readonly
|
|
448
|
+
readonly filter?: string
|
|
491
449
|
|
|
492
450
|
/**
|
|
493
|
-
*
|
|
494
|
-
* @type {
|
|
451
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, id, policyCode, nextReminderDate</i>
|
|
452
|
+
* @type {string}
|
|
495
453
|
* @memberof PaymentRemindersApiListPaymentReminders
|
|
496
454
|
*/
|
|
497
|
-
readonly
|
|
455
|
+
readonly filters?: string
|
|
498
456
|
|
|
499
457
|
/**
|
|
500
|
-
*
|
|
501
|
-
* @type {
|
|
458
|
+
* Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, updatedAt</i>
|
|
459
|
+
* @type {string}
|
|
502
460
|
* @memberof PaymentRemindersApiListPaymentReminders
|
|
503
461
|
*/
|
|
504
|
-
readonly
|
|
462
|
+
readonly order?: string
|
|
505
463
|
|
|
506
464
|
/**
|
|
507
|
-
*
|
|
508
|
-
* @type {
|
|
465
|
+
* 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>
|
|
466
|
+
* @type {string}
|
|
509
467
|
* @memberof PaymentRemindersApiListPaymentReminders
|
|
510
468
|
*/
|
|
511
|
-
readonly
|
|
469
|
+
readonly expand?: string
|
|
512
470
|
}
|
|
513
471
|
|
|
514
472
|
/**
|
|
@@ -520,7 +478,7 @@ export interface PaymentRemindersApiListPaymentRemindersRequest {
|
|
|
520
478
|
export class PaymentRemindersApi extends BaseAPI {
|
|
521
479
|
/**
|
|
522
480
|
* This will create a payment reminder in the database.
|
|
523
|
-
* @summary Create the payment
|
|
481
|
+
* @summary Create the payment reminder
|
|
524
482
|
* @param {PaymentRemindersApiCreatePaymentReminderRequest} requestParameters Request parameters.
|
|
525
483
|
* @param {*} [options] Override http request option.
|
|
526
484
|
* @throws {RequiredError}
|
|
@@ -531,8 +489,8 @@ export class PaymentRemindersApi extends BaseAPI {
|
|
|
531
489
|
}
|
|
532
490
|
|
|
533
491
|
/**
|
|
534
|
-
*
|
|
535
|
-
* @summary
|
|
492
|
+
* This will deactivate the payment reminder
|
|
493
|
+
* @summary Deactivate payment reminder
|
|
536
494
|
* @param {PaymentRemindersApiDeactivatePaymentReminderRequest} requestParameters Request parameters.
|
|
537
495
|
* @param {*} [options] Override http request option.
|
|
538
496
|
* @throws {RequiredError}
|
|
@@ -543,7 +501,7 @@ export class PaymentRemindersApi extends BaseAPI {
|
|
|
543
501
|
}
|
|
544
502
|
|
|
545
503
|
/**
|
|
546
|
-
* Retrieves the details of the payment reminder that was previously created. Supply the unique payment reminder code
|
|
504
|
+
* Retrieves the details of the payment reminder that was previously created. Supply the unique payment reminder code that was returned when you created it and Emil Api will return the corresponding payment reminder information.
|
|
547
505
|
* @summary Retrieve the payment reminder
|
|
548
506
|
* @param {PaymentRemindersApiGetPolicyRequest} requestParameters Request parameters.
|
|
549
507
|
* @param {*} [options] Override http request option.
|
|
@@ -555,7 +513,7 @@ export class PaymentRemindersApi extends BaseAPI {
|
|
|
555
513
|
}
|
|
556
514
|
|
|
557
515
|
/**
|
|
558
|
-
* Returns a list of payment reminders you have previously created.
|
|
516
|
+
* Returns a list of payment reminders you have previously created. The payment reminders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
559
517
|
* @summary List payment reminders
|
|
560
518
|
* @param {PaymentRemindersApiListPaymentRemindersRequest} requestParameters Request parameters.
|
|
561
519
|
* @param {*} [options] Override http request option.
|
|
@@ -563,6 +521,6 @@ export class PaymentRemindersApi extends BaseAPI {
|
|
|
563
521
|
* @memberof PaymentRemindersApi
|
|
564
522
|
*/
|
|
565
523
|
public listPaymentReminders(requestParameters: PaymentRemindersApiListPaymentRemindersRequest = {}, options?: AxiosRequestConfig) {
|
|
566
|
-
return PaymentRemindersApiFp(this.configuration).listPaymentReminders(requestParameters.authorization, requestParameters.
|
|
524
|
+
return PaymentRemindersApiFp(this.configuration).listPaymentReminders(requestParameters.authorization, requestParameters.filter, requestParameters.filters, requestParameters.order, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
|
|
567
525
|
}
|
|
568
526
|
}
|
package/api/payment-setup-api.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* Emil Payment Service
|
|
5
|
-
* This service directly communicates with the various Payment Service Providers (PSPs)
|
|
5
|
+
* This service directly communicates with the various Payment Service Providers (PSPs) in order to charge or refund customers. This service will automatically connect to the PSP linked in your admin configuration; meaning if you configured Stripe, it will automatically create a payment on Stripe when you create it in Emil.
|
|
6
6
|
*
|
|
7
7
|
* The version of the OpenAPI document: 1.0
|
|
8
8
|
* Contact: kontakt@emil.de
|
|
@@ -27,7 +27,8 @@ import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } fr
|
|
|
27
27
|
export const PaymentSetupApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
28
28
|
return {
|
|
29
29
|
/**
|
|
30
|
-
*
|
|
30
|
+
* This endpoint is used to save user-provided payment information. The service will send a request to the configured PSP to securely store the payment data.
|
|
31
|
+
* @summary Complete a payment setup
|
|
31
32
|
* @param {object} body
|
|
32
33
|
* @param {string} [authorization] Bearer Token
|
|
33
34
|
* @param {*} [options] Override http request option.
|
|
@@ -73,7 +74,8 @@ export const PaymentSetupApiAxiosParamCreator = function (configuration?: Config
|
|
|
73
74
|
};
|
|
74
75
|
},
|
|
75
76
|
/**
|
|
76
|
-
*
|
|
77
|
+
* This initiates an account within the configured payment service provider, whichgenerates a secret token, allowing the user to add their payment information.
|
|
78
|
+
* @summary Initiate a payment setup
|
|
77
79
|
* @param {object} body
|
|
78
80
|
* @param {string} [authorization] Bearer Token
|
|
79
81
|
* @param {*} [options] Override http request option.
|
|
@@ -129,7 +131,8 @@ export const PaymentSetupApiFp = function(configuration?: Configuration) {
|
|
|
129
131
|
const localVarAxiosParamCreator = PaymentSetupApiAxiosParamCreator(configuration)
|
|
130
132
|
return {
|
|
131
133
|
/**
|
|
132
|
-
*
|
|
134
|
+
* This endpoint is used to save user-provided payment information. The service will send a request to the configured PSP to securely store the payment data.
|
|
135
|
+
* @summary Complete a payment setup
|
|
133
136
|
* @param {object} body
|
|
134
137
|
* @param {string} [authorization] Bearer Token
|
|
135
138
|
* @param {*} [options] Override http request option.
|
|
@@ -140,7 +143,8 @@ export const PaymentSetupApiFp = function(configuration?: Configuration) {
|
|
|
140
143
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
141
144
|
},
|
|
142
145
|
/**
|
|
143
|
-
*
|
|
146
|
+
* This initiates an account within the configured payment service provider, whichgenerates a secret token, allowing the user to add their payment information.
|
|
147
|
+
* @summary Initiate a payment setup
|
|
144
148
|
* @param {object} body
|
|
145
149
|
* @param {string} [authorization] Bearer Token
|
|
146
150
|
* @param {*} [options] Override http request option.
|
|
@@ -161,7 +165,8 @@ export const PaymentSetupApiFactory = function (configuration?: Configuration, b
|
|
|
161
165
|
const localVarFp = PaymentSetupApiFp(configuration)
|
|
162
166
|
return {
|
|
163
167
|
/**
|
|
164
|
-
*
|
|
168
|
+
* This endpoint is used to save user-provided payment information. The service will send a request to the configured PSP to securely store the payment data.
|
|
169
|
+
* @summary Complete a payment setup
|
|
165
170
|
* @param {object} body
|
|
166
171
|
* @param {string} [authorization] Bearer Token
|
|
167
172
|
* @param {*} [options] Override http request option.
|
|
@@ -171,7 +176,8 @@ export const PaymentSetupApiFactory = function (configuration?: Configuration, b
|
|
|
171
176
|
return localVarFp.completePaymentSetup(body, authorization, options).then((request) => request(axios, basePath));
|
|
172
177
|
},
|
|
173
178
|
/**
|
|
174
|
-
*
|
|
179
|
+
* This initiates an account within the configured payment service provider, whichgenerates a secret token, allowing the user to add their payment information.
|
|
180
|
+
* @summary Initiate a payment setup
|
|
175
181
|
* @param {object} body
|
|
176
182
|
* @param {string} [authorization] Bearer Token
|
|
177
183
|
* @param {*} [options] Override http request option.
|
|
@@ -233,7 +239,8 @@ export interface PaymentSetupApiInitiatePaymentSetupRequest {
|
|
|
233
239
|
*/
|
|
234
240
|
export class PaymentSetupApi extends BaseAPI {
|
|
235
241
|
/**
|
|
236
|
-
*
|
|
242
|
+
* This endpoint is used to save user-provided payment information. The service will send a request to the configured PSP to securely store the payment data.
|
|
243
|
+
* @summary Complete a payment setup
|
|
237
244
|
* @param {PaymentSetupApiCompletePaymentSetupRequest} requestParameters Request parameters.
|
|
238
245
|
* @param {*} [options] Override http request option.
|
|
239
246
|
* @throws {RequiredError}
|
|
@@ -244,7 +251,8 @@ export class PaymentSetupApi extends BaseAPI {
|
|
|
244
251
|
}
|
|
245
252
|
|
|
246
253
|
/**
|
|
247
|
-
*
|
|
254
|
+
* This initiates an account within the configured payment service provider, whichgenerates a secret token, allowing the user to add their payment information.
|
|
255
|
+
* @summary Initiate a payment setup
|
|
248
256
|
* @param {PaymentSetupApiInitiatePaymentSetupRequest} requestParameters Request parameters.
|
|
249
257
|
* @param {*} [options] Override http request option.
|
|
250
258
|
* @throws {RequiredError}
|