@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 { CompletePaymentSetupRequestDto } from '../models';
|
|
16
|
-
import { CompletePaymentSetupResponseClass } from '../models';
|
|
17
|
-
import { InitiatePaymentSetupRequestDto } from '../models';
|
|
18
|
-
import { InitiatePaymentSetupResponseClass } from '../models';
|
|
19
15
|
/**
|
|
20
16
|
* PaymentSetupApi - axios parameter creator
|
|
21
17
|
* @export
|
|
@@ -23,20 +19,20 @@ import { InitiatePaymentSetupResponseClass } from '../models';
|
|
|
23
19
|
export declare const PaymentSetupApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
24
20
|
/**
|
|
25
21
|
*
|
|
26
|
-
* @param {
|
|
22
|
+
* @param {object} body
|
|
27
23
|
* @param {string} [authorization] Bearer Token
|
|
28
24
|
* @param {*} [options] Override http request option.
|
|
29
25
|
* @throws {RequiredError}
|
|
30
26
|
*/
|
|
31
|
-
completePaymentSetup: (
|
|
27
|
+
completePaymentSetup: (body: object, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
32
28
|
/**
|
|
33
29
|
*
|
|
34
|
-
* @param {
|
|
30
|
+
* @param {object} body
|
|
35
31
|
* @param {string} [authorization] Bearer Token
|
|
36
32
|
* @param {*} [options] Override http request option.
|
|
37
33
|
* @throws {RequiredError}
|
|
38
34
|
*/
|
|
39
|
-
initiatePaymentSetup: (
|
|
35
|
+
initiatePaymentSetup: (body: object, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
40
36
|
};
|
|
41
37
|
/**
|
|
42
38
|
* PaymentSetupApi - functional programming interface
|
|
@@ -45,20 +41,20 @@ export declare const PaymentSetupApiAxiosParamCreator: (configuration?: Configur
|
|
|
45
41
|
export declare const PaymentSetupApiFp: (configuration?: Configuration) => {
|
|
46
42
|
/**
|
|
47
43
|
*
|
|
48
|
-
* @param {
|
|
44
|
+
* @param {object} body
|
|
49
45
|
* @param {string} [authorization] Bearer Token
|
|
50
46
|
* @param {*} [options] Override http request option.
|
|
51
47
|
* @throws {RequiredError}
|
|
52
48
|
*/
|
|
53
|
-
completePaymentSetup(
|
|
49
|
+
completePaymentSetup(body: object, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
54
50
|
/**
|
|
55
51
|
*
|
|
56
|
-
* @param {
|
|
52
|
+
* @param {object} body
|
|
57
53
|
* @param {string} [authorization] Bearer Token
|
|
58
54
|
* @param {*} [options] Override http request option.
|
|
59
55
|
* @throws {RequiredError}
|
|
60
56
|
*/
|
|
61
|
-
initiatePaymentSetup(
|
|
57
|
+
initiatePaymentSetup(body: object, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
62
58
|
};
|
|
63
59
|
/**
|
|
64
60
|
* PaymentSetupApi - factory interface
|
|
@@ -67,20 +63,20 @@ export declare const PaymentSetupApiFp: (configuration?: Configuration) => {
|
|
|
67
63
|
export declare const PaymentSetupApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
68
64
|
/**
|
|
69
65
|
*
|
|
70
|
-
* @param {
|
|
66
|
+
* @param {object} body
|
|
71
67
|
* @param {string} [authorization] Bearer Token
|
|
72
68
|
* @param {*} [options] Override http request option.
|
|
73
69
|
* @throws {RequiredError}
|
|
74
70
|
*/
|
|
75
|
-
completePaymentSetup(
|
|
71
|
+
completePaymentSetup(body: object, authorization?: string, options?: any): AxiosPromise<void>;
|
|
76
72
|
/**
|
|
77
73
|
*
|
|
78
|
-
* @param {
|
|
74
|
+
* @param {object} body
|
|
79
75
|
* @param {string} [authorization] Bearer Token
|
|
80
76
|
* @param {*} [options] Override http request option.
|
|
81
77
|
* @throws {RequiredError}
|
|
82
78
|
*/
|
|
83
|
-
initiatePaymentSetup(
|
|
79
|
+
initiatePaymentSetup(body: object, authorization?: string, options?: any): AxiosPromise<void>;
|
|
84
80
|
};
|
|
85
81
|
/**
|
|
86
82
|
* Request parameters for completePaymentSetup operation in PaymentSetupApi.
|
|
@@ -90,10 +86,10 @@ export declare const PaymentSetupApiFactory: (configuration?: Configuration, bas
|
|
|
90
86
|
export interface PaymentSetupApiCompletePaymentSetupRequest {
|
|
91
87
|
/**
|
|
92
88
|
*
|
|
93
|
-
* @type {
|
|
89
|
+
* @type {object}
|
|
94
90
|
* @memberof PaymentSetupApiCompletePaymentSetup
|
|
95
91
|
*/
|
|
96
|
-
readonly
|
|
92
|
+
readonly body: object;
|
|
97
93
|
/**
|
|
98
94
|
* Bearer Token
|
|
99
95
|
* @type {string}
|
|
@@ -109,10 +105,10 @@ export interface PaymentSetupApiCompletePaymentSetupRequest {
|
|
|
109
105
|
export interface PaymentSetupApiInitiatePaymentSetupRequest {
|
|
110
106
|
/**
|
|
111
107
|
*
|
|
112
|
-
* @type {
|
|
108
|
+
* @type {object}
|
|
113
109
|
* @memberof PaymentSetupApiInitiatePaymentSetup
|
|
114
110
|
*/
|
|
115
|
-
readonly
|
|
111
|
+
readonly body: object;
|
|
116
112
|
/**
|
|
117
113
|
* Bearer Token
|
|
118
114
|
* @type {string}
|
|
@@ -134,7 +130,7 @@ export declare class PaymentSetupApi extends BaseAPI {
|
|
|
134
130
|
* @throws {RequiredError}
|
|
135
131
|
* @memberof PaymentSetupApi
|
|
136
132
|
*/
|
|
137
|
-
completePaymentSetup(requestParameters: PaymentSetupApiCompletePaymentSetupRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
133
|
+
completePaymentSetup(requestParameters: PaymentSetupApiCompletePaymentSetupRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
138
134
|
/**
|
|
139
135
|
*
|
|
140
136
|
* @param {PaymentSetupApiInitiatePaymentSetupRequest} requestParameters Request parameters.
|
|
@@ -142,5 +138,5 @@ export declare class PaymentSetupApi extends BaseAPI {
|
|
|
142
138
|
* @throws {RequiredError}
|
|
143
139
|
* @memberof PaymentSetupApi
|
|
144
140
|
*/
|
|
145
|
-
initiatePaymentSetup(requestParameters: PaymentSetupApiInitiatePaymentSetupRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
141
|
+
initiatePaymentSetup(requestParameters: PaymentSetupApiInitiatePaymentSetupRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
146
142
|
}
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
/* eslint-disable */
|
|
4
4
|
/**
|
|
5
5
|
* Emil Payment Service
|
|
6
|
-
* This service directly communicates with the various Payment Service Providers (PSPs)
|
|
6
|
+
* 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.
|
|
7
7
|
*
|
|
8
8
|
* The version of the OpenAPI document: 1.0
|
|
9
9
|
* Contact: kontakt@emil.de
|
|
@@ -94,20 +94,20 @@ var PaymentSetupApiAxiosParamCreator = function (configuration) {
|
|
|
94
94
|
return {
|
|
95
95
|
/**
|
|
96
96
|
*
|
|
97
|
-
* @param {
|
|
97
|
+
* @param {object} body
|
|
98
98
|
* @param {string} [authorization] Bearer Token
|
|
99
99
|
* @param {*} [options] Override http request option.
|
|
100
100
|
* @throws {RequiredError}
|
|
101
101
|
*/
|
|
102
|
-
completePaymentSetup: function (
|
|
102
|
+
completePaymentSetup: function (body, authorization, options) {
|
|
103
103
|
if (options === void 0) { options = {}; }
|
|
104
104
|
return __awaiter(_this, void 0, void 0, function () {
|
|
105
105
|
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
106
106
|
return __generator(this, function (_a) {
|
|
107
107
|
switch (_a.label) {
|
|
108
108
|
case 0:
|
|
109
|
-
// verify required parameter '
|
|
110
|
-
(0, common_1.assertParamExists)('completePaymentSetup', '
|
|
109
|
+
// verify required parameter 'body' is not null or undefined
|
|
110
|
+
(0, common_1.assertParamExists)('completePaymentSetup', 'body', body);
|
|
111
111
|
localVarPath = "/paymentservice/v1/payment-setup/complete";
|
|
112
112
|
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
113
113
|
if (configuration) {
|
|
@@ -131,7 +131,7 @@ var PaymentSetupApiAxiosParamCreator = function (configuration) {
|
|
|
131
131
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
132
132
|
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
133
133
|
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
134
|
-
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(
|
|
134
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(body, localVarRequestOptions, configuration);
|
|
135
135
|
return [2 /*return*/, {
|
|
136
136
|
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
137
137
|
options: localVarRequestOptions,
|
|
@@ -142,20 +142,20 @@ var PaymentSetupApiAxiosParamCreator = function (configuration) {
|
|
|
142
142
|
},
|
|
143
143
|
/**
|
|
144
144
|
*
|
|
145
|
-
* @param {
|
|
145
|
+
* @param {object} body
|
|
146
146
|
* @param {string} [authorization] Bearer Token
|
|
147
147
|
* @param {*} [options] Override http request option.
|
|
148
148
|
* @throws {RequiredError}
|
|
149
149
|
*/
|
|
150
|
-
initiatePaymentSetup: function (
|
|
150
|
+
initiatePaymentSetup: function (body, authorization, options) {
|
|
151
151
|
if (options === void 0) { options = {}; }
|
|
152
152
|
return __awaiter(_this, void 0, void 0, function () {
|
|
153
153
|
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
154
154
|
return __generator(this, function (_a) {
|
|
155
155
|
switch (_a.label) {
|
|
156
156
|
case 0:
|
|
157
|
-
// verify required parameter '
|
|
158
|
-
(0, common_1.assertParamExists)('initiatePaymentSetup', '
|
|
157
|
+
// verify required parameter 'body' is not null or undefined
|
|
158
|
+
(0, common_1.assertParamExists)('initiatePaymentSetup', 'body', body);
|
|
159
159
|
localVarPath = "/paymentservice/v1/payment-setup/initiate";
|
|
160
160
|
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
161
161
|
if (configuration) {
|
|
@@ -179,7 +179,7 @@ var PaymentSetupApiAxiosParamCreator = function (configuration) {
|
|
|
179
179
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
180
180
|
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
181
181
|
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
182
|
-
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(
|
|
182
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(body, localVarRequestOptions, configuration);
|
|
183
183
|
return [2 /*return*/, {
|
|
184
184
|
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
185
185
|
options: localVarRequestOptions,
|
|
@@ -200,17 +200,17 @@ var PaymentSetupApiFp = function (configuration) {
|
|
|
200
200
|
return {
|
|
201
201
|
/**
|
|
202
202
|
*
|
|
203
|
-
* @param {
|
|
203
|
+
* @param {object} body
|
|
204
204
|
* @param {string} [authorization] Bearer Token
|
|
205
205
|
* @param {*} [options] Override http request option.
|
|
206
206
|
* @throws {RequiredError}
|
|
207
207
|
*/
|
|
208
|
-
completePaymentSetup: function (
|
|
208
|
+
completePaymentSetup: function (body, authorization, options) {
|
|
209
209
|
return __awaiter(this, void 0, void 0, function () {
|
|
210
210
|
var localVarAxiosArgs;
|
|
211
211
|
return __generator(this, function (_a) {
|
|
212
212
|
switch (_a.label) {
|
|
213
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.completePaymentSetup(
|
|
213
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.completePaymentSetup(body, authorization, options)];
|
|
214
214
|
case 1:
|
|
215
215
|
localVarAxiosArgs = _a.sent();
|
|
216
216
|
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
@@ -220,17 +220,17 @@ var PaymentSetupApiFp = function (configuration) {
|
|
|
220
220
|
},
|
|
221
221
|
/**
|
|
222
222
|
*
|
|
223
|
-
* @param {
|
|
223
|
+
* @param {object} body
|
|
224
224
|
* @param {string} [authorization] Bearer Token
|
|
225
225
|
* @param {*} [options] Override http request option.
|
|
226
226
|
* @throws {RequiredError}
|
|
227
227
|
*/
|
|
228
|
-
initiatePaymentSetup: function (
|
|
228
|
+
initiatePaymentSetup: function (body, authorization, options) {
|
|
229
229
|
return __awaiter(this, void 0, void 0, function () {
|
|
230
230
|
var localVarAxiosArgs;
|
|
231
231
|
return __generator(this, function (_a) {
|
|
232
232
|
switch (_a.label) {
|
|
233
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.initiatePaymentSetup(
|
|
233
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.initiatePaymentSetup(body, authorization, options)];
|
|
234
234
|
case 1:
|
|
235
235
|
localVarAxiosArgs = _a.sent();
|
|
236
236
|
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
@@ -250,23 +250,23 @@ var PaymentSetupApiFactory = function (configuration, basePath, axios) {
|
|
|
250
250
|
return {
|
|
251
251
|
/**
|
|
252
252
|
*
|
|
253
|
-
* @param {
|
|
253
|
+
* @param {object} body
|
|
254
254
|
* @param {string} [authorization] Bearer Token
|
|
255
255
|
* @param {*} [options] Override http request option.
|
|
256
256
|
* @throws {RequiredError}
|
|
257
257
|
*/
|
|
258
|
-
completePaymentSetup: function (
|
|
259
|
-
return localVarFp.completePaymentSetup(
|
|
258
|
+
completePaymentSetup: function (body, authorization, options) {
|
|
259
|
+
return localVarFp.completePaymentSetup(body, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
260
260
|
},
|
|
261
261
|
/**
|
|
262
262
|
*
|
|
263
|
-
* @param {
|
|
263
|
+
* @param {object} body
|
|
264
264
|
* @param {string} [authorization] Bearer Token
|
|
265
265
|
* @param {*} [options] Override http request option.
|
|
266
266
|
* @throws {RequiredError}
|
|
267
267
|
*/
|
|
268
|
-
initiatePaymentSetup: function (
|
|
269
|
-
return localVarFp.initiatePaymentSetup(
|
|
268
|
+
initiatePaymentSetup: function (body, authorization, options) {
|
|
269
|
+
return localVarFp.initiatePaymentSetup(body, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
270
270
|
},
|
|
271
271
|
};
|
|
272
272
|
};
|
|
@@ -291,7 +291,7 @@ var PaymentSetupApi = /** @class */ (function (_super) {
|
|
|
291
291
|
*/
|
|
292
292
|
PaymentSetupApi.prototype.completePaymentSetup = function (requestParameters, options) {
|
|
293
293
|
var _this = this;
|
|
294
|
-
return (0, exports.PaymentSetupApiFp)(this.configuration).completePaymentSetup(requestParameters.
|
|
294
|
+
return (0, exports.PaymentSetupApiFp)(this.configuration).completePaymentSetup(requestParameters.body, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
295
295
|
};
|
|
296
296
|
/**
|
|
297
297
|
*
|
|
@@ -302,7 +302,7 @@ var PaymentSetupApi = /** @class */ (function (_super) {
|
|
|
302
302
|
*/
|
|
303
303
|
PaymentSetupApi.prototype.initiatePaymentSetup = function (requestParameters, options) {
|
|
304
304
|
var _this = this;
|
|
305
|
-
return (0, exports.PaymentSetupApiFp)(this.configuration).initiatePaymentSetup(requestParameters.
|
|
305
|
+
return (0, exports.PaymentSetupApiFp)(this.configuration).initiatePaymentSetup(requestParameters.body, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
306
306
|
};
|
|
307
307
|
return PaymentSetupApi;
|
|
308
308
|
}(base_1.BaseAPI));
|
|
@@ -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
|
|
@@ -13,17 +13,14 @@ import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
|
13
13
|
import { Configuration } from '../configuration';
|
|
14
14
|
import { RequestArgs, BaseAPI } from '../base';
|
|
15
15
|
import { CreatePaymentRequestDto } from '../models';
|
|
16
|
-
import { CreatePaymentResponseClass } from '../models';
|
|
17
|
-
import { GetPaymentResponseClass } from '../models';
|
|
18
|
-
import { ListPaymentsResponseClass } from '../models';
|
|
19
16
|
/**
|
|
20
17
|
* PaymentsApi - axios parameter creator
|
|
21
18
|
* @export
|
|
22
19
|
*/
|
|
23
20
|
export declare const PaymentsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
24
21
|
/**
|
|
25
|
-
*
|
|
26
|
-
* @summary Create
|
|
22
|
+
* This will create a payment for a specified account. This function is idempotent.
|
|
23
|
+
* @summary Create the payment
|
|
27
24
|
* @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
|
|
28
25
|
* @param {CreatePaymentRequestDto} createPaymentRequestDto
|
|
29
26
|
* @param {string} [authorization] Bearer Token
|
|
@@ -32,31 +29,30 @@ export declare const PaymentsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
32
29
|
*/
|
|
33
30
|
createPayment: (idempotencyKey: string, createPaymentRequestDto: CreatePaymentRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
34
31
|
/**
|
|
35
|
-
* Retrieves the details of
|
|
36
|
-
* @summary Retrieve
|
|
32
|
+
* Retrieves the details of the payment that was previously created. Supply the unique payment code that was returned when you created it and Emil Api will return the corresponding payment information.
|
|
33
|
+
* @summary Retrieve the payment
|
|
37
34
|
* @param {string} code Unique identifier for the object.
|
|
38
35
|
* @param {string} [authorization] Bearer Token
|
|
39
|
-
* @param {string} [expand]
|
|
40
|
-
* @param {string} [expand2] Fields to expand response by
|
|
36
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: transactions.<i>
|
|
41
37
|
* @param {*} [options] Override http request option.
|
|
42
38
|
* @throws {RequiredError}
|
|
43
39
|
*/
|
|
44
|
-
getPayment: (code: string, authorization?: string, expand?: string,
|
|
40
|
+
getPayment: (code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
45
41
|
/**
|
|
46
|
-
* Returns a list of payments you
|
|
42
|
+
* Returns a list of payments you have previously created. The payments are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
47
43
|
* @summary List payments
|
|
48
44
|
* @param {string} [authorization] Bearer Token
|
|
49
45
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
50
46
|
* @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.
|
|
51
|
-
* @param {
|
|
52
|
-
* @param {any} [search]
|
|
53
|
-
* @param {
|
|
54
|
-
* @param {
|
|
55
|
-
* @param {
|
|
47
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, id, pspCustomerId, psp, type, amount, receivedDate, referenceNumber</i>
|
|
48
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
49
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, code, amount</i>
|
|
50
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: transactions.<i>
|
|
51
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, id, pspCustomerId, psp, type, amount, receivedDate, referenceNumber</i>
|
|
56
52
|
* @param {*} [options] Override http request option.
|
|
57
53
|
* @throws {RequiredError}
|
|
58
54
|
*/
|
|
59
|
-
listPayments: (authorization?: string, pageSize?: any, pageToken?: any, filter?:
|
|
55
|
+
listPayments: (authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
60
56
|
};
|
|
61
57
|
/**
|
|
62
58
|
* PaymentsApi - functional programming interface
|
|
@@ -64,41 +60,40 @@ export declare const PaymentsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
64
60
|
*/
|
|
65
61
|
export declare const PaymentsApiFp: (configuration?: Configuration) => {
|
|
66
62
|
/**
|
|
67
|
-
*
|
|
68
|
-
* @summary Create
|
|
63
|
+
* This will create a payment for a specified account. This function is idempotent.
|
|
64
|
+
* @summary Create the payment
|
|
69
65
|
* @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
|
|
70
66
|
* @param {CreatePaymentRequestDto} createPaymentRequestDto
|
|
71
67
|
* @param {string} [authorization] Bearer Token
|
|
72
68
|
* @param {*} [options] Override http request option.
|
|
73
69
|
* @throws {RequiredError}
|
|
74
70
|
*/
|
|
75
|
-
createPayment(idempotencyKey: string, createPaymentRequestDto: CreatePaymentRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
71
|
+
createPayment(idempotencyKey: string, createPaymentRequestDto: CreatePaymentRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
76
72
|
/**
|
|
77
|
-
* Retrieves the details of
|
|
78
|
-
* @summary Retrieve
|
|
73
|
+
* Retrieves the details of the payment that was previously created. Supply the unique payment code that was returned when you created it and Emil Api will return the corresponding payment information.
|
|
74
|
+
* @summary Retrieve the payment
|
|
79
75
|
* @param {string} code Unique identifier for the object.
|
|
80
76
|
* @param {string} [authorization] Bearer Token
|
|
81
|
-
* @param {string} [expand]
|
|
82
|
-
* @param {string} [expand2] Fields to expand response by
|
|
77
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: transactions.<i>
|
|
83
78
|
* @param {*} [options] Override http request option.
|
|
84
79
|
* @throws {RequiredError}
|
|
85
80
|
*/
|
|
86
|
-
getPayment(code: string, authorization?: string, expand?: string,
|
|
81
|
+
getPayment(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
87
82
|
/**
|
|
88
|
-
* Returns a list of payments you
|
|
83
|
+
* Returns a list of payments you have previously created. The payments are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
89
84
|
* @summary List payments
|
|
90
85
|
* @param {string} [authorization] Bearer Token
|
|
91
86
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
92
87
|
* @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.
|
|
93
|
-
* @param {
|
|
94
|
-
* @param {any} [search]
|
|
95
|
-
* @param {
|
|
96
|
-
* @param {
|
|
97
|
-
* @param {
|
|
88
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, id, pspCustomerId, psp, type, amount, receivedDate, referenceNumber</i>
|
|
89
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
90
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, code, amount</i>
|
|
91
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: transactions.<i>
|
|
92
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, id, pspCustomerId, psp, type, amount, receivedDate, referenceNumber</i>
|
|
98
93
|
* @param {*} [options] Override http request option.
|
|
99
94
|
* @throws {RequiredError}
|
|
100
95
|
*/
|
|
101
|
-
listPayments(authorization?: string, pageSize?: any, pageToken?: any, filter?:
|
|
96
|
+
listPayments(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>>;
|
|
102
97
|
};
|
|
103
98
|
/**
|
|
104
99
|
* PaymentsApi - factory interface
|
|
@@ -106,41 +101,40 @@ export declare const PaymentsApiFp: (configuration?: Configuration) => {
|
|
|
106
101
|
*/
|
|
107
102
|
export declare const PaymentsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
108
103
|
/**
|
|
109
|
-
*
|
|
110
|
-
* @summary Create
|
|
104
|
+
* This will create a payment for a specified account. This function is idempotent.
|
|
105
|
+
* @summary Create the payment
|
|
111
106
|
* @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
|
|
112
107
|
* @param {CreatePaymentRequestDto} createPaymentRequestDto
|
|
113
108
|
* @param {string} [authorization] Bearer Token
|
|
114
109
|
* @param {*} [options] Override http request option.
|
|
115
110
|
* @throws {RequiredError}
|
|
116
111
|
*/
|
|
117
|
-
createPayment(idempotencyKey: string, createPaymentRequestDto: CreatePaymentRequestDto, authorization?: string, options?: any): AxiosPromise<
|
|
112
|
+
createPayment(idempotencyKey: string, createPaymentRequestDto: CreatePaymentRequestDto, authorization?: string, options?: any): AxiosPromise<void>;
|
|
118
113
|
/**
|
|
119
|
-
* Retrieves the details of
|
|
120
|
-
* @summary Retrieve
|
|
114
|
+
* Retrieves the details of the payment that was previously created. Supply the unique payment code that was returned when you created it and Emil Api will return the corresponding payment information.
|
|
115
|
+
* @summary Retrieve the payment
|
|
121
116
|
* @param {string} code Unique identifier for the object.
|
|
122
117
|
* @param {string} [authorization] Bearer Token
|
|
123
|
-
* @param {string} [expand]
|
|
124
|
-
* @param {string} [expand2] Fields to expand response by
|
|
118
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: transactions.<i>
|
|
125
119
|
* @param {*} [options] Override http request option.
|
|
126
120
|
* @throws {RequiredError}
|
|
127
121
|
*/
|
|
128
|
-
getPayment(code: string, authorization?: string, expand?: string,
|
|
122
|
+
getPayment(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<void>;
|
|
129
123
|
/**
|
|
130
|
-
* Returns a list of payments you
|
|
124
|
+
* Returns a list of payments you have previously created. The payments are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
131
125
|
* @summary List payments
|
|
132
126
|
* @param {string} [authorization] Bearer Token
|
|
133
127
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
134
128
|
* @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.
|
|
135
|
-
* @param {
|
|
136
|
-
* @param {any} [search]
|
|
137
|
-
* @param {
|
|
138
|
-
* @param {
|
|
139
|
-
* @param {
|
|
129
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, id, pspCustomerId, psp, type, amount, receivedDate, referenceNumber</i>
|
|
130
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
131
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, code, amount</i>
|
|
132
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: transactions.<i>
|
|
133
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, id, pspCustomerId, psp, type, amount, receivedDate, referenceNumber</i>
|
|
140
134
|
* @param {*} [options] Override http request option.
|
|
141
135
|
* @throws {RequiredError}
|
|
142
136
|
*/
|
|
143
|
-
listPayments(authorization?: string, pageSize?: any, pageToken?: any, filter?:
|
|
137
|
+
listPayments(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<void>;
|
|
144
138
|
};
|
|
145
139
|
/**
|
|
146
140
|
* Request parameters for createPayment operation in PaymentsApi.
|
|
@@ -186,17 +180,11 @@ export interface PaymentsApiGetPaymentRequest {
|
|
|
186
180
|
*/
|
|
187
181
|
readonly authorization?: string;
|
|
188
182
|
/**
|
|
189
|
-
*
|
|
183
|
+
* Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: transactions.<i>
|
|
190
184
|
* @type {string}
|
|
191
185
|
* @memberof PaymentsApiGetPayment
|
|
192
186
|
*/
|
|
193
187
|
readonly expand?: string;
|
|
194
|
-
/**
|
|
195
|
-
* Fields to expand response by
|
|
196
|
-
* @type {string}
|
|
197
|
-
* @memberof PaymentsApiGetPayment
|
|
198
|
-
*/
|
|
199
|
-
readonly expand2?: string;
|
|
200
188
|
}
|
|
201
189
|
/**
|
|
202
190
|
* Request parameters for listPayments operation in PaymentsApi.
|
|
@@ -223,35 +211,35 @@ export interface PaymentsApiListPaymentsRequest {
|
|
|
223
211
|
*/
|
|
224
212
|
readonly pageToken?: any;
|
|
225
213
|
/**
|
|
226
|
-
* Filter the response by one or multiple fields.
|
|
227
|
-
* @type {
|
|
214
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, id, pspCustomerId, psp, type, amount, receivedDate, referenceNumber</i>
|
|
215
|
+
* @type {string}
|
|
228
216
|
* @memberof PaymentsApiListPayments
|
|
229
217
|
*/
|
|
230
|
-
readonly filter?:
|
|
218
|
+
readonly filter?: string;
|
|
231
219
|
/**
|
|
232
|
-
*
|
|
220
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
233
221
|
* @type {any}
|
|
234
222
|
* @memberof PaymentsApiListPayments
|
|
235
223
|
*/
|
|
236
224
|
readonly search?: any;
|
|
237
225
|
/**
|
|
238
|
-
*
|
|
239
|
-
* @type {
|
|
226
|
+
* Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, code, amount</i>
|
|
227
|
+
* @type {string}
|
|
240
228
|
* @memberof PaymentsApiListPayments
|
|
241
229
|
*/
|
|
242
|
-
readonly order?:
|
|
230
|
+
readonly order?: string;
|
|
243
231
|
/**
|
|
244
|
-
*
|
|
245
|
-
* @type {
|
|
232
|
+
* Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: transactions.<i>
|
|
233
|
+
* @type {string}
|
|
246
234
|
* @memberof PaymentsApiListPayments
|
|
247
235
|
*/
|
|
248
|
-
readonly expand?:
|
|
236
|
+
readonly expand?: string;
|
|
249
237
|
/**
|
|
250
|
-
* Filters the response by one or multiple fields.
|
|
251
|
-
* @type {
|
|
238
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, id, pspCustomerId, psp, type, amount, receivedDate, referenceNumber</i>
|
|
239
|
+
* @type {string}
|
|
252
240
|
* @memberof PaymentsApiListPayments
|
|
253
241
|
*/
|
|
254
|
-
readonly filters?:
|
|
242
|
+
readonly filters?: string;
|
|
255
243
|
}
|
|
256
244
|
/**
|
|
257
245
|
* PaymentsApi - object-oriented interface
|
|
@@ -261,30 +249,30 @@ export interface PaymentsApiListPaymentsRequest {
|
|
|
261
249
|
*/
|
|
262
250
|
export declare class PaymentsApi extends BaseAPI {
|
|
263
251
|
/**
|
|
264
|
-
*
|
|
265
|
-
* @summary Create
|
|
252
|
+
* This will create a payment for a specified account. This function is idempotent.
|
|
253
|
+
* @summary Create the payment
|
|
266
254
|
* @param {PaymentsApiCreatePaymentRequest} requestParameters Request parameters.
|
|
267
255
|
* @param {*} [options] Override http request option.
|
|
268
256
|
* @throws {RequiredError}
|
|
269
257
|
* @memberof PaymentsApi
|
|
270
258
|
*/
|
|
271
|
-
createPayment(requestParameters: PaymentsApiCreatePaymentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
259
|
+
createPayment(requestParameters: PaymentsApiCreatePaymentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
272
260
|
/**
|
|
273
|
-
* Retrieves the details of
|
|
274
|
-
* @summary Retrieve
|
|
261
|
+
* Retrieves the details of the payment that was previously created. Supply the unique payment code that was returned when you created it and Emil Api will return the corresponding payment information.
|
|
262
|
+
* @summary Retrieve the payment
|
|
275
263
|
* @param {PaymentsApiGetPaymentRequest} requestParameters Request parameters.
|
|
276
264
|
* @param {*} [options] Override http request option.
|
|
277
265
|
* @throws {RequiredError}
|
|
278
266
|
* @memberof PaymentsApi
|
|
279
267
|
*/
|
|
280
|
-
getPayment(requestParameters: PaymentsApiGetPaymentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
268
|
+
getPayment(requestParameters: PaymentsApiGetPaymentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
281
269
|
/**
|
|
282
|
-
* Returns a list of payments you
|
|
270
|
+
* Returns a list of payments you have previously created. The payments are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
283
271
|
* @summary List payments
|
|
284
272
|
* @param {PaymentsApiListPaymentsRequest} requestParameters Request parameters.
|
|
285
273
|
* @param {*} [options] Override http request option.
|
|
286
274
|
* @throws {RequiredError}
|
|
287
275
|
* @memberof PaymentsApi
|
|
288
276
|
*/
|
|
289
|
-
listPayments(requestParameters?: PaymentsApiListPaymentsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
277
|
+
listPayments(requestParameters?: PaymentsApiListPaymentsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
290
278
|
}
|