@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
|
@@ -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
|
|
@@ -19,7 +19,7 @@ import { RequestArgs, BaseAPI } from '../base';
|
|
|
19
19
|
export declare const PaymentMethodsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
20
20
|
/**
|
|
21
21
|
* 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
|
|
22
|
+
* @summary Create the payment method
|
|
23
23
|
* @param {object} body
|
|
24
24
|
* @param {string} [authorization] Bearer Token
|
|
25
25
|
* @param {*} [options] Override http request option.
|
|
@@ -27,40 +27,26 @@ export declare const PaymentMethodsApiAxiosParamCreator: (configuration?: Config
|
|
|
27
27
|
*/
|
|
28
28
|
createPaymentMethod: (body: object, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
29
29
|
/**
|
|
30
|
-
*
|
|
31
|
-
* @summary
|
|
32
|
-
* @param {
|
|
30
|
+
* 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.
|
|
31
|
+
* @summary Retrieve the payment method
|
|
32
|
+
* @param {string} code
|
|
33
33
|
* @param {string} [authorization] Bearer Token
|
|
34
34
|
* @param {*} [options] Override http request option.
|
|
35
35
|
* @throws {RequiredError}
|
|
36
36
|
*/
|
|
37
|
-
|
|
37
|
+
getPaymentMethod: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
38
38
|
/**
|
|
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.
|
|
39
|
+
* 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
40
|
* @summary List payment methods
|
|
52
41
|
* @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.
|
|
42
|
+
* @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>
|
|
43
|
+
* @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>
|
|
44
|
+
* @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>
|
|
45
|
+
* @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
46
|
* @param {*} [options] Override http request option.
|
|
61
47
|
* @throws {RequiredError}
|
|
62
48
|
*/
|
|
63
|
-
listPaymentMethods: (authorization?: string,
|
|
49
|
+
listPaymentMethods: (authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
64
50
|
};
|
|
65
51
|
/**
|
|
66
52
|
* PaymentMethodsApi - functional programming interface
|
|
@@ -69,7 +55,7 @@ export declare const PaymentMethodsApiAxiosParamCreator: (configuration?: Config
|
|
|
69
55
|
export declare const PaymentMethodsApiFp: (configuration?: Configuration) => {
|
|
70
56
|
/**
|
|
71
57
|
* 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
|
|
58
|
+
* @summary Create the payment method
|
|
73
59
|
* @param {object} body
|
|
74
60
|
* @param {string} [authorization] Bearer Token
|
|
75
61
|
* @param {*} [options] Override http request option.
|
|
@@ -77,40 +63,26 @@ export declare const PaymentMethodsApiFp: (configuration?: Configuration) => {
|
|
|
77
63
|
*/
|
|
78
64
|
createPaymentMethod(body: object, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
79
65
|
/**
|
|
80
|
-
*
|
|
81
|
-
* @summary
|
|
82
|
-
* @param {
|
|
83
|
-
* @param {string} [authorization] Bearer Token
|
|
84
|
-
* @param {*} [options] Override http request option.
|
|
85
|
-
* @throws {RequiredError}
|
|
86
|
-
*/
|
|
87
|
-
deletePaymentMethod(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
88
|
-
/**
|
|
89
|
-
* Retrieves the details of a payment method that was previously created. Supply the unique payment method code that was returned when you created the payment method and Emil Api will return the corresponding payment method information.
|
|
90
|
-
* @summary Retrieve a payment method
|
|
91
|
-
* @param {string} code Unique identifier for the object.
|
|
92
|
-
* @param {string} expand Fields to expand response by
|
|
93
|
-
* @param {string} expand2 Fields to expand response by
|
|
66
|
+
* 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.
|
|
67
|
+
* @summary Retrieve the payment method
|
|
68
|
+
* @param {string} code
|
|
94
69
|
* @param {string} [authorization] Bearer Token
|
|
95
70
|
* @param {*} [options] Override http request option.
|
|
96
71
|
* @throws {RequiredError}
|
|
97
72
|
*/
|
|
98
|
-
getPaymentMethod(code: string,
|
|
73
|
+
getPaymentMethod(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
99
74
|
/**
|
|
100
|
-
* Returns a list of payment methods you
|
|
75
|
+
* 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
76
|
* @summary List payment methods
|
|
102
77
|
* @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.
|
|
78
|
+
* @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>
|
|
79
|
+
* @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>
|
|
80
|
+
* @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>
|
|
81
|
+
* @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
82
|
* @param {*} [options] Override http request option.
|
|
111
83
|
* @throws {RequiredError}
|
|
112
84
|
*/
|
|
113
|
-
listPaymentMethods(authorization?: string,
|
|
85
|
+
listPaymentMethods(authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
114
86
|
};
|
|
115
87
|
/**
|
|
116
88
|
* PaymentMethodsApi - factory interface
|
|
@@ -119,7 +91,7 @@ export declare const PaymentMethodsApiFp: (configuration?: Configuration) => {
|
|
|
119
91
|
export declare const PaymentMethodsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
120
92
|
/**
|
|
121
93
|
* 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
|
|
94
|
+
* @summary Create the payment method
|
|
123
95
|
* @param {object} body
|
|
124
96
|
* @param {string} [authorization] Bearer Token
|
|
125
97
|
* @param {*} [options] Override http request option.
|
|
@@ -127,40 +99,26 @@ export declare const PaymentMethodsApiFactory: (configuration?: Configuration, b
|
|
|
127
99
|
*/
|
|
128
100
|
createPaymentMethod(body: object, authorization?: string, options?: any): AxiosPromise<void>;
|
|
129
101
|
/**
|
|
130
|
-
*
|
|
131
|
-
* @summary
|
|
132
|
-
* @param {
|
|
102
|
+
* 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.
|
|
103
|
+
* @summary Retrieve the payment method
|
|
104
|
+
* @param {string} code
|
|
133
105
|
* @param {string} [authorization] Bearer Token
|
|
134
106
|
* @param {*} [options] Override http request option.
|
|
135
107
|
* @throws {RequiredError}
|
|
136
108
|
*/
|
|
137
|
-
|
|
109
|
+
getPaymentMethod(code: string, authorization?: string, options?: any): AxiosPromise<void>;
|
|
138
110
|
/**
|
|
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.
|
|
111
|
+
* 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
112
|
* @summary List payment methods
|
|
152
113
|
* @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.
|
|
114
|
+
* @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>
|
|
115
|
+
* @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>
|
|
116
|
+
* @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>
|
|
117
|
+
* @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
118
|
* @param {*} [options] Override http request option.
|
|
161
119
|
* @throws {RequiredError}
|
|
162
120
|
*/
|
|
163
|
-
listPaymentMethods(authorization?: string,
|
|
121
|
+
listPaymentMethods(authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: any): AxiosPromise<void>;
|
|
164
122
|
};
|
|
165
123
|
/**
|
|
166
124
|
* Request parameters for createPaymentMethod operation in PaymentMethodsApi.
|
|
@@ -181,25 +139,6 @@ export interface PaymentMethodsApiCreatePaymentMethodRequest {
|
|
|
181
139
|
*/
|
|
182
140
|
readonly authorization?: string;
|
|
183
141
|
}
|
|
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
142
|
/**
|
|
204
143
|
* Request parameters for getPaymentMethod operation in PaymentMethodsApi.
|
|
205
144
|
* @export
|
|
@@ -207,23 +146,11 @@ export interface PaymentMethodsApiDeletePaymentMethodRequest {
|
|
|
207
146
|
*/
|
|
208
147
|
export interface PaymentMethodsApiGetPaymentMethodRequest {
|
|
209
148
|
/**
|
|
210
|
-
*
|
|
149
|
+
*
|
|
211
150
|
* @type {string}
|
|
212
151
|
* @memberof PaymentMethodsApiGetPaymentMethod
|
|
213
152
|
*/
|
|
214
153
|
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
154
|
/**
|
|
228
155
|
* Bearer Token
|
|
229
156
|
* @type {string}
|
|
@@ -244,47 +171,29 @@ export interface PaymentMethodsApiListPaymentMethodsRequest {
|
|
|
244
171
|
*/
|
|
245
172
|
readonly authorization?: string;
|
|
246
173
|
/**
|
|
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}
|
|
174
|
+
* 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>
|
|
175
|
+
* @type {string}
|
|
267
176
|
* @memberof PaymentMethodsApiListPaymentMethods
|
|
268
177
|
*/
|
|
269
|
-
readonly
|
|
178
|
+
readonly filter?: string;
|
|
270
179
|
/**
|
|
271
|
-
*
|
|
272
|
-
* @type {
|
|
180
|
+
* 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>
|
|
181
|
+
* @type {string}
|
|
273
182
|
* @memberof PaymentMethodsApiListPaymentMethods
|
|
274
183
|
*/
|
|
275
|
-
readonly
|
|
184
|
+
readonly filters?: string;
|
|
276
185
|
/**
|
|
277
|
-
*
|
|
278
|
-
* @type {
|
|
186
|
+
* 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>
|
|
187
|
+
* @type {string}
|
|
279
188
|
* @memberof PaymentMethodsApiListPaymentMethods
|
|
280
189
|
*/
|
|
281
|
-
readonly
|
|
190
|
+
readonly order?: string;
|
|
282
191
|
/**
|
|
283
|
-
*
|
|
284
|
-
* @type {
|
|
192
|
+
* 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>
|
|
193
|
+
* @type {string}
|
|
285
194
|
* @memberof PaymentMethodsApiListPaymentMethods
|
|
286
195
|
*/
|
|
287
|
-
readonly
|
|
196
|
+
readonly expand?: string;
|
|
288
197
|
}
|
|
289
198
|
/**
|
|
290
199
|
* PaymentMethodsApi - object-oriented interface
|
|
@@ -295,7 +204,7 @@ export interface PaymentMethodsApiListPaymentMethodsRequest {
|
|
|
295
204
|
export declare class PaymentMethodsApi extends BaseAPI {
|
|
296
205
|
/**
|
|
297
206
|
* 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
|
|
207
|
+
* @summary Create the payment method
|
|
299
208
|
* @param {PaymentMethodsApiCreatePaymentMethodRequest} requestParameters Request parameters.
|
|
300
209
|
* @param {*} [options] Override http request option.
|
|
301
210
|
* @throws {RequiredError}
|
|
@@ -303,17 +212,8 @@ export declare class PaymentMethodsApi extends BaseAPI {
|
|
|
303
212
|
*/
|
|
304
213
|
createPaymentMethod(requestParameters: PaymentMethodsApiCreatePaymentMethodRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
305
214
|
/**
|
|
306
|
-
*
|
|
307
|
-
* @summary
|
|
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>>;
|
|
314
|
-
/**
|
|
315
|
-
* Retrieves the details of a payment method that was previously created. Supply the unique payment method code that was returned when you created the payment method and Emil Api will return the corresponding payment method information.
|
|
316
|
-
* @summary Retrieve a payment method
|
|
215
|
+
* 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.
|
|
216
|
+
* @summary Retrieve the payment method
|
|
317
217
|
* @param {PaymentMethodsApiGetPaymentMethodRequest} requestParameters Request parameters.
|
|
318
218
|
* @param {*} [options] Override http request option.
|
|
319
219
|
* @throws {RequiredError}
|
|
@@ -321,7 +221,7 @@ export declare class PaymentMethodsApi extends BaseAPI {
|
|
|
321
221
|
*/
|
|
322
222
|
getPaymentMethod(requestParameters: PaymentMethodsApiGetPaymentMethodRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
323
223
|
/**
|
|
324
|
-
* Returns a list of payment methods you
|
|
224
|
+
* 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
225
|
* @summary List payment methods
|
|
326
226
|
* @param {PaymentMethodsApiListPaymentMethodsRequest} requestParameters Request parameters.
|
|
327
227
|
* @param {*} [options] Override http request option.
|