@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
package/api/payments-api.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* Emil Payment Service
|
|
5
|
-
* This service directly communicates with the various Payment Service Providers (PSPs)
|
|
5
|
+
* This service directly communicates with the various Payment Service Providers (PSPs) in order to charge or refund customers. This service will automatically connect to the PSP linked in your admin configuration; meaning if you configured Stripe, it will automatically create a payment on Stripe when you create it in Emil.
|
|
6
6
|
*
|
|
7
7
|
* The version of the OpenAPI document: 1.0
|
|
8
8
|
* Contact: kontakt@emil.de
|
|
@@ -22,12 +22,6 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj
|
|
|
22
22
|
import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
|
|
23
23
|
// @ts-ignore
|
|
24
24
|
import { CreatePaymentRequestDto } from '../models';
|
|
25
|
-
// @ts-ignore
|
|
26
|
-
import { CreatePaymentResponseClass } from '../models';
|
|
27
|
-
// @ts-ignore
|
|
28
|
-
import { GetPaymentResponseClass } from '../models';
|
|
29
|
-
// @ts-ignore
|
|
30
|
-
import { ListPaymentsResponseClass } from '../models';
|
|
31
25
|
/**
|
|
32
26
|
* PaymentsApi - axios parameter creator
|
|
33
27
|
* @export
|
|
@@ -35,8 +29,8 @@ import { ListPaymentsResponseClass } from '../models';
|
|
|
35
29
|
export const PaymentsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
36
30
|
return {
|
|
37
31
|
/**
|
|
38
|
-
*
|
|
39
|
-
* @summary Create
|
|
32
|
+
* This will create a payment for a specified account. This function is idempotent.
|
|
33
|
+
* @summary Create the payment
|
|
40
34
|
* @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
|
|
41
35
|
* @param {CreatePaymentRequestDto} createPaymentRequestDto
|
|
42
36
|
* @param {string} [authorization] Bearer Token
|
|
@@ -89,19 +83,19 @@ export const PaymentsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
89
83
|
};
|
|
90
84
|
},
|
|
91
85
|
/**
|
|
92
|
-
* Retrieves the details of
|
|
93
|
-
* @summary Retrieve
|
|
86
|
+
* 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.
|
|
87
|
+
* @summary Retrieve the payment
|
|
94
88
|
* @param {string} code Unique identifier for the object.
|
|
95
89
|
* @param {string} [authorization] Bearer Token
|
|
96
|
-
* @param {string} [expand]
|
|
97
|
-
* @param {string} [expand2] Fields to expand response by
|
|
90
|
+
* @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>
|
|
98
91
|
* @param {*} [options] Override http request option.
|
|
99
92
|
* @throws {RequiredError}
|
|
100
93
|
*/
|
|
101
|
-
getPayment: async (code: string, authorization?: string, expand?: string,
|
|
94
|
+
getPayment: async (code: string, authorization?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
102
95
|
// verify required parameter 'code' is not null or undefined
|
|
103
96
|
assertParamExists('getPayment', 'code', code)
|
|
104
|
-
const localVarPath = `/paymentservice/v1/payments/{code}
|
|
97
|
+
const localVarPath = `/paymentservice/v1/payments/{code}`
|
|
98
|
+
.replace(`{${"code"}}`, encodeURIComponent(String(code)));
|
|
105
99
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
106
100
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
107
101
|
let baseOptions;
|
|
@@ -119,18 +113,10 @@ export const PaymentsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
119
113
|
// http bearer authentication required
|
|
120
114
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
121
115
|
|
|
122
|
-
if (code !== undefined) {
|
|
123
|
-
localVarQueryParameter['code'] = code;
|
|
124
|
-
}
|
|
125
|
-
|
|
126
116
|
if (expand !== undefined) {
|
|
127
117
|
localVarQueryParameter['expand'] = expand;
|
|
128
118
|
}
|
|
129
119
|
|
|
130
|
-
if (expand2 !== undefined) {
|
|
131
|
-
localVarQueryParameter['expand'] = expand2;
|
|
132
|
-
}
|
|
133
|
-
|
|
134
120
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
135
121
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
136
122
|
}
|
|
@@ -147,20 +133,20 @@ export const PaymentsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
147
133
|
};
|
|
148
134
|
},
|
|
149
135
|
/**
|
|
150
|
-
* Returns a list of payments you
|
|
136
|
+
* 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.
|
|
151
137
|
* @summary List payments
|
|
152
138
|
* @param {string} [authorization] Bearer Token
|
|
153
139
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
154
140
|
* @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.
|
|
155
|
-
* @param {
|
|
156
|
-
* @param {any} [search]
|
|
157
|
-
* @param {
|
|
158
|
-
* @param {
|
|
159
|
-
* @param {
|
|
141
|
+
* @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>
|
|
142
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
143
|
+
* @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>
|
|
144
|
+
* @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>
|
|
145
|
+
* @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>
|
|
160
146
|
* @param {*} [options] Override http request option.
|
|
161
147
|
* @throws {RequiredError}
|
|
162
148
|
*/
|
|
163
|
-
listPayments: async (authorization?: string, pageSize?: any, pageToken?: any, filter?:
|
|
149
|
+
listPayments: async (authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
164
150
|
const localVarPath = `/paymentservice/v1/payments`;
|
|
165
151
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
166
152
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -233,47 +219,46 @@ export const PaymentsApiFp = function(configuration?: Configuration) {
|
|
|
233
219
|
const localVarAxiosParamCreator = PaymentsApiAxiosParamCreator(configuration)
|
|
234
220
|
return {
|
|
235
221
|
/**
|
|
236
|
-
*
|
|
237
|
-
* @summary Create
|
|
222
|
+
* This will create a payment for a specified account. This function is idempotent.
|
|
223
|
+
* @summary Create the payment
|
|
238
224
|
* @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
|
|
239
225
|
* @param {CreatePaymentRequestDto} createPaymentRequestDto
|
|
240
226
|
* @param {string} [authorization] Bearer Token
|
|
241
227
|
* @param {*} [options] Override http request option.
|
|
242
228
|
* @throws {RequiredError}
|
|
243
229
|
*/
|
|
244
|
-
async createPayment(idempotencyKey: string, createPaymentRequestDto: CreatePaymentRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
230
|
+
async createPayment(idempotencyKey: string, createPaymentRequestDto: CreatePaymentRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
245
231
|
const localVarAxiosArgs = await localVarAxiosParamCreator.createPayment(idempotencyKey, createPaymentRequestDto, authorization, options);
|
|
246
232
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
247
233
|
},
|
|
248
234
|
/**
|
|
249
|
-
* Retrieves the details of
|
|
250
|
-
* @summary Retrieve
|
|
235
|
+
* 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.
|
|
236
|
+
* @summary Retrieve the payment
|
|
251
237
|
* @param {string} code Unique identifier for the object.
|
|
252
238
|
* @param {string} [authorization] Bearer Token
|
|
253
|
-
* @param {string} [expand]
|
|
254
|
-
* @param {string} [expand2] Fields to expand response by
|
|
239
|
+
* @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>
|
|
255
240
|
* @param {*} [options] Override http request option.
|
|
256
241
|
* @throws {RequiredError}
|
|
257
242
|
*/
|
|
258
|
-
async getPayment(code: string, authorization?: string, expand?: string,
|
|
259
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getPayment(code, authorization, expand,
|
|
243
|
+
async getPayment(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
244
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getPayment(code, authorization, expand, options);
|
|
260
245
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
261
246
|
},
|
|
262
247
|
/**
|
|
263
|
-
* Returns a list of payments you
|
|
248
|
+
* 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.
|
|
264
249
|
* @summary List payments
|
|
265
250
|
* @param {string} [authorization] Bearer Token
|
|
266
251
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
267
252
|
* @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.
|
|
268
|
-
* @param {
|
|
269
|
-
* @param {any} [search]
|
|
270
|
-
* @param {
|
|
271
|
-
* @param {
|
|
272
|
-
* @param {
|
|
253
|
+
* @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>
|
|
254
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
255
|
+
* @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>
|
|
256
|
+
* @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>
|
|
257
|
+
* @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>
|
|
273
258
|
* @param {*} [options] Override http request option.
|
|
274
259
|
* @throws {RequiredError}
|
|
275
260
|
*/
|
|
276
|
-
async listPayments(authorization?: string, pageSize?: any, pageToken?: any, filter?:
|
|
261
|
+
async 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>> {
|
|
277
262
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listPayments(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
278
263
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
279
264
|
},
|
|
@@ -288,45 +273,44 @@ export const PaymentsApiFactory = function (configuration?: Configuration, baseP
|
|
|
288
273
|
const localVarFp = PaymentsApiFp(configuration)
|
|
289
274
|
return {
|
|
290
275
|
/**
|
|
291
|
-
*
|
|
292
|
-
* @summary Create
|
|
276
|
+
* This will create a payment for a specified account. This function is idempotent.
|
|
277
|
+
* @summary Create the payment
|
|
293
278
|
* @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
|
|
294
279
|
* @param {CreatePaymentRequestDto} createPaymentRequestDto
|
|
295
280
|
* @param {string} [authorization] Bearer Token
|
|
296
281
|
* @param {*} [options] Override http request option.
|
|
297
282
|
* @throws {RequiredError}
|
|
298
283
|
*/
|
|
299
|
-
createPayment(idempotencyKey: string, createPaymentRequestDto: CreatePaymentRequestDto, authorization?: string, options?: any): AxiosPromise<
|
|
284
|
+
createPayment(idempotencyKey: string, createPaymentRequestDto: CreatePaymentRequestDto, authorization?: string, options?: any): AxiosPromise<void> {
|
|
300
285
|
return localVarFp.createPayment(idempotencyKey, createPaymentRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
301
286
|
},
|
|
302
287
|
/**
|
|
303
|
-
* Retrieves the details of
|
|
304
|
-
* @summary Retrieve
|
|
288
|
+
* 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.
|
|
289
|
+
* @summary Retrieve the payment
|
|
305
290
|
* @param {string} code Unique identifier for the object.
|
|
306
291
|
* @param {string} [authorization] Bearer Token
|
|
307
|
-
* @param {string} [expand]
|
|
308
|
-
* @param {string} [expand2] Fields to expand response by
|
|
292
|
+
* @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>
|
|
309
293
|
* @param {*} [options] Override http request option.
|
|
310
294
|
* @throws {RequiredError}
|
|
311
295
|
*/
|
|
312
|
-
getPayment(code: string, authorization?: string, expand?: string,
|
|
313
|
-
return localVarFp.getPayment(code, authorization, expand,
|
|
296
|
+
getPayment(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<void> {
|
|
297
|
+
return localVarFp.getPayment(code, authorization, expand, options).then((request) => request(axios, basePath));
|
|
314
298
|
},
|
|
315
299
|
/**
|
|
316
|
-
* Returns a list of payments you
|
|
300
|
+
* 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.
|
|
317
301
|
* @summary List payments
|
|
318
302
|
* @param {string} [authorization] Bearer Token
|
|
319
303
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
320
304
|
* @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.
|
|
321
|
-
* @param {
|
|
322
|
-
* @param {any} [search]
|
|
323
|
-
* @param {
|
|
324
|
-
* @param {
|
|
325
|
-
* @param {
|
|
305
|
+
* @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>
|
|
306
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
307
|
+
* @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>
|
|
308
|
+
* @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>
|
|
309
|
+
* @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>
|
|
326
310
|
* @param {*} [options] Override http request option.
|
|
327
311
|
* @throws {RequiredError}
|
|
328
312
|
*/
|
|
329
|
-
listPayments(authorization?: string, pageSize?: any, pageToken?: any, filter?:
|
|
313
|
+
listPayments(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<void> {
|
|
330
314
|
return localVarFp.listPayments(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
331
315
|
},
|
|
332
316
|
};
|
|
@@ -381,18 +365,11 @@ export interface PaymentsApiGetPaymentRequest {
|
|
|
381
365
|
readonly authorization?: string
|
|
382
366
|
|
|
383
367
|
/**
|
|
384
|
-
*
|
|
368
|
+
* 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>
|
|
385
369
|
* @type {string}
|
|
386
370
|
* @memberof PaymentsApiGetPayment
|
|
387
371
|
*/
|
|
388
372
|
readonly expand?: string
|
|
389
|
-
|
|
390
|
-
/**
|
|
391
|
-
* Fields to expand response by
|
|
392
|
-
* @type {string}
|
|
393
|
-
* @memberof PaymentsApiGetPayment
|
|
394
|
-
*/
|
|
395
|
-
readonly expand2?: string
|
|
396
373
|
}
|
|
397
374
|
|
|
398
375
|
/**
|
|
@@ -423,39 +400,39 @@ export interface PaymentsApiListPaymentsRequest {
|
|
|
423
400
|
readonly pageToken?: any
|
|
424
401
|
|
|
425
402
|
/**
|
|
426
|
-
* Filter the response by one or multiple fields.
|
|
427
|
-
* @type {
|
|
403
|
+
* 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>
|
|
404
|
+
* @type {string}
|
|
428
405
|
* @memberof PaymentsApiListPayments
|
|
429
406
|
*/
|
|
430
|
-
readonly filter?:
|
|
407
|
+
readonly filter?: string
|
|
431
408
|
|
|
432
409
|
/**
|
|
433
|
-
*
|
|
410
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
434
411
|
* @type {any}
|
|
435
412
|
* @memberof PaymentsApiListPayments
|
|
436
413
|
*/
|
|
437
414
|
readonly search?: any
|
|
438
415
|
|
|
439
416
|
/**
|
|
440
|
-
*
|
|
441
|
-
* @type {
|
|
417
|
+
* 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>
|
|
418
|
+
* @type {string}
|
|
442
419
|
* @memberof PaymentsApiListPayments
|
|
443
420
|
*/
|
|
444
|
-
readonly order?:
|
|
421
|
+
readonly order?: string
|
|
445
422
|
|
|
446
423
|
/**
|
|
447
|
-
*
|
|
448
|
-
* @type {
|
|
424
|
+
* 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>
|
|
425
|
+
* @type {string}
|
|
449
426
|
* @memberof PaymentsApiListPayments
|
|
450
427
|
*/
|
|
451
|
-
readonly expand?:
|
|
428
|
+
readonly expand?: string
|
|
452
429
|
|
|
453
430
|
/**
|
|
454
|
-
* Filters the response by one or multiple fields.
|
|
455
|
-
* @type {
|
|
431
|
+
* 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>
|
|
432
|
+
* @type {string}
|
|
456
433
|
* @memberof PaymentsApiListPayments
|
|
457
434
|
*/
|
|
458
|
-
readonly filters?:
|
|
435
|
+
readonly filters?: string
|
|
459
436
|
}
|
|
460
437
|
|
|
461
438
|
/**
|
|
@@ -466,8 +443,8 @@ export interface PaymentsApiListPaymentsRequest {
|
|
|
466
443
|
*/
|
|
467
444
|
export class PaymentsApi extends BaseAPI {
|
|
468
445
|
/**
|
|
469
|
-
*
|
|
470
|
-
* @summary Create
|
|
446
|
+
* This will create a payment for a specified account. This function is idempotent.
|
|
447
|
+
* @summary Create the payment
|
|
471
448
|
* @param {PaymentsApiCreatePaymentRequest} requestParameters Request parameters.
|
|
472
449
|
* @param {*} [options] Override http request option.
|
|
473
450
|
* @throws {RequiredError}
|
|
@@ -478,19 +455,19 @@ export class PaymentsApi extends BaseAPI {
|
|
|
478
455
|
}
|
|
479
456
|
|
|
480
457
|
/**
|
|
481
|
-
* Retrieves the details of
|
|
482
|
-
* @summary Retrieve
|
|
458
|
+
* 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.
|
|
459
|
+
* @summary Retrieve the payment
|
|
483
460
|
* @param {PaymentsApiGetPaymentRequest} requestParameters Request parameters.
|
|
484
461
|
* @param {*} [options] Override http request option.
|
|
485
462
|
* @throws {RequiredError}
|
|
486
463
|
* @memberof PaymentsApi
|
|
487
464
|
*/
|
|
488
465
|
public getPayment(requestParameters: PaymentsApiGetPaymentRequest, options?: AxiosRequestConfig) {
|
|
489
|
-
return PaymentsApiFp(this.configuration).getPayment(requestParameters.code, requestParameters.authorization, requestParameters.expand,
|
|
466
|
+
return PaymentsApiFp(this.configuration).getPayment(requestParameters.code, requestParameters.authorization, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
|
|
490
467
|
}
|
|
491
468
|
|
|
492
469
|
/**
|
|
493
|
-
* Returns a list of payments you
|
|
470
|
+
* 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.
|
|
494
471
|
* @summary List payments
|
|
495
472
|
* @param {PaymentsApiListPaymentsRequest} requestParameters Request parameters.
|
|
496
473
|
* @param {*} [options] Override http request option.
|