@emilgroup/payment-sdk 1.4.1-beta.3 → 1.4.1-beta.31
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +12 -39
- package/README.md +2 -2
- package/api/bank-accounts-api.ts +497 -47
- package/api/bank-transaction-api.ts +128 -96
- package/api/{default-api.ts → health-check-api.ts} +22 -18
- package/api/payment-methods-api.ts +74 -203
- package/api/payment-reminders-api.ts +76 -66
- package/api/payment-setup-api.ts +29 -37
- package/api/payments-api.ts +66 -89
- package/api/refunds-api.ts +74 -84
- package/api/tenant-bank-account-api.ts +88 -62
- package/api/webhooks-api.ts +17 -13
- package/api.ts +3 -3
- package/base.ts +6 -2
- package/common.ts +2 -2
- package/configuration.ts +1 -1
- package/dist/api/bank-accounts-api.d.ts +297 -49
- package/dist/api/bank-accounts-api.js +416 -28
- package/dist/api/bank-transaction-api.d.ts +109 -91
- package/dist/api/bank-transaction-api.js +83 -68
- package/dist/api/health-check-api.d.ts +70 -0
- package/dist/api/{default-api.js → health-check-api.js} +31 -27
- package/dist/api/payment-methods-api.d.ts +66 -134
- package/dist/api/payment-methods-api.js +55 -157
- package/dist/api/payment-reminders-api.d.ts +72 -65
- package/dist/api/payment-reminders-api.js +48 -42
- package/dist/api/payment-setup-api.d.ts +19 -23
- package/dist/api/payment-setup-api.js +25 -25
- package/dist/api/payments-api.d.ts +64 -76
- package/dist/api/payments-api.js +47 -55
- package/dist/api/refunds-api.d.ts +74 -74
- package/dist/api/refunds-api.js +52 -48
- package/dist/api/tenant-bank-account-api.d.ts +89 -66
- package/dist/api/tenant-bank-account-api.js +59 -39
- package/dist/api/webhooks-api.d.ts +17 -13
- package/dist/api/webhooks-api.js +15 -11
- package/dist/api.d.ts +2 -2
- package/dist/api.js +2 -2
- package/dist/base.d.ts +2 -1
- package/dist/base.js +5 -2
- package/dist/common.d.ts +2 -2
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/dist/models/{bank-transaction-response-class.d.ts → bank-transaction-class-without-expand-properties.d.ts} +26 -34
- package/dist/models/{bank-account-class.js → bank-transaction-class-without-expand-properties.js} +1 -1
- package/dist/models/create-bank-account-request-dto.d.ts +15 -3
- package/dist/models/create-bank-account-request-dto.js +1 -1
- package/dist/models/create-payment-reminder-request-dto.d.ts +1 -1
- package/dist/models/create-payment-reminder-request-dto.js +1 -1
- package/dist/models/create-payment-request-dto.d.ts +4 -4
- package/dist/models/create-payment-request-dto.js +1 -1
- package/dist/models/create-refund-request-dto.d.ts +1 -1
- package/dist/models/create-refund-request-dto.js +1 -1
- package/dist/models/create-tenant-bank-account-request-dto.d.ts +1 -1
- package/dist/models/create-tenant-bank-account-request-dto.js +1 -1
- package/dist/models/create-tenant-bank-account-response-class.d.ts +25 -0
- package/dist/models/{bank-transaction-response-class.js → create-tenant-bank-account-response-class.js} +1 -1
- package/dist/models/deactivate-payment-reminder-request-dto.d.ts +1 -1
- package/dist/models/deactivate-payment-reminder-request-dto.js +1 -1
- package/dist/models/get-tenant-bank-account-response-class.d.ts +5 -5
- package/dist/models/get-tenant-bank-account-response-class.js +1 -1
- package/dist/models/index.d.ts +11 -38
- package/dist/models/index.js +11 -38
- package/dist/models/inline-response200.d.ts +1 -1
- package/dist/models/inline-response200.js +1 -1
- package/dist/models/inline-response503.d.ts +1 -1
- package/dist/models/inline-response503.js +1 -1
- package/dist/models/link-bank-transaction-request-dto-rest.d.ts +24 -0
- package/dist/models/{billing-profile-limited-response-dto.js → link-bank-transaction-request-dto-rest.js} +1 -1
- package/dist/models/list-tenant-bank-account-response-class.d.ts +31 -0
- package/dist/models/{billing-profile-dto.js → list-tenant-bank-account-response-class.js} +1 -1
- package/dist/models/set-primary-bank-account-request-dto-rest.d.ts +24 -0
- package/dist/models/set-primary-bank-account-request-dto-rest.js +15 -0
- package/dist/models/{tenant-bank-account-response-class.d.ts → tenant-bank-account-class-without-expand-properties.d.ts} +11 -11
- package/dist/models/tenant-bank-account-class-without-expand-properties.js +15 -0
- package/dist/models/tenant-bank-account-class.d.ts +73 -0
- package/dist/models/tenant-bank-account-class.js +15 -0
- package/dist/models/unlink-bank-transaction-request-dto-rest.d.ts +24 -0
- package/dist/models/unlink-bank-transaction-request-dto-rest.js +15 -0
- package/dist/models/update-bank-account-request-dto-rest.d.ts +30 -0
- package/dist/models/update-bank-account-request-dto-rest.js +15 -0
- package/dist/models/update-bank-account-request-dto.d.ts +36 -0
- package/dist/models/update-bank-account-request-dto.js +15 -0
- package/dist/models/update-tenant-bank-account-response-class.d.ts +25 -0
- package/dist/models/update-tenant-bank-account-response-class.js +15 -0
- package/dist/models/update-tenant-bank-account-rest-request-dto.d.ts +1 -1
- package/dist/models/update-tenant-bank-account-rest-request-dto.js +1 -1
- package/dist/models/validate-pspconfig-request-dto.d.ts +2 -9
- package/dist/models/validate-pspconfig-request-dto.js +1 -8
- package/index.ts +1 -1
- package/models/{bank-transaction-response-class.ts → bank-transaction-class-without-expand-properties.ts} +26 -34
- package/models/create-bank-account-request-dto.ts +15 -3
- package/models/create-payment-reminder-request-dto.ts +1 -1
- package/models/create-payment-request-dto.ts +4 -4
- package/models/create-refund-request-dto.ts +1 -1
- package/models/create-tenant-bank-account-request-dto.ts +1 -1
- package/models/create-tenant-bank-account-response-class.ts +31 -0
- package/models/deactivate-payment-reminder-request-dto.ts +1 -1
- package/models/get-tenant-bank-account-response-class.ts +5 -5
- package/models/index.ts +11 -38
- package/models/inline-response200.ts +1 -1
- package/models/inline-response503.ts +1 -1
- package/models/link-bank-transaction-request-dto-rest.ts +30 -0
- package/models/list-tenant-bank-account-response-class.ts +37 -0
- package/models/set-primary-bank-account-request-dto-rest.ts +30 -0
- package/models/{tenant-bank-account-response-class.ts → tenant-bank-account-class-without-expand-properties.ts} +11 -11
- package/models/tenant-bank-account-class.ts +79 -0
- package/models/unlink-bank-transaction-request-dto-rest.ts +30 -0
- package/models/update-bank-account-request-dto-rest.ts +36 -0
- package/models/update-bank-account-request-dto.ts +42 -0
- package/models/update-tenant-bank-account-response-class.ts +31 -0
- package/models/update-tenant-bank-account-rest-request-dto.ts +1 -1
- package/models/validate-pspconfig-request-dto.ts +2 -12
- package/package.json +1 -1
- package/dist/api/default-api.d.ts +0 -66
- package/dist/models/bank-account-class.d.ts +0 -54
- package/dist/models/billing-profile-dto.d.ts +0 -38
- package/dist/models/billing-profile-limited-response-dto.d.ts +0 -54
- package/dist/models/complete-braintree-payment-setup-request-dto.d.ts +0 -48
- package/dist/models/complete-braintree-payment-setup-request-dto.js +0 -15
- package/dist/models/complete-payment-setup-request-dto.d.ts +0 -32
- package/dist/models/complete-payment-setup-request-dto.js +0 -15
- package/dist/models/complete-payment-setup-response-class.d.ts +0 -25
- package/dist/models/complete-payment-setup-response-class.js +0 -15
- package/dist/models/complete-stripe-payment-setup-request-dto.d.ts +0 -60
- package/dist/models/complete-stripe-payment-setup-request-dto.js +0 -15
- package/dist/models/create-payment-method-response-class.d.ts +0 -25
- package/dist/models/create-payment-method-response-class.js +0 -15
- package/dist/models/create-payment-response-class.d.ts +0 -25
- package/dist/models/create-payment-response-class.js +0 -15
- package/dist/models/create-psp-payment-method-request-dto.d.ts +0 -61
- package/dist/models/create-psp-payment-method-request-dto.js +0 -32
- package/dist/models/create-refund-response-class.d.ts +0 -25
- package/dist/models/create-refund-response-class.js +0 -15
- package/dist/models/deactivate-payment-reminder-response-class.d.ts +0 -25
- package/dist/models/deactivate-payment-reminder-response-class.js +0 -15
- package/dist/models/get-bank-transactions-response-class.d.ts +0 -25
- package/dist/models/get-bank-transactions-response-class.js +0 -15
- package/dist/models/get-payment-method-response-class.d.ts +0 -25
- package/dist/models/get-payment-method-response-class.js +0 -15
- package/dist/models/get-payment-response-class.d.ts +0 -25
- package/dist/models/get-payment-response-class.js +0 -15
- package/dist/models/get-refund-response-class.d.ts +0 -25
- package/dist/models/get-refund-response-class.js +0 -15
- package/dist/models/get-request-dto.d.ts +0 -30
- package/dist/models/get-request-dto.js +0 -15
- package/dist/models/initiate-braintree-payment-setup-request-dto.d.ts +0 -30
- package/dist/models/initiate-braintree-payment-setup-request-dto.js +0 -15
- package/dist/models/initiate-braintree-payment-setup-response-class.d.ts +0 -24
- package/dist/models/initiate-braintree-payment-setup-response-class.js +0 -15
- package/dist/models/initiate-payment-setup-request-dto.d.ts +0 -44
- package/dist/models/initiate-payment-setup-request-dto.js +0 -15
- package/dist/models/initiate-payment-setup-response-class.d.ts +0 -32
- package/dist/models/initiate-payment-setup-response-class.js +0 -15
- package/dist/models/initiate-stripe-payment-setup-request-dto.d.ts +0 -30
- package/dist/models/initiate-stripe-payment-setup-request-dto.js +0 -15
- package/dist/models/initiate-stripe-payment-setup-response-class.d.ts +0 -30
- package/dist/models/initiate-stripe-payment-setup-response-class.js +0 -15
- package/dist/models/list-bank-accounts-response-class.d.ts +0 -31
- package/dist/models/list-bank-accounts-response-class.js +0 -15
- package/dist/models/list-bank-transactions-response-class.d.ts +0 -31
- package/dist/models/list-bank-transactions-response-class.js +0 -15
- package/dist/models/list-payment-methods-response-class.d.ts +0 -31
- package/dist/models/list-payment-methods-response-class.js +0 -15
- package/dist/models/list-payment-reminders-response-class.d.ts +0 -31
- package/dist/models/list-payment-reminders-response-class.js +0 -15
- package/dist/models/list-payments-response-class.d.ts +0 -31
- package/dist/models/list-payments-response-class.js +0 -15
- package/dist/models/list-refunds-response-class.d.ts +0 -31
- package/dist/models/list-refunds-response-class.js +0 -15
- package/dist/models/payment-class.d.ts +0 -103
- package/dist/models/payment-class.js +0 -15
- package/dist/models/payment-method-class.d.ts +0 -66
- package/dist/models/payment-method-class.js +0 -15
- package/dist/models/payment-reminder-class.d.ts +0 -112
- package/dist/models/payment-reminder-class.js +0 -36
- package/dist/models/refund-class.d.ts +0 -104
- package/dist/models/refund-class.js +0 -28
- package/dist/models/sepa-direct-dto.d.ts +0 -24
- package/dist/models/sepa-direct-dto.js +0 -15
- package/dist/models/symphony-profile-limited-response-dto.d.ts +0 -42
- package/dist/models/symphony-profile-limited-response-dto.js +0 -15
- package/dist/models/tenant-bank-account-response-class.js +0 -15
- package/dist/models/transaction-class.d.ts +0 -54
- package/dist/models/transaction-class.js +0 -15
- package/models/bank-account-class.ts +0 -60
- package/models/billing-profile-dto.ts +0 -44
- package/models/billing-profile-limited-response-dto.ts +0 -60
- package/models/complete-braintree-payment-setup-request-dto.ts +0 -54
- package/models/complete-payment-setup-request-dto.ts +0 -38
- package/models/complete-payment-setup-response-class.ts +0 -31
- package/models/complete-stripe-payment-setup-request-dto.ts +0 -66
- package/models/create-payment-method-response-class.ts +0 -31
- package/models/create-payment-response-class.ts +0 -31
- package/models/create-psp-payment-method-request-dto.ts +0 -70
- package/models/create-refund-response-class.ts +0 -31
- package/models/deactivate-payment-reminder-response-class.ts +0 -31
- package/models/get-bank-transactions-response-class.ts +0 -31
- package/models/get-payment-method-response-class.ts +0 -31
- package/models/get-payment-response-class.ts +0 -31
- package/models/get-refund-response-class.ts +0 -31
- package/models/get-request-dto.ts +0 -36
- package/models/initiate-braintree-payment-setup-request-dto.ts +0 -36
- package/models/initiate-braintree-payment-setup-response-class.ts +0 -30
- package/models/initiate-payment-setup-request-dto.ts +0 -50
- package/models/initiate-payment-setup-response-class.ts +0 -38
- package/models/initiate-stripe-payment-setup-request-dto.ts +0 -36
- package/models/initiate-stripe-payment-setup-response-class.ts +0 -36
- package/models/list-bank-accounts-response-class.ts +0 -37
- package/models/list-bank-transactions-response-class.ts +0 -37
- package/models/list-payment-methods-response-class.ts +0 -37
- package/models/list-payment-reminders-response-class.ts +0 -37
- package/models/list-payments-response-class.ts +0 -37
- package/models/list-refunds-response-class.ts +0 -37
- package/models/payment-class.ts +0 -109
- package/models/payment-method-class.ts +0 -72
- package/models/payment-reminder-class.ts +0 -122
- package/models/refund-class.ts +0 -114
- package/models/sepa-direct-dto.ts +0 -30
- package/models/symphony-profile-limited-response-dto.ts +0 -48
- package/models/transaction-class.ts +0 -60
|
@@ -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,10 +12,6 @@
|
|
|
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';
|
|
19
15
|
/**
|
|
20
16
|
* PaymentMethodsApi - axios parameter creator
|
|
21
17
|
* @export
|
|
@@ -23,48 +19,38 @@ import { ListPaymentMethodsResponseClass } from '../models';
|
|
|
23
19
|
export declare const PaymentMethodsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
24
20
|
/**
|
|
25
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.
|
|
26
|
-
* @summary Create the payment
|
|
27
|
-
* @param {
|
|
22
|
+
* @summary Create the payment method
|
|
23
|
+
* @param {object} body
|
|
28
24
|
* @param {string} [authorization] Bearer Token
|
|
29
25
|
* @param {*} [options] Override http request option.
|
|
30
26
|
* @throws {RequiredError}
|
|
31
27
|
*/
|
|
32
|
-
createPaymentMethod: (
|
|
28
|
+
createPaymentMethod: (body: object, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
33
29
|
/**
|
|
34
|
-
*
|
|
35
|
-
* @summary
|
|
36
|
-
* @param {number} id Unique identifier for payment method
|
|
37
|
-
* @param {string} [authorization] Bearer Token
|
|
38
|
-
* @param {*} [options] Override http request option.
|
|
39
|
-
* @throws {RequiredError}
|
|
40
|
-
*/
|
|
41
|
-
deletePaymentMethod: (id: number, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
42
|
-
/**
|
|
43
|
-
* 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.
|
|
44
|
-
* @summary Retrieve a payment method
|
|
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
|
|
45
32
|
* @param {string} code Unique identifier for the object.
|
|
46
33
|
* @param {string} [authorization] Bearer Token
|
|
47
|
-
* @param {string} [expand]
|
|
48
|
-
* @param {string} [expand2] Fields to expand response by
|
|
34
|
+
* @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>
|
|
49
35
|
* @param {*} [options] Override http request option.
|
|
50
36
|
* @throws {RequiredError}
|
|
51
37
|
*/
|
|
52
|
-
getPaymentMethod: (code: string, authorization?: string, expand?: string,
|
|
38
|
+
getPaymentMethod: (code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
53
39
|
/**
|
|
54
|
-
* Returns a list of payment methods you
|
|
40
|
+
* 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.
|
|
55
41
|
* @summary List payment methods
|
|
56
42
|
* @param {string} [authorization] Bearer Token
|
|
57
43
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
58
44
|
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
59
|
-
* @param {
|
|
60
|
-
* @param {any} [search]
|
|
61
|
-
* @param {
|
|
62
|
-
* @param {
|
|
63
|
-
* @param {
|
|
45
|
+
* @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>
|
|
46
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
47
|
+
* @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>
|
|
48
|
+
* @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>
|
|
49
|
+
* @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>
|
|
64
50
|
* @param {*} [options] Override http request option.
|
|
65
51
|
* @throws {RequiredError}
|
|
66
52
|
*/
|
|
67
|
-
listPaymentMethods: (authorization?: string, pageSize?: any, pageToken?: any, filter?:
|
|
53
|
+
listPaymentMethods: (authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
68
54
|
};
|
|
69
55
|
/**
|
|
70
56
|
* PaymentMethodsApi - functional programming interface
|
|
@@ -73,48 +59,38 @@ export declare const PaymentMethodsApiAxiosParamCreator: (configuration?: Config
|
|
|
73
59
|
export declare const PaymentMethodsApiFp: (configuration?: Configuration) => {
|
|
74
60
|
/**
|
|
75
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.
|
|
76
|
-
* @summary Create the payment
|
|
77
|
-
* @param {
|
|
62
|
+
* @summary Create the payment method
|
|
63
|
+
* @param {object} body
|
|
78
64
|
* @param {string} [authorization] Bearer Token
|
|
79
65
|
* @param {*} [options] Override http request option.
|
|
80
66
|
* @throws {RequiredError}
|
|
81
67
|
*/
|
|
82
|
-
createPaymentMethod(
|
|
68
|
+
createPaymentMethod(body: object, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
83
69
|
/**
|
|
84
|
-
*
|
|
85
|
-
* @summary
|
|
86
|
-
* @param {number} id Unique identifier for payment method
|
|
87
|
-
* @param {string} [authorization] Bearer Token
|
|
88
|
-
* @param {*} [options] Override http request option.
|
|
89
|
-
* @throws {RequiredError}
|
|
90
|
-
*/
|
|
91
|
-
deletePaymentMethod(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
92
|
-
/**
|
|
93
|
-
* 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.
|
|
94
|
-
* @summary Retrieve a payment method
|
|
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
|
|
95
72
|
* @param {string} code Unique identifier for the object.
|
|
96
73
|
* @param {string} [authorization] Bearer Token
|
|
97
|
-
* @param {string} [expand]
|
|
98
|
-
* @param {string} [expand2] Fields to expand response by
|
|
74
|
+
* @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>
|
|
99
75
|
* @param {*} [options] Override http request option.
|
|
100
76
|
* @throws {RequiredError}
|
|
101
77
|
*/
|
|
102
|
-
getPaymentMethod(code: string, authorization?: string, expand?: string,
|
|
78
|
+
getPaymentMethod(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
103
79
|
/**
|
|
104
|
-
* Returns a list of payment methods you
|
|
80
|
+
* 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.
|
|
105
81
|
* @summary List payment methods
|
|
106
82
|
* @param {string} [authorization] Bearer Token
|
|
107
83
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
108
84
|
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
109
|
-
* @param {
|
|
110
|
-
* @param {any} [search]
|
|
111
|
-
* @param {
|
|
112
|
-
* @param {
|
|
113
|
-
* @param {
|
|
85
|
+
* @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>
|
|
86
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
87
|
+
* @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>
|
|
88
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: .<i>
|
|
89
|
+
* @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>
|
|
114
90
|
* @param {*} [options] Override http request option.
|
|
115
91
|
* @throws {RequiredError}
|
|
116
92
|
*/
|
|
117
|
-
listPaymentMethods(authorization?: string, pageSize?: any, pageToken?: any, filter?:
|
|
93
|
+
listPaymentMethods(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
118
94
|
};
|
|
119
95
|
/**
|
|
120
96
|
* PaymentMethodsApi - factory interface
|
|
@@ -123,48 +99,38 @@ export declare const PaymentMethodsApiFp: (configuration?: Configuration) => {
|
|
|
123
99
|
export declare const PaymentMethodsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
124
100
|
/**
|
|
125
101
|
* 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.
|
|
126
|
-
* @summary Create the payment
|
|
127
|
-
* @param {
|
|
128
|
-
* @param {string} [authorization] Bearer Token
|
|
129
|
-
* @param {*} [options] Override http request option.
|
|
130
|
-
* @throws {RequiredError}
|
|
131
|
-
*/
|
|
132
|
-
createPaymentMethod(createPspPaymentMethodRequestDto: CreatePspPaymentMethodRequestDto, authorization?: string, options?: any): AxiosPromise<CreatePaymentMethodResponseClass>;
|
|
133
|
-
/**
|
|
134
|
-
* 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.
|
|
135
|
-
* @summary Delete a payment method
|
|
136
|
-
* @param {number} id Unique identifier for payment method
|
|
102
|
+
* @summary Create the payment method
|
|
103
|
+
* @param {object} body
|
|
137
104
|
* @param {string} [authorization] Bearer Token
|
|
138
105
|
* @param {*} [options] Override http request option.
|
|
139
106
|
* @throws {RequiredError}
|
|
140
107
|
*/
|
|
141
|
-
|
|
108
|
+
createPaymentMethod(body: object, authorization?: string, options?: any): AxiosPromise<void>;
|
|
142
109
|
/**
|
|
143
|
-
* Retrieves the details of
|
|
144
|
-
* @summary Retrieve
|
|
110
|
+
* 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.
|
|
111
|
+
* @summary Retrieve the payment method
|
|
145
112
|
* @param {string} code Unique identifier for the object.
|
|
146
113
|
* @param {string} [authorization] Bearer Token
|
|
147
|
-
* @param {string} [expand]
|
|
148
|
-
* @param {string} [expand2] Fields to expand response by
|
|
114
|
+
* @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>
|
|
149
115
|
* @param {*} [options] Override http request option.
|
|
150
116
|
* @throws {RequiredError}
|
|
151
117
|
*/
|
|
152
|
-
getPaymentMethod(code: string, authorization?: string, expand?: string,
|
|
118
|
+
getPaymentMethod(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<void>;
|
|
153
119
|
/**
|
|
154
|
-
* Returns a list of payment methods you
|
|
120
|
+
* 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.
|
|
155
121
|
* @summary List payment methods
|
|
156
122
|
* @param {string} [authorization] Bearer Token
|
|
157
123
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
158
124
|
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
159
|
-
* @param {
|
|
160
|
-
* @param {any} [search]
|
|
161
|
-
* @param {
|
|
162
|
-
* @param {
|
|
163
|
-
* @param {
|
|
125
|
+
* @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>
|
|
126
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
127
|
+
* @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>
|
|
128
|
+
* @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>
|
|
129
|
+
* @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>
|
|
164
130
|
* @param {*} [options] Override http request option.
|
|
165
131
|
* @throws {RequiredError}
|
|
166
132
|
*/
|
|
167
|
-
listPaymentMethods(authorization?: string, pageSize?: any, pageToken?: any, filter?:
|
|
133
|
+
listPaymentMethods(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<void>;
|
|
168
134
|
};
|
|
169
135
|
/**
|
|
170
136
|
* Request parameters for createPaymentMethod operation in PaymentMethodsApi.
|
|
@@ -174,10 +140,10 @@ export declare const PaymentMethodsApiFactory: (configuration?: Configuration, b
|
|
|
174
140
|
export interface PaymentMethodsApiCreatePaymentMethodRequest {
|
|
175
141
|
/**
|
|
176
142
|
*
|
|
177
|
-
* @type {
|
|
143
|
+
* @type {object}
|
|
178
144
|
* @memberof PaymentMethodsApiCreatePaymentMethod
|
|
179
145
|
*/
|
|
180
|
-
readonly
|
|
146
|
+
readonly body: object;
|
|
181
147
|
/**
|
|
182
148
|
* Bearer Token
|
|
183
149
|
* @type {string}
|
|
@@ -185,25 +151,6 @@ export interface PaymentMethodsApiCreatePaymentMethodRequest {
|
|
|
185
151
|
*/
|
|
186
152
|
readonly authorization?: string;
|
|
187
153
|
}
|
|
188
|
-
/**
|
|
189
|
-
* Request parameters for deletePaymentMethod operation in PaymentMethodsApi.
|
|
190
|
-
* @export
|
|
191
|
-
* @interface PaymentMethodsApiDeletePaymentMethodRequest
|
|
192
|
-
*/
|
|
193
|
-
export interface PaymentMethodsApiDeletePaymentMethodRequest {
|
|
194
|
-
/**
|
|
195
|
-
* Unique identifier for payment method
|
|
196
|
-
* @type {number}
|
|
197
|
-
* @memberof PaymentMethodsApiDeletePaymentMethod
|
|
198
|
-
*/
|
|
199
|
-
readonly id: number;
|
|
200
|
-
/**
|
|
201
|
-
* Bearer Token
|
|
202
|
-
* @type {string}
|
|
203
|
-
* @memberof PaymentMethodsApiDeletePaymentMethod
|
|
204
|
-
*/
|
|
205
|
-
readonly authorization?: string;
|
|
206
|
-
}
|
|
207
154
|
/**
|
|
208
155
|
* Request parameters for getPaymentMethod operation in PaymentMethodsApi.
|
|
209
156
|
* @export
|
|
@@ -223,17 +170,11 @@ export interface PaymentMethodsApiGetPaymentMethodRequest {
|
|
|
223
170
|
*/
|
|
224
171
|
readonly authorization?: string;
|
|
225
172
|
/**
|
|
226
|
-
*
|
|
173
|
+
* 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>
|
|
227
174
|
* @type {string}
|
|
228
175
|
* @memberof PaymentMethodsApiGetPaymentMethod
|
|
229
176
|
*/
|
|
230
177
|
readonly expand?: string;
|
|
231
|
-
/**
|
|
232
|
-
* Fields to expand response by
|
|
233
|
-
* @type {string}
|
|
234
|
-
* @memberof PaymentMethodsApiGetPaymentMethod
|
|
235
|
-
*/
|
|
236
|
-
readonly expand2?: string;
|
|
237
178
|
}
|
|
238
179
|
/**
|
|
239
180
|
* Request parameters for listPaymentMethods operation in PaymentMethodsApi.
|
|
@@ -260,35 +201,35 @@ export interface PaymentMethodsApiListPaymentMethodsRequest {
|
|
|
260
201
|
*/
|
|
261
202
|
readonly pageToken?: any;
|
|
262
203
|
/**
|
|
263
|
-
* Filter the response by one or multiple fields.
|
|
264
|
-
* @type {
|
|
204
|
+
* 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>
|
|
205
|
+
* @type {string}
|
|
265
206
|
* @memberof PaymentMethodsApiListPaymentMethods
|
|
266
207
|
*/
|
|
267
|
-
readonly filter?:
|
|
208
|
+
readonly filter?: string;
|
|
268
209
|
/**
|
|
269
|
-
*
|
|
210
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
270
211
|
* @type {any}
|
|
271
212
|
* @memberof PaymentMethodsApiListPaymentMethods
|
|
272
213
|
*/
|
|
273
214
|
readonly search?: any;
|
|
274
215
|
/**
|
|
275
|
-
*
|
|
276
|
-
* @type {
|
|
216
|
+
* 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>
|
|
217
|
+
* @type {string}
|
|
277
218
|
* @memberof PaymentMethodsApiListPaymentMethods
|
|
278
219
|
*/
|
|
279
|
-
readonly order?:
|
|
220
|
+
readonly order?: string;
|
|
280
221
|
/**
|
|
281
|
-
*
|
|
282
|
-
* @type {
|
|
222
|
+
* 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>
|
|
223
|
+
* @type {string}
|
|
283
224
|
* @memberof PaymentMethodsApiListPaymentMethods
|
|
284
225
|
*/
|
|
285
|
-
readonly expand?:
|
|
226
|
+
readonly expand?: string;
|
|
286
227
|
/**
|
|
287
|
-
* Filters the response by one or multiple fields.
|
|
288
|
-
* @type {
|
|
228
|
+
* 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>
|
|
229
|
+
* @type {string}
|
|
289
230
|
* @memberof PaymentMethodsApiListPaymentMethods
|
|
290
231
|
*/
|
|
291
|
-
readonly filters?:
|
|
232
|
+
readonly filters?: string;
|
|
292
233
|
}
|
|
293
234
|
/**
|
|
294
235
|
* PaymentMethodsApi - object-oriented interface
|
|
@@ -299,38 +240,29 @@ export interface PaymentMethodsApiListPaymentMethodsRequest {
|
|
|
299
240
|
export declare class PaymentMethodsApi extends BaseAPI {
|
|
300
241
|
/**
|
|
301
242
|
* 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.
|
|
302
|
-
* @summary Create the payment
|
|
243
|
+
* @summary Create the payment method
|
|
303
244
|
* @param {PaymentMethodsApiCreatePaymentMethodRequest} requestParameters Request parameters.
|
|
304
245
|
* @param {*} [options] Override http request option.
|
|
305
246
|
* @throws {RequiredError}
|
|
306
247
|
* @memberof PaymentMethodsApi
|
|
307
248
|
*/
|
|
308
|
-
createPaymentMethod(requestParameters: PaymentMethodsApiCreatePaymentMethodRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
309
|
-
/**
|
|
310
|
-
* 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.
|
|
311
|
-
* @summary Delete a payment method
|
|
312
|
-
* @param {PaymentMethodsApiDeletePaymentMethodRequest} requestParameters Request parameters.
|
|
313
|
-
* @param {*} [options] Override http request option.
|
|
314
|
-
* @throws {RequiredError}
|
|
315
|
-
* @memberof PaymentMethodsApi
|
|
316
|
-
*/
|
|
317
|
-
deletePaymentMethod(requestParameters: PaymentMethodsApiDeletePaymentMethodRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
249
|
+
createPaymentMethod(requestParameters: PaymentMethodsApiCreatePaymentMethodRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
318
250
|
/**
|
|
319
|
-
* Retrieves the details of
|
|
320
|
-
* @summary Retrieve
|
|
251
|
+
* 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.
|
|
252
|
+
* @summary Retrieve the payment method
|
|
321
253
|
* @param {PaymentMethodsApiGetPaymentMethodRequest} requestParameters Request parameters.
|
|
322
254
|
* @param {*} [options] Override http request option.
|
|
323
255
|
* @throws {RequiredError}
|
|
324
256
|
* @memberof PaymentMethodsApi
|
|
325
257
|
*/
|
|
326
|
-
getPaymentMethod(requestParameters: PaymentMethodsApiGetPaymentMethodRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
258
|
+
getPaymentMethod(requestParameters: PaymentMethodsApiGetPaymentMethodRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
327
259
|
/**
|
|
328
|
-
* Returns a list of payment methods you
|
|
260
|
+
* 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.
|
|
329
261
|
* @summary List payment methods
|
|
330
262
|
* @param {PaymentMethodsApiListPaymentMethodsRequest} requestParameters Request parameters.
|
|
331
263
|
* @param {*} [options] Override http request option.
|
|
332
264
|
* @throws {RequiredError}
|
|
333
265
|
* @memberof PaymentMethodsApi
|
|
334
266
|
*/
|
|
335
|
-
listPaymentMethods(requestParameters?: PaymentMethodsApiListPaymentMethodsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
267
|
+
listPaymentMethods(requestParameters?: PaymentMethodsApiListPaymentMethodsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
336
268
|
}
|