@emilgroup/payment-sdk 1.4.1-beta.8 → 1.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +55 -5
- package/README.md +2 -2
- package/api/bank-accounts-api.ts +508 -88
- package/api/bank-transaction-api.ts +95 -115
- package/api/{default-api.ts → health-check-api.ts} +22 -18
- package/api/payment-methods-api.ts +83 -256
- package/api/payment-reminders-api.ts +71 -105
- package/api/payment-setup-api.ts +53 -37
- package/api/payments-api.ts +80 -137
- package/api/refunds-api.ts +78 -112
- package/api/tenant-bank-account-api.ts +99 -101
- package/api/webhooks-api.ts +17 -13
- package/api.ts +3 -3
- package/base.ts +22 -10
- package/common.ts +2 -2
- package/configuration.ts +1 -1
- package/dist/api/bank-accounts-api.d.ts +298 -71
- package/dist/api/bank-accounts-api.js +432 -62
- package/dist/api/bank-transaction-api.d.ts +83 -98
- package/dist/api/bank-transaction-api.js +63 -74
- package/dist/api/health-check-api.d.ts +70 -0
- package/dist/api/{default-api.js → health-check-api.js} +31 -27
- package/dist/api/payment-methods-api.d.ts +66 -162
- package/dist/api/payment-methods-api.js +60 -190
- package/dist/api/payment-reminders-api.d.ts +66 -89
- package/dist/api/payment-reminders-api.js +44 -62
- package/dist/api/payment-setup-api.d.ts +39 -27
- package/dist/api/payment-setup-api.js +41 -33
- package/dist/api/payments-api.d.ts +70 -103
- package/dist/api/payments-api.js +55 -85
- package/dist/api/refunds-api.d.ts +68 -83
- package/dist/api/refunds-api.js +58 -68
- package/dist/api/tenant-bank-account-api.d.ts +93 -88
- package/dist/api/tenant-bank-account-api.js +71 -63
- package/dist/api/webhooks-api.d.ts +17 -13
- package/dist/api/webhooks-api.js +15 -11
- package/dist/api.d.ts +2 -2
- package/dist/api.js +2 -2
- package/dist/base.d.ts +6 -3
- package/dist/base.js +31 -22
- package/dist/common.d.ts +2 -2
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/dist/models/bank-account-class-without-expand-properties.d.ts +84 -0
- package/dist/models/{bank-transaction-response-class.js → bank-account-class-without-expand-properties.js} +1 -1
- package/dist/models/bank-account-class.d.ts +91 -0
- package/dist/models/{transaction-class.js → bank-account-class.js} +1 -1
- package/dist/models/bank-transaction-class-without-expand-properties.d.ts +126 -0
- package/dist/models/{get-request-dto.js → bank-transaction-class-without-expand-properties.js} +1 -1
- package/dist/models/{bank-transaction-response-class.d.ts → bank-transaction-class.d.ts} +41 -29
- package/dist/models/{tenant-bank-account-response-class.js → bank-transaction-class.js} +1 -1
- package/dist/models/billing-profile-dto.d.ts +38 -0
- package/dist/models/billing-profile-dto.js +15 -0
- package/dist/models/billing-profile-limited-response-dto.d.ts +54 -0
- package/dist/models/billing-profile-limited-response-dto.js +15 -0
- package/dist/models/complete-braintree-payment-setup-request-dto.d.ts +48 -0
- package/dist/models/complete-braintree-payment-setup-request-dto.js +15 -0
- package/dist/models/complete-payment-setup-request-dto.d.ts +32 -0
- package/dist/models/complete-payment-setup-request-dto.js +15 -0
- package/dist/models/complete-payment-setup-response-class.d.ts +25 -0
- package/dist/models/complete-payment-setup-response-class.js +15 -0
- package/dist/models/complete-stripe-payment-setup-request-dto.d.ts +77 -0
- package/dist/models/complete-stripe-payment-setup-request-dto.js +32 -0
- package/dist/models/create-bank-account-request-dto.d.ts +42 -0
- package/dist/models/create-bank-account-request-dto.js +15 -0
- package/dist/models/create-bank-account-response-class.d.ts +25 -0
- package/dist/models/create-bank-account-response-class.js +15 -0
- package/dist/models/create-payment-method-response-class.d.ts +25 -0
- package/dist/models/create-payment-method-response-class.js +15 -0
- package/dist/models/create-payment-reminder-request-dto.d.ts +1 -1
- package/dist/models/create-payment-reminder-request-dto.js +1 -1
- package/dist/models/create-payment-reminder-response-class.d.ts +25 -0
- package/dist/models/create-payment-reminder-response-class.js +15 -0
- package/dist/models/create-payment-request-dto.d.ts +4 -4
- package/dist/models/create-payment-request-dto.js +1 -1
- package/dist/models/create-payment-response-class.d.ts +25 -0
- package/dist/models/create-payment-response-class.js +15 -0
- package/dist/models/create-psp-payment-method-request-dto.d.ts +61 -0
- package/dist/models/create-psp-payment-method-request-dto.js +32 -0
- package/dist/models/create-refund-request-dto.d.ts +1 -1
- package/dist/models/create-refund-request-dto.js +1 -1
- package/dist/models/create-refund-response-class.d.ts +1 -1
- package/dist/models/create-refund-response-class.js +1 -1
- package/dist/models/create-tenant-bank-account-request-dto.d.ts +1 -1
- package/dist/models/create-tenant-bank-account-request-dto.js +1 -1
- package/dist/models/create-tenant-bank-account-response-class.d.ts +25 -0
- package/dist/models/create-tenant-bank-account-response-class.js +15 -0
- package/dist/models/deactivate-payment-reminder-request-dto.d.ts +1 -1
- package/dist/models/deactivate-payment-reminder-request-dto.js +1 -1
- package/dist/models/deactivate-payment-reminder-response-class.d.ts +25 -0
- package/dist/models/deactivate-payment-reminder-response-class.js +15 -0
- package/dist/models/deactivated-payment-reminder-class.d.ts +102 -0
- package/dist/models/deactivated-payment-reminder-class.js +15 -0
- package/dist/models/get-bank-account-response-class.d.ts +25 -0
- package/dist/models/get-bank-account-response-class.js +15 -0
- package/dist/models/get-bank-transactions-response-class.d.ts +4 -4
- package/dist/models/get-bank-transactions-response-class.js +1 -1
- package/dist/models/get-payment-method-response-class.d.ts +25 -0
- package/dist/models/get-payment-method-response-class.js +15 -0
- package/dist/models/get-payment-reminder-response-class.d.ts +25 -0
- package/dist/models/get-payment-reminder-response-class.js +15 -0
- package/dist/models/get-payment-response-class.d.ts +25 -0
- package/dist/models/get-payment-response-class.js +15 -0
- package/dist/models/get-refund-response-class.d.ts +1 -1
- package/dist/models/get-refund-response-class.js +1 -1
- package/dist/models/get-tenant-bank-account-response-class.d.ts +5 -5
- package/dist/models/get-tenant-bank-account-response-class.js +1 -1
- package/dist/models/import-bank-transactions-response-class.d.ts +25 -0
- package/dist/models/import-bank-transactions-response-class.js +15 -0
- package/dist/models/index.d.ts +54 -4
- package/dist/models/index.js +54 -4
- package/dist/models/initiate-braintree-payment-setup-request-dto.d.ts +30 -0
- package/dist/models/initiate-braintree-payment-setup-request-dto.js +15 -0
- package/dist/models/initiate-braintree-payment-setup-response-class.d.ts +24 -0
- package/dist/models/initiate-braintree-payment-setup-response-class.js +15 -0
- package/dist/models/initiate-payment-setup-request-dto.d.ts +44 -0
- package/dist/models/initiate-payment-setup-request-dto.js +15 -0
- package/dist/models/initiate-payment-setup-response-class.d.ts +32 -0
- package/dist/models/initiate-payment-setup-response-class.js +15 -0
- package/dist/models/initiate-stripe-payment-setup-request-dto.d.ts +30 -0
- package/dist/models/initiate-stripe-payment-setup-request-dto.js +15 -0
- package/dist/models/initiate-stripe-payment-setup-response-class.d.ts +30 -0
- package/dist/models/initiate-stripe-payment-setup-response-class.js +15 -0
- package/dist/models/inline-response200.d.ts +1 -1
- package/dist/models/inline-response200.js +1 -1
- package/dist/models/inline-response503.d.ts +1 -1
- package/dist/models/inline-response503.js +1 -1
- package/dist/models/link-bank-transaction-request-dto-rest.d.ts +1 -1
- package/dist/models/link-bank-transaction-request-dto-rest.js +1 -1
- package/dist/models/link-bank-transactions-response-class.d.ts +25 -0
- package/dist/models/link-bank-transactions-response-class.js +15 -0
- package/dist/models/list-bank-accounts-response-class.d.ts +31 -0
- package/dist/models/list-bank-accounts-response-class.js +15 -0
- package/dist/models/list-bank-transactions-response-class.d.ts +6 -6
- package/dist/models/list-bank-transactions-response-class.js +1 -1
- package/dist/models/list-payment-methods-response-class.d.ts +31 -0
- package/dist/models/list-payment-methods-response-class.js +15 -0
- package/dist/models/list-payment-reminders-response-class.d.ts +31 -0
- package/dist/models/list-payment-reminders-response-class.js +15 -0
- package/dist/models/list-payments-response-class.d.ts +31 -0
- package/dist/models/list-payments-response-class.js +15 -0
- package/dist/models/list-refunds-response-class.d.ts +3 -3
- package/dist/models/list-refunds-response-class.js +1 -1
- package/dist/models/list-tenant-bank-account-response-class.d.ts +31 -0
- package/dist/models/list-tenant-bank-account-response-class.js +15 -0
- package/dist/models/payment-class-without-expand-properties.d.ts +108 -0
- package/dist/models/payment-class-without-expand-properties.js +15 -0
- package/dist/models/payment-class.d.ts +115 -0
- package/dist/models/payment-class.js +15 -0
- package/dist/models/payment-method-class.d.ts +78 -0
- package/dist/models/payment-method-class.js +15 -0
- package/dist/models/payment-reminder-class.d.ts +102 -0
- package/dist/models/payment-reminder-class.js +15 -0
- package/dist/models/primary-bank-account-response-class.d.ts +54 -0
- package/dist/models/primary-bank-account-response-class.js +15 -0
- package/dist/models/refund-class.d.ts +18 -4
- package/dist/models/refund-class.js +3 -2
- package/dist/models/refund-item-class.d.ts +114 -0
- package/dist/models/refund-item-class.js +15 -0
- package/dist/models/sepa-direct-dto.d.ts +24 -0
- package/dist/models/sepa-direct-dto.js +15 -0
- package/dist/models/set-primary-bank-account-request-dto-rest.d.ts +24 -0
- package/dist/models/set-primary-bank-account-request-dto-rest.js +15 -0
- package/dist/models/shared-transaction-class.d.ts +72 -0
- package/dist/models/shared-transaction-class.js +15 -0
- package/dist/models/symphony-profile-limited-response-dto.d.ts +42 -0
- package/dist/models/symphony-profile-limited-response-dto.js +15 -0
- package/dist/models/{tenant-bank-account-response-class.d.ts → tenant-bank-account-class-without-expand-properties.d.ts} +23 -11
- package/dist/models/tenant-bank-account-class-without-expand-properties.js +15 -0
- package/dist/models/tenant-bank-account-class.d.ts +85 -0
- package/dist/models/tenant-bank-account-class.js +15 -0
- package/dist/models/unlink-bank-transaction-request-dto-rest.d.ts +2 -2
- package/dist/models/unlink-bank-transaction-request-dto-rest.js +1 -1
- package/dist/models/unlink-bank-transactions-response-class.d.ts +25 -0
- package/dist/models/unlink-bank-transactions-response-class.js +15 -0
- package/dist/models/unlinked-bank-transaction-response-class.d.ts +108 -0
- package/dist/models/unlinked-bank-transaction-response-class.js +15 -0
- package/dist/models/update-bank-account-request-dto-rest.d.ts +30 -0
- package/dist/models/update-bank-account-request-dto-rest.js +15 -0
- package/dist/models/update-bank-account-request-dto.d.ts +36 -0
- package/dist/models/update-bank-account-request-dto.js +15 -0
- package/dist/models/update-bank-account-response-class.d.ts +25 -0
- package/dist/models/update-bank-account-response-class.js +15 -0
- package/dist/models/update-tenant-bank-account-response-class.d.ts +25 -0
- package/dist/models/update-tenant-bank-account-response-class.js +15 -0
- package/dist/models/update-tenant-bank-account-rest-request-dto.d.ts +1 -1
- package/dist/models/update-tenant-bank-account-rest-request-dto.js +1 -1
- package/dist/models/validate-pspconfig-request-dto.d.ts +9 -2
- package/dist/models/validate-pspconfig-request-dto.js +8 -1
- package/index.ts +1 -1
- package/models/bank-account-class-without-expand-properties.ts +90 -0
- package/models/bank-account-class.ts +97 -0
- package/models/bank-transaction-class-without-expand-properties.ts +132 -0
- package/models/{bank-transaction-response-class.ts → bank-transaction-class.ts} +41 -29
- package/models/billing-profile-dto.ts +44 -0
- package/models/billing-profile-limited-response-dto.ts +60 -0
- package/models/complete-braintree-payment-setup-request-dto.ts +54 -0
- package/models/complete-payment-setup-request-dto.ts +38 -0
- package/models/complete-payment-setup-response-class.ts +31 -0
- package/models/complete-stripe-payment-setup-request-dto.ts +86 -0
- package/models/create-bank-account-request-dto.ts +48 -0
- package/models/create-bank-account-response-class.ts +31 -0
- package/models/create-payment-method-response-class.ts +31 -0
- package/models/create-payment-reminder-request-dto.ts +1 -1
- package/models/create-payment-reminder-response-class.ts +31 -0
- package/models/create-payment-request-dto.ts +4 -4
- package/models/create-payment-response-class.ts +31 -0
- package/models/create-psp-payment-method-request-dto.ts +70 -0
- package/models/create-refund-request-dto.ts +1 -1
- package/models/create-refund-response-class.ts +1 -1
- package/models/create-tenant-bank-account-request-dto.ts +1 -1
- package/models/create-tenant-bank-account-response-class.ts +31 -0
- package/models/deactivate-payment-reminder-request-dto.ts +1 -1
- package/models/deactivate-payment-reminder-response-class.ts +31 -0
- package/models/deactivated-payment-reminder-class.ts +108 -0
- package/models/get-bank-account-response-class.ts +31 -0
- package/models/get-bank-transactions-response-class.ts +4 -4
- package/models/get-payment-method-response-class.ts +31 -0
- package/models/get-payment-reminder-response-class.ts +31 -0
- package/models/get-payment-response-class.ts +31 -0
- package/models/get-refund-response-class.ts +1 -1
- package/models/get-tenant-bank-account-response-class.ts +5 -5
- package/models/import-bank-transactions-response-class.ts +31 -0
- package/models/index.ts +54 -4
- package/models/initiate-braintree-payment-setup-request-dto.ts +36 -0
- package/models/initiate-braintree-payment-setup-response-class.ts +30 -0
- package/models/initiate-payment-setup-request-dto.ts +50 -0
- package/models/initiate-payment-setup-response-class.ts +38 -0
- package/models/initiate-stripe-payment-setup-request-dto.ts +36 -0
- package/models/initiate-stripe-payment-setup-response-class.ts +36 -0
- package/models/inline-response200.ts +1 -1
- package/models/inline-response503.ts +1 -1
- package/models/link-bank-transaction-request-dto-rest.ts +1 -1
- package/models/link-bank-transactions-response-class.ts +31 -0
- package/models/list-bank-accounts-response-class.ts +37 -0
- package/models/list-bank-transactions-response-class.ts +6 -6
- package/models/list-payment-methods-response-class.ts +37 -0
- package/models/list-payment-reminders-response-class.ts +37 -0
- package/models/list-payments-response-class.ts +37 -0
- package/models/list-refunds-response-class.ts +3 -3
- package/models/list-tenant-bank-account-response-class.ts +37 -0
- package/models/payment-class-without-expand-properties.ts +114 -0
- package/models/payment-class.ts +121 -0
- package/models/payment-method-class.ts +84 -0
- package/models/payment-reminder-class.ts +108 -0
- package/models/primary-bank-account-response-class.ts +60 -0
- package/models/refund-class.ts +19 -5
- package/models/refund-item-class.ts +120 -0
- package/models/sepa-direct-dto.ts +30 -0
- package/models/set-primary-bank-account-request-dto-rest.ts +30 -0
- package/models/shared-transaction-class.ts +78 -0
- package/models/symphony-profile-limited-response-dto.ts +48 -0
- package/models/{tenant-bank-account-response-class.ts → tenant-bank-account-class-without-expand-properties.ts} +23 -11
- package/models/tenant-bank-account-class.ts +91 -0
- package/models/unlink-bank-transaction-request-dto-rest.ts +2 -2
- package/models/unlink-bank-transactions-response-class.ts +31 -0
- package/models/unlinked-bank-transaction-response-class.ts +114 -0
- package/models/update-bank-account-request-dto-rest.ts +36 -0
- package/models/update-bank-account-request-dto.ts +42 -0
- package/models/update-bank-account-response-class.ts +31 -0
- package/models/update-tenant-bank-account-response-class.ts +31 -0
- package/models/update-tenant-bank-account-rest-request-dto.ts +1 -1
- package/models/validate-pspconfig-request-dto.ts +12 -2
- package/package.json +1 -1
- package/dist/api/default-api.d.ts +0 -66
- package/dist/models/get-request-dto.d.ts +0 -30
- package/dist/models/transaction-class.d.ts +0 -54
- package/models/get-request-dto.ts +0 -36
- package/models/transaction-class.ts +0 -60
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Emil Payment Service
|
|
3
|
-
* This service directly communicates with the various Payment Service Providers (PSPs)
|
|
3
|
+
* This service directly communicates with the various Payment Service Providers (PSPs) in order to charge or refund customers. This service will automatically connect to the PSP linked in your admin configuration; meaning if you configured Stripe, it will automatically create a payment on Stripe when you create it in Emil.
|
|
4
4
|
*
|
|
5
5
|
* The version of the OpenAPI document: 1.0
|
|
6
6
|
* Contact: kontakt@emil.de
|
|
@@ -12,6 +12,10 @@
|
|
|
12
12
|
import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
13
13
|
import { Configuration } from '../configuration';
|
|
14
14
|
import { RequestArgs, BaseAPI } from '../base';
|
|
15
|
+
import { CreatePaymentMethodResponseClass } from '../models';
|
|
16
|
+
import { CreatePspPaymentMethodRequestDto } from '../models';
|
|
17
|
+
import { GetPaymentMethodResponseClass } from '../models';
|
|
18
|
+
import { ListPaymentMethodsResponseClass } from '../models';
|
|
15
19
|
/**
|
|
16
20
|
* PaymentMethodsApi - axios parameter creator
|
|
17
21
|
* @export
|
|
@@ -19,48 +23,34 @@ import { RequestArgs, BaseAPI } from '../base';
|
|
|
19
23
|
export declare const PaymentMethodsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
20
24
|
/**
|
|
21
25
|
* This will create payment method in the database as well as in the PSP. The newly created payment method will be set as default payment method will be used by the customer to pay or receive a refund.
|
|
22
|
-
* @summary Create the payment
|
|
23
|
-
* @param {
|
|
26
|
+
* @summary Create the payment method
|
|
27
|
+
* @param {CreatePspPaymentMethodRequestDto} createPspPaymentMethodRequestDto
|
|
24
28
|
* @param {string} [authorization] Bearer Token
|
|
25
29
|
* @param {*} [options] Override http request option.
|
|
26
30
|
* @throws {RequiredError}
|
|
27
31
|
*/
|
|
28
|
-
createPaymentMethod: (
|
|
32
|
+
createPaymentMethod: (createPspPaymentMethodRequestDto: CreatePspPaymentMethodRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
29
33
|
/**
|
|
30
|
-
*
|
|
31
|
-
* @summary
|
|
32
|
-
* @param {
|
|
34
|
+
* Retrieves the details of the payment method that was previously created. Supply the unique payment method code that was returned when you created it and Emil Api will return the corresponding payment method information.
|
|
35
|
+
* @summary Retrieve the payment method
|
|
36
|
+
* @param {string} code
|
|
33
37
|
* @param {string} [authorization] Bearer Token
|
|
34
38
|
* @param {*} [options] Override http request option.
|
|
35
39
|
* @throws {RequiredError}
|
|
36
40
|
*/
|
|
37
|
-
|
|
41
|
+
getPaymentMethod: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
38
42
|
/**
|
|
39
|
-
*
|
|
40
|
-
* @summary Retrieve a payment method
|
|
41
|
-
* @param {string} code Unique identifier for the object.
|
|
42
|
-
* @param {string} expand Fields to expand response by
|
|
43
|
-
* @param {string} expand2 Fields to expand response by
|
|
44
|
-
* @param {string} [authorization] Bearer Token
|
|
45
|
-
* @param {*} [options] Override http request option.
|
|
46
|
-
* @throws {RequiredError}
|
|
47
|
-
*/
|
|
48
|
-
getPaymentMethod: (code: string, expand: string, expand2: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
49
|
-
/**
|
|
50
|
-
* Returns a list of payment methods you’ve previously created. The payment methods are returned in sorted order, with the oldest payment appearing first. For more information about pagination, read the Pagination documentation.
|
|
43
|
+
* Returns a list of payment methods you have previously created. The payment methods are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
51
44
|
* @summary List payment methods
|
|
52
45
|
* @param {string} [authorization] Bearer Token
|
|
53
|
-
* @param {
|
|
54
|
-
* @param {
|
|
55
|
-
* @param {
|
|
56
|
-
* @param {
|
|
57
|
-
* @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.
|
|
58
|
-
* @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.
|
|
59
|
-
* @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.
|
|
46
|
+
* @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</i>
|
|
47
|
+
* @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</i>
|
|
48
|
+
* @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</i>
|
|
49
|
+
* @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>
|
|
60
50
|
* @param {*} [options] Override http request option.
|
|
61
51
|
* @throws {RequiredError}
|
|
62
52
|
*/
|
|
63
|
-
listPaymentMethods: (authorization?: string,
|
|
53
|
+
listPaymentMethods: (authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
64
54
|
};
|
|
65
55
|
/**
|
|
66
56
|
* PaymentMethodsApi - functional programming interface
|
|
@@ -69,48 +59,34 @@ export declare const PaymentMethodsApiAxiosParamCreator: (configuration?: Config
|
|
|
69
59
|
export declare const PaymentMethodsApiFp: (configuration?: Configuration) => {
|
|
70
60
|
/**
|
|
71
61
|
* This will create payment method in the database as well as in the PSP. The newly created payment method will be set as default payment method will be used by the customer to pay or receive a refund.
|
|
72
|
-
* @summary Create the payment
|
|
73
|
-
* @param {
|
|
74
|
-
* @param {string} [authorization] Bearer Token
|
|
75
|
-
* @param {*} [options] Override http request option.
|
|
76
|
-
* @throws {RequiredError}
|
|
77
|
-
*/
|
|
78
|
-
createPaymentMethod(body: object, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
79
|
-
/**
|
|
80
|
-
* Permanently deletes a payment method. Supply the unique payment method id that was returned when you created the payment method and this will delete it. It will also delete it on the corresponding payment service provider.
|
|
81
|
-
* @summary Delete a payment method
|
|
82
|
-
* @param {number} id Unique identifier for payment method
|
|
62
|
+
* @summary Create the payment method
|
|
63
|
+
* @param {CreatePspPaymentMethodRequestDto} createPspPaymentMethodRequestDto
|
|
83
64
|
* @param {string} [authorization] Bearer Token
|
|
84
65
|
* @param {*} [options] Override http request option.
|
|
85
66
|
* @throws {RequiredError}
|
|
86
67
|
*/
|
|
87
|
-
|
|
68
|
+
createPaymentMethod(createPspPaymentMethodRequestDto: CreatePspPaymentMethodRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePaymentMethodResponseClass>>;
|
|
88
69
|
/**
|
|
89
|
-
* Retrieves the details of
|
|
90
|
-
* @summary Retrieve
|
|
91
|
-
* @param {string} code
|
|
92
|
-
* @param {string} expand Fields to expand response by
|
|
93
|
-
* @param {string} expand2 Fields to expand response by
|
|
70
|
+
* Retrieves the details of the payment method that was previously created. Supply the unique payment method code that was returned when you created it and Emil Api will return the corresponding payment method information.
|
|
71
|
+
* @summary Retrieve the payment method
|
|
72
|
+
* @param {string} code
|
|
94
73
|
* @param {string} [authorization] Bearer Token
|
|
95
74
|
* @param {*} [options] Override http request option.
|
|
96
75
|
* @throws {RequiredError}
|
|
97
76
|
*/
|
|
98
|
-
getPaymentMethod(code: string,
|
|
77
|
+
getPaymentMethod(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPaymentMethodResponseClass>>;
|
|
99
78
|
/**
|
|
100
|
-
* Returns a list of payment methods you
|
|
79
|
+
* Returns a list of payment methods you have previously created. The payment methods are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
101
80
|
* @summary List payment methods
|
|
102
81
|
* @param {string} [authorization] Bearer Token
|
|
103
|
-
* @param {
|
|
104
|
-
* @param {
|
|
105
|
-
* @param {
|
|
106
|
-
* @param {
|
|
107
|
-
* @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.
|
|
108
|
-
* @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.
|
|
109
|
-
* @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.
|
|
82
|
+
* @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</i>
|
|
83
|
+
* @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</i>
|
|
84
|
+
* @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</i>
|
|
85
|
+
* @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>
|
|
110
86
|
* @param {*} [options] Override http request option.
|
|
111
87
|
* @throws {RequiredError}
|
|
112
88
|
*/
|
|
113
|
-
listPaymentMethods(authorization?: string,
|
|
89
|
+
listPaymentMethods(authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPaymentMethodsResponseClass>>;
|
|
114
90
|
};
|
|
115
91
|
/**
|
|
116
92
|
* PaymentMethodsApi - factory interface
|
|
@@ -119,48 +95,34 @@ export declare const PaymentMethodsApiFp: (configuration?: Configuration) => {
|
|
|
119
95
|
export declare const PaymentMethodsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
120
96
|
/**
|
|
121
97
|
* This will create payment method in the database as well as in the PSP. The newly created payment method will be set as default payment method will be used by the customer to pay or receive a refund.
|
|
122
|
-
* @summary Create the payment
|
|
123
|
-
* @param {
|
|
98
|
+
* @summary Create the payment method
|
|
99
|
+
* @param {CreatePspPaymentMethodRequestDto} createPspPaymentMethodRequestDto
|
|
124
100
|
* @param {string} [authorization] Bearer Token
|
|
125
101
|
* @param {*} [options] Override http request option.
|
|
126
102
|
* @throws {RequiredError}
|
|
127
103
|
*/
|
|
128
|
-
createPaymentMethod(
|
|
104
|
+
createPaymentMethod(createPspPaymentMethodRequestDto: CreatePspPaymentMethodRequestDto, authorization?: string, options?: any): AxiosPromise<CreatePaymentMethodResponseClass>;
|
|
129
105
|
/**
|
|
130
|
-
*
|
|
131
|
-
* @summary
|
|
132
|
-
* @param {
|
|
106
|
+
* Retrieves the details of the payment method that was previously created. Supply the unique payment method code that was returned when you created it and Emil Api will return the corresponding payment method information.
|
|
107
|
+
* @summary Retrieve the payment method
|
|
108
|
+
* @param {string} code
|
|
133
109
|
* @param {string} [authorization] Bearer Token
|
|
134
110
|
* @param {*} [options] Override http request option.
|
|
135
111
|
* @throws {RequiredError}
|
|
136
112
|
*/
|
|
137
|
-
|
|
113
|
+
getPaymentMethod(code: string, authorization?: string, options?: any): AxiosPromise<GetPaymentMethodResponseClass>;
|
|
138
114
|
/**
|
|
139
|
-
*
|
|
140
|
-
* @summary Retrieve a payment method
|
|
141
|
-
* @param {string} code Unique identifier for the object.
|
|
142
|
-
* @param {string} expand Fields to expand response by
|
|
143
|
-
* @param {string} expand2 Fields to expand response by
|
|
144
|
-
* @param {string} [authorization] Bearer Token
|
|
145
|
-
* @param {*} [options] Override http request option.
|
|
146
|
-
* @throws {RequiredError}
|
|
147
|
-
*/
|
|
148
|
-
getPaymentMethod(code: string, expand: string, expand2: string, authorization?: string, options?: any): AxiosPromise<void>;
|
|
149
|
-
/**
|
|
150
|
-
* Returns a list of payment methods you’ve previously created. The payment methods are returned in sorted order, with the oldest payment appearing first. For more information about pagination, read the Pagination documentation.
|
|
115
|
+
* Returns a list of payment methods you have previously created. The payment methods are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
151
116
|
* @summary List payment methods
|
|
152
117
|
* @param {string} [authorization] Bearer Token
|
|
153
|
-
* @param {
|
|
154
|
-
* @param {
|
|
155
|
-
* @param {
|
|
156
|
-
* @param {
|
|
157
|
-
* @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.
|
|
158
|
-
* @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.
|
|
159
|
-
* @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.
|
|
118
|
+
* @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</i>
|
|
119
|
+
* @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</i>
|
|
120
|
+
* @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</i>
|
|
121
|
+
* @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>
|
|
160
122
|
* @param {*} [options] Override http request option.
|
|
161
123
|
* @throws {RequiredError}
|
|
162
124
|
*/
|
|
163
|
-
listPaymentMethods(authorization?: string,
|
|
125
|
+
listPaymentMethods(authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListPaymentMethodsResponseClass>;
|
|
164
126
|
};
|
|
165
127
|
/**
|
|
166
128
|
* Request parameters for createPaymentMethod operation in PaymentMethodsApi.
|
|
@@ -170,10 +132,10 @@ export declare const PaymentMethodsApiFactory: (configuration?: Configuration, b
|
|
|
170
132
|
export interface PaymentMethodsApiCreatePaymentMethodRequest {
|
|
171
133
|
/**
|
|
172
134
|
*
|
|
173
|
-
* @type {
|
|
135
|
+
* @type {CreatePspPaymentMethodRequestDto}
|
|
174
136
|
* @memberof PaymentMethodsApiCreatePaymentMethod
|
|
175
137
|
*/
|
|
176
|
-
readonly
|
|
138
|
+
readonly createPspPaymentMethodRequestDto: CreatePspPaymentMethodRequestDto;
|
|
177
139
|
/**
|
|
178
140
|
* Bearer Token
|
|
179
141
|
* @type {string}
|
|
@@ -181,25 +143,6 @@ export interface PaymentMethodsApiCreatePaymentMethodRequest {
|
|
|
181
143
|
*/
|
|
182
144
|
readonly authorization?: string;
|
|
183
145
|
}
|
|
184
|
-
/**
|
|
185
|
-
* Request parameters for deletePaymentMethod operation in PaymentMethodsApi.
|
|
186
|
-
* @export
|
|
187
|
-
* @interface PaymentMethodsApiDeletePaymentMethodRequest
|
|
188
|
-
*/
|
|
189
|
-
export interface PaymentMethodsApiDeletePaymentMethodRequest {
|
|
190
|
-
/**
|
|
191
|
-
* Unique identifier for payment method
|
|
192
|
-
* @type {number}
|
|
193
|
-
* @memberof PaymentMethodsApiDeletePaymentMethod
|
|
194
|
-
*/
|
|
195
|
-
readonly id: number;
|
|
196
|
-
/**
|
|
197
|
-
* Bearer Token
|
|
198
|
-
* @type {string}
|
|
199
|
-
* @memberof PaymentMethodsApiDeletePaymentMethod
|
|
200
|
-
*/
|
|
201
|
-
readonly authorization?: string;
|
|
202
|
-
}
|
|
203
146
|
/**
|
|
204
147
|
* Request parameters for getPaymentMethod operation in PaymentMethodsApi.
|
|
205
148
|
* @export
|
|
@@ -207,23 +150,11 @@ export interface PaymentMethodsApiDeletePaymentMethodRequest {
|
|
|
207
150
|
*/
|
|
208
151
|
export interface PaymentMethodsApiGetPaymentMethodRequest {
|
|
209
152
|
/**
|
|
210
|
-
*
|
|
153
|
+
*
|
|
211
154
|
* @type {string}
|
|
212
155
|
* @memberof PaymentMethodsApiGetPaymentMethod
|
|
213
156
|
*/
|
|
214
157
|
readonly code: string;
|
|
215
|
-
/**
|
|
216
|
-
* Fields to expand response by
|
|
217
|
-
* @type {string}
|
|
218
|
-
* @memberof PaymentMethodsApiGetPaymentMethod
|
|
219
|
-
*/
|
|
220
|
-
readonly expand: string;
|
|
221
|
-
/**
|
|
222
|
-
* Fields to expand response by
|
|
223
|
-
* @type {string}
|
|
224
|
-
* @memberof PaymentMethodsApiGetPaymentMethod
|
|
225
|
-
*/
|
|
226
|
-
readonly expand2: string;
|
|
227
158
|
/**
|
|
228
159
|
* Bearer Token
|
|
229
160
|
* @type {string}
|
|
@@ -244,47 +175,29 @@ export interface PaymentMethodsApiListPaymentMethodsRequest {
|
|
|
244
175
|
*/
|
|
245
176
|
readonly authorization?: string;
|
|
246
177
|
/**
|
|
247
|
-
*
|
|
248
|
-
* @type {
|
|
249
|
-
* @memberof PaymentMethodsApiListPaymentMethods
|
|
250
|
-
*/
|
|
251
|
-
readonly pageSize?: any;
|
|
252
|
-
/**
|
|
253
|
-
* 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.
|
|
254
|
-
* @type {any}
|
|
255
|
-
* @memberof PaymentMethodsApiListPaymentMethods
|
|
256
|
-
*/
|
|
257
|
-
readonly pageToken?: any;
|
|
258
|
-
/**
|
|
259
|
-
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
260
|
-
* @type {any}
|
|
261
|
-
* @memberof PaymentMethodsApiListPaymentMethods
|
|
262
|
-
*/
|
|
263
|
-
readonly filter?: any;
|
|
264
|
-
/**
|
|
265
|
-
* Search the list by any field. For instance, if you want to search by code add code=xxx in order to fetch the result.
|
|
266
|
-
* @type {any}
|
|
178
|
+
* 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</i>
|
|
179
|
+
* @type {string}
|
|
267
180
|
* @memberof PaymentMethodsApiListPaymentMethods
|
|
268
181
|
*/
|
|
269
|
-
readonly
|
|
182
|
+
readonly filter?: string;
|
|
270
183
|
/**
|
|
271
|
-
*
|
|
272
|
-
* @type {
|
|
184
|
+
* 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</i>
|
|
185
|
+
* @type {string}
|
|
273
186
|
* @memberof PaymentMethodsApiListPaymentMethods
|
|
274
187
|
*/
|
|
275
|
-
readonly
|
|
188
|
+
readonly filters?: string;
|
|
276
189
|
/**
|
|
277
|
-
*
|
|
278
|
-
* @type {
|
|
190
|
+
* 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</i>
|
|
191
|
+
* @type {string}
|
|
279
192
|
* @memberof PaymentMethodsApiListPaymentMethods
|
|
280
193
|
*/
|
|
281
|
-
readonly
|
|
194
|
+
readonly order?: string;
|
|
282
195
|
/**
|
|
283
|
-
*
|
|
284
|
-
* @type {
|
|
196
|
+
* 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>
|
|
197
|
+
* @type {string}
|
|
285
198
|
* @memberof PaymentMethodsApiListPaymentMethods
|
|
286
199
|
*/
|
|
287
|
-
readonly
|
|
200
|
+
readonly expand?: string;
|
|
288
201
|
}
|
|
289
202
|
/**
|
|
290
203
|
* PaymentMethodsApi - object-oriented interface
|
|
@@ -295,38 +208,29 @@ export interface PaymentMethodsApiListPaymentMethodsRequest {
|
|
|
295
208
|
export declare class PaymentMethodsApi extends BaseAPI {
|
|
296
209
|
/**
|
|
297
210
|
* This will create payment method in the database as well as in the PSP. The newly created payment method will be set as default payment method will be used by the customer to pay or receive a refund.
|
|
298
|
-
* @summary Create the payment
|
|
211
|
+
* @summary Create the payment method
|
|
299
212
|
* @param {PaymentMethodsApiCreatePaymentMethodRequest} requestParameters Request parameters.
|
|
300
213
|
* @param {*} [options] Override http request option.
|
|
301
214
|
* @throws {RequiredError}
|
|
302
215
|
* @memberof PaymentMethodsApi
|
|
303
216
|
*/
|
|
304
|
-
createPaymentMethod(requestParameters: PaymentMethodsApiCreatePaymentMethodRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
305
|
-
/**
|
|
306
|
-
* Permanently deletes a payment method. Supply the unique payment method id that was returned when you created the payment method and this will delete it. It will also delete it on the corresponding payment service provider.
|
|
307
|
-
* @summary Delete a payment method
|
|
308
|
-
* @param {PaymentMethodsApiDeletePaymentMethodRequest} requestParameters Request parameters.
|
|
309
|
-
* @param {*} [options] Override http request option.
|
|
310
|
-
* @throws {RequiredError}
|
|
311
|
-
* @memberof PaymentMethodsApi
|
|
312
|
-
*/
|
|
313
|
-
deletePaymentMethod(requestParameters: PaymentMethodsApiDeletePaymentMethodRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
217
|
+
createPaymentMethod(requestParameters: PaymentMethodsApiCreatePaymentMethodRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePaymentMethodResponseClass, any>>;
|
|
314
218
|
/**
|
|
315
|
-
* Retrieves the details of
|
|
316
|
-
* @summary Retrieve
|
|
219
|
+
* Retrieves the details of the payment method that was previously created. Supply the unique payment method code that was returned when you created it and Emil Api will return the corresponding payment method information.
|
|
220
|
+
* @summary Retrieve the payment method
|
|
317
221
|
* @param {PaymentMethodsApiGetPaymentMethodRequest} requestParameters Request parameters.
|
|
318
222
|
* @param {*} [options] Override http request option.
|
|
319
223
|
* @throws {RequiredError}
|
|
320
224
|
* @memberof PaymentMethodsApi
|
|
321
225
|
*/
|
|
322
|
-
getPaymentMethod(requestParameters: PaymentMethodsApiGetPaymentMethodRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
226
|
+
getPaymentMethod(requestParameters: PaymentMethodsApiGetPaymentMethodRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPaymentMethodResponseClass, any>>;
|
|
323
227
|
/**
|
|
324
|
-
* Returns a list of payment methods you
|
|
228
|
+
* Returns a list of payment methods you have previously created. The payment methods are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
325
229
|
* @summary List payment methods
|
|
326
230
|
* @param {PaymentMethodsApiListPaymentMethodsRequest} requestParameters Request parameters.
|
|
327
231
|
* @param {*} [options] Override http request option.
|
|
328
232
|
* @throws {RequiredError}
|
|
329
233
|
* @memberof PaymentMethodsApi
|
|
330
234
|
*/
|
|
331
|
-
listPaymentMethods(requestParameters?: PaymentMethodsApiListPaymentMethodsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
235
|
+
listPaymentMethods(requestParameters?: PaymentMethodsApiListPaymentMethodsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListPaymentMethodsResponseClass, any>>;
|
|
332
236
|
}
|