@emilgroup/payment-sdk 1.4.1-beta.3 → 1.4.1-beta.30
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 +10 -27
- package/README.md +2 -2
- package/api/bank-accounts-api.ts +497 -43
- package/api/bank-transaction-api.ts +89 -53
- package/api/default-api.ts +1 -1
- package/api/payment-methods-api.ts +62 -173
- package/api/payment-reminders-api.ts +21 -25
- package/api/payment-setup-api.ts +29 -37
- package/api/payments-api.ts +54 -59
- package/api/refunds-api.ts +20 -18
- package/api/tenant-bank-account-api.ts +71 -61
- package/api/webhooks-api.ts +1 -1
- package/api.ts +1 -1
- package/base.ts +6 -2
- package/common.ts +2 -2
- package/configuration.ts +1 -1
- package/dist/api/bank-accounts-api.d.ts +295 -45
- package/dist/api/bank-accounts-api.js +412 -24
- package/dist/api/bank-transaction-api.d.ts +65 -45
- package/dist/api/bank-transaction-api.js +55 -40
- package/dist/api/default-api.d.ts +1 -1
- package/dist/api/default-api.js +1 -1
- package/dist/api/payment-methods-api.d.ts +48 -107
- package/dist/api/payment-methods-api.js +51 -143
- package/dist/api/payment-reminders-api.d.ts +25 -27
- package/dist/api/payment-reminders-api.js +12 -12
- 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 +46 -49
- package/dist/api/payments-api.js +43 -41
- package/dist/api/refunds-api.d.ts +15 -15
- package/dist/api/refunds-api.js +15 -13
- package/dist/api/tenant-bank-account-api.d.ts +70 -57
- package/dist/api/tenant-bank-account-api.js +56 -42
- package/dist/api/webhooks-api.d.ts +1 -1
- package/dist/api/webhooks-api.js +1 -1
- package/dist/api.d.ts +1 -1
- package/dist/api.js +1 -1
- 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-account-class.d.ts +23 -4
- package/dist/models/bank-account-class.js +1 -1
- package/dist/models/bank-transaction-response-class.d.ts +7 -1
- package/dist/models/bank-transaction-response-class.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-refund-response-class.d.ts +1 -1
- package/dist/models/create-refund-response-class.js +1 -1
- package/dist/models/create-tenant-bank-account-request-dto.d.ts +1 -1
- package/dist/models/create-tenant-bank-account-request-dto.js +1 -1
- package/dist/models/create-tenant-bank-account-response-class.d.ts +25 -0
- package/dist/models/{complete-payment-setup-request-dto.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-bank-account-response-class.d.ts +25 -0
- package/dist/models/{billing-profile-dto.js → get-bank-account-response-class.js} +1 -1
- package/dist/models/get-bank-transactions-response-class.d.ts +1 -1
- package/dist/models/get-bank-transactions-response-class.js +1 -1
- package/dist/models/get-refund-response-class.d.ts +1 -1
- package/dist/models/get-refund-response-class.js +1 -1
- package/dist/models/get-request-dto.d.ts +2 -2
- package/dist/models/get-request-dto.js +1 -1
- package/dist/models/get-tenant-bank-account-response-class.d.ts +1 -1
- package/dist/models/get-tenant-bank-account-response-class.js +1 -1
- package/dist/models/index.d.ts +10 -27
- package/dist/models/index.js +10 -27
- 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/{complete-braintree-payment-setup-request-dto.js → link-bank-transaction-request-dto-rest.js} +1 -1
- package/dist/models/list-bank-transactions-response-class.d.ts +1 -1
- package/dist/models/list-bank-transactions-response-class.js +1 -1
- package/dist/models/list-refunds-response-class.d.ts +1 -1
- package/dist/models/list-refunds-response-class.js +1 -1
- package/dist/models/list-tenant-bank-account-response-class.d.ts +31 -0
- package/dist/models/{billing-profile-limited-response-dto.js → list-tenant-bank-account-response-class.js} +1 -1
- package/dist/models/primary-bank-account-response-class.d.ts +42 -0
- package/dist/models/primary-bank-account-response-class.js +15 -0
- package/dist/models/refund-class.d.ts +2 -1
- package/dist/models/refund-class.js +3 -2
- 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 +1 -1
- package/dist/models/tenant-bank-account-response-class.js +1 -1
- package/dist/models/transaction-class.d.ts +1 -1
- package/dist/models/transaction-class.js +1 -1
- 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-bank-account-response-class.d.ts +25 -0
- package/dist/models/update-bank-account-response-class.js +15 -0
- package/dist/models/update-tenant-bank-account-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-account-class.ts +23 -4
- package/models/bank-transaction-response-class.ts +7 -1
- 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-refund-response-class.ts +1 -1
- package/models/create-tenant-bank-account-request-dto.ts +1 -1
- package/models/create-tenant-bank-account-response-class.ts +31 -0
- package/models/deactivate-payment-reminder-request-dto.ts +1 -1
- package/models/get-bank-account-response-class.ts +31 -0
- package/models/get-bank-transactions-response-class.ts +1 -1
- package/models/get-refund-response-class.ts +1 -1
- package/models/get-request-dto.ts +2 -2
- package/models/get-tenant-bank-account-response-class.ts +1 -1
- package/models/index.ts +10 -27
- 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-bank-transactions-response-class.ts +1 -1
- package/models/list-refunds-response-class.ts +1 -1
- package/models/list-tenant-bank-account-response-class.ts +37 -0
- package/models/primary-bank-account-response-class.ts +48 -0
- package/models/refund-class.ts +3 -2
- package/models/set-primary-bank-account-request-dto-rest.ts +30 -0
- package/models/tenant-bank-account-response-class.ts +1 -1
- package/models/transaction-class.ts +1 -1
- 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-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/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-payment-setup-request-dto.d.ts +0 -32
- 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/deactivate-payment-reminder-response-class.d.ts +0 -25
- package/dist/models/deactivate-payment-reminder-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/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-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/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/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/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/deactivate-payment-reminder-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/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-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/payment-class.ts +0 -109
- package/models/payment-method-class.ts +0 -72
- package/models/payment-reminder-class.ts +0 -122
- package/models/sepa-direct-dto.ts +0 -30
- package/models/symphony-profile-limited-response-dto.ts +0 -48
|
@@ -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,9 +13,6 @@ 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
|
|
@@ -23,7 +20,7 @@ import { ListPaymentsResponseClass } from '../models';
|
|
|
23
20
|
export declare const PaymentsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
24
21
|
/**
|
|
25
22
|
* Creates a payment for a specified account. This function is idempotent.
|
|
26
|
-
* @summary Create
|
|
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,24 +29,24 @@ 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
|
|
37
|
-
* @param {string} code
|
|
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
|
|
34
|
+
* @param {string} code
|
|
35
|
+
* @param {string} code2 Unique identifier for the object.
|
|
36
|
+
* @param {string} expand Fields to expand response by
|
|
38
37
|
* @param {string} [authorization] Bearer Token
|
|
39
|
-
* @param {string} [expand] Fields to expand response by
|
|
40
|
-
* @param {string} [expand2] Fields to expand response by
|
|
41
38
|
* @param {*} [options] Override http request option.
|
|
42
39
|
* @throws {RequiredError}
|
|
43
40
|
*/
|
|
44
|
-
getPayment: (code: string,
|
|
41
|
+
getPayment: (code: string, code2: string, expand: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
45
42
|
/**
|
|
46
|
-
* Returns a list of payments you
|
|
43
|
+
* 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
44
|
* @summary List payments
|
|
48
45
|
* @param {string} [authorization] Bearer Token
|
|
49
46
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
50
47
|
* @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
48
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
52
|
-
* @param {any} [search]
|
|
49
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
53
50
|
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
54
51
|
* @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
55
52
|
* @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
@@ -65,40 +62,40 @@ export declare const PaymentsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
65
62
|
export declare const PaymentsApiFp: (configuration?: Configuration) => {
|
|
66
63
|
/**
|
|
67
64
|
* Creates a payment for a specified account. This function is idempotent.
|
|
68
|
-
* @summary Create
|
|
65
|
+
* @summary Create the payment
|
|
69
66
|
* @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
|
|
70
67
|
* @param {CreatePaymentRequestDto} createPaymentRequestDto
|
|
71
68
|
* @param {string} [authorization] Bearer Token
|
|
72
69
|
* @param {*} [options] Override http request option.
|
|
73
70
|
* @throws {RequiredError}
|
|
74
71
|
*/
|
|
75
|
-
createPayment(idempotencyKey: string, createPaymentRequestDto: CreatePaymentRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
72
|
+
createPayment(idempotencyKey: string, createPaymentRequestDto: CreatePaymentRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
76
73
|
/**
|
|
77
|
-
* Retrieves the details of
|
|
78
|
-
* @summary Retrieve
|
|
79
|
-
* @param {string} code
|
|
74
|
+
* 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.
|
|
75
|
+
* @summary Retrieve the payment
|
|
76
|
+
* @param {string} code
|
|
77
|
+
* @param {string} code2 Unique identifier for the object.
|
|
78
|
+
* @param {string} expand Fields to expand response by
|
|
80
79
|
* @param {string} [authorization] Bearer Token
|
|
81
|
-
* @param {string} [expand] Fields to expand response by
|
|
82
|
-
* @param {string} [expand2] Fields to expand response by
|
|
83
80
|
* @param {*} [options] Override http request option.
|
|
84
81
|
* @throws {RequiredError}
|
|
85
82
|
*/
|
|
86
|
-
getPayment(code: string,
|
|
83
|
+
getPayment(code: string, code2: string, expand: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
87
84
|
/**
|
|
88
|
-
* Returns a list of payments you
|
|
85
|
+
* 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
86
|
* @summary List payments
|
|
90
87
|
* @param {string} [authorization] Bearer Token
|
|
91
88
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
92
89
|
* @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
90
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
94
|
-
* @param {any} [search]
|
|
91
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
95
92
|
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
96
93
|
* @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
97
94
|
* @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
98
95
|
* @param {*} [options] Override http request option.
|
|
99
96
|
* @throws {RequiredError}
|
|
100
97
|
*/
|
|
101
|
-
listPayments(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
98
|
+
listPayments(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
102
99
|
};
|
|
103
100
|
/**
|
|
104
101
|
* PaymentsApi - factory interface
|
|
@@ -107,40 +104,40 @@ export declare const PaymentsApiFp: (configuration?: Configuration) => {
|
|
|
107
104
|
export declare const PaymentsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
108
105
|
/**
|
|
109
106
|
* Creates a payment for a specified account. This function is idempotent.
|
|
110
|
-
* @summary Create
|
|
107
|
+
* @summary Create the payment
|
|
111
108
|
* @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
|
|
112
109
|
* @param {CreatePaymentRequestDto} createPaymentRequestDto
|
|
113
110
|
* @param {string} [authorization] Bearer Token
|
|
114
111
|
* @param {*} [options] Override http request option.
|
|
115
112
|
* @throws {RequiredError}
|
|
116
113
|
*/
|
|
117
|
-
createPayment(idempotencyKey: string, createPaymentRequestDto: CreatePaymentRequestDto, authorization?: string, options?: any): AxiosPromise<
|
|
114
|
+
createPayment(idempotencyKey: string, createPaymentRequestDto: CreatePaymentRequestDto, authorization?: string, options?: any): AxiosPromise<void>;
|
|
118
115
|
/**
|
|
119
|
-
* Retrieves the details of
|
|
120
|
-
* @summary Retrieve
|
|
121
|
-
* @param {string} code
|
|
116
|
+
* 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.
|
|
117
|
+
* @summary Retrieve the payment
|
|
118
|
+
* @param {string} code
|
|
119
|
+
* @param {string} code2 Unique identifier for the object.
|
|
120
|
+
* @param {string} expand Fields to expand response by
|
|
122
121
|
* @param {string} [authorization] Bearer Token
|
|
123
|
-
* @param {string} [expand] Fields to expand response by
|
|
124
|
-
* @param {string} [expand2] Fields to expand response by
|
|
125
122
|
* @param {*} [options] Override http request option.
|
|
126
123
|
* @throws {RequiredError}
|
|
127
124
|
*/
|
|
128
|
-
getPayment(code: string,
|
|
125
|
+
getPayment(code: string, code2: string, expand: string, authorization?: string, options?: any): AxiosPromise<void>;
|
|
129
126
|
/**
|
|
130
|
-
* Returns a list of payments you
|
|
127
|
+
* 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
128
|
* @summary List payments
|
|
132
129
|
* @param {string} [authorization] Bearer Token
|
|
133
130
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
134
131
|
* @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
132
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
136
|
-
* @param {any} [search]
|
|
133
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
137
134
|
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
138
135
|
* @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
139
136
|
* @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
140
137
|
* @param {*} [options] Override http request option.
|
|
141
138
|
* @throws {RequiredError}
|
|
142
139
|
*/
|
|
143
|
-
listPayments(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: any): AxiosPromise<
|
|
140
|
+
listPayments(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: any): AxiosPromise<void>;
|
|
144
141
|
};
|
|
145
142
|
/**
|
|
146
143
|
* Request parameters for createPayment operation in PaymentsApi.
|
|
@@ -174,29 +171,29 @@ export interface PaymentsApiCreatePaymentRequest {
|
|
|
174
171
|
*/
|
|
175
172
|
export interface PaymentsApiGetPaymentRequest {
|
|
176
173
|
/**
|
|
177
|
-
*
|
|
174
|
+
*
|
|
178
175
|
* @type {string}
|
|
179
176
|
* @memberof PaymentsApiGetPayment
|
|
180
177
|
*/
|
|
181
178
|
readonly code: string;
|
|
182
179
|
/**
|
|
183
|
-
*
|
|
180
|
+
* Unique identifier for the object.
|
|
184
181
|
* @type {string}
|
|
185
182
|
* @memberof PaymentsApiGetPayment
|
|
186
183
|
*/
|
|
187
|
-
readonly
|
|
184
|
+
readonly code2: string;
|
|
188
185
|
/**
|
|
189
186
|
* Fields to expand response by
|
|
190
187
|
* @type {string}
|
|
191
188
|
* @memberof PaymentsApiGetPayment
|
|
192
189
|
*/
|
|
193
|
-
readonly expand
|
|
190
|
+
readonly expand: string;
|
|
194
191
|
/**
|
|
195
|
-
*
|
|
192
|
+
* Bearer Token
|
|
196
193
|
* @type {string}
|
|
197
194
|
* @memberof PaymentsApiGetPayment
|
|
198
195
|
*/
|
|
199
|
-
readonly
|
|
196
|
+
readonly authorization?: string;
|
|
200
197
|
}
|
|
201
198
|
/**
|
|
202
199
|
* Request parameters for listPayments operation in PaymentsApi.
|
|
@@ -229,7 +226,7 @@ export interface PaymentsApiListPaymentsRequest {
|
|
|
229
226
|
*/
|
|
230
227
|
readonly filter?: any;
|
|
231
228
|
/**
|
|
232
|
-
*
|
|
229
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
233
230
|
* @type {any}
|
|
234
231
|
* @memberof PaymentsApiListPayments
|
|
235
232
|
*/
|
|
@@ -262,29 +259,29 @@ export interface PaymentsApiListPaymentsRequest {
|
|
|
262
259
|
export declare class PaymentsApi extends BaseAPI {
|
|
263
260
|
/**
|
|
264
261
|
* Creates a payment for a specified account. This function is idempotent.
|
|
265
|
-
* @summary Create
|
|
262
|
+
* @summary Create the payment
|
|
266
263
|
* @param {PaymentsApiCreatePaymentRequest} requestParameters Request parameters.
|
|
267
264
|
* @param {*} [options] Override http request option.
|
|
268
265
|
* @throws {RequiredError}
|
|
269
266
|
* @memberof PaymentsApi
|
|
270
267
|
*/
|
|
271
|
-
createPayment(requestParameters: PaymentsApiCreatePaymentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
268
|
+
createPayment(requestParameters: PaymentsApiCreatePaymentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
272
269
|
/**
|
|
273
|
-
* Retrieves the details of
|
|
274
|
-
* @summary Retrieve
|
|
270
|
+
* 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.
|
|
271
|
+
* @summary Retrieve the payment
|
|
275
272
|
* @param {PaymentsApiGetPaymentRequest} requestParameters Request parameters.
|
|
276
273
|
* @param {*} [options] Override http request option.
|
|
277
274
|
* @throws {RequiredError}
|
|
278
275
|
* @memberof PaymentsApi
|
|
279
276
|
*/
|
|
280
|
-
getPayment(requestParameters: PaymentsApiGetPaymentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
277
|
+
getPayment(requestParameters: PaymentsApiGetPaymentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
281
278
|
/**
|
|
282
|
-
* Returns a list of payments you
|
|
279
|
+
* 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
280
|
* @summary List payments
|
|
284
281
|
* @param {PaymentsApiListPaymentsRequest} requestParameters Request parameters.
|
|
285
282
|
* @param {*} [options] Override http request option.
|
|
286
283
|
* @throws {RequiredError}
|
|
287
284
|
* @memberof PaymentsApi
|
|
288
285
|
*/
|
|
289
|
-
listPayments(requestParameters?: PaymentsApiListPaymentsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
286
|
+
listPayments(requestParameters?: PaymentsApiListPaymentsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
290
287
|
}
|
package/dist/api/payments-api.js
CHANGED
|
@@ -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,7 +94,7 @@ var PaymentsApiAxiosParamCreator = function (configuration) {
|
|
|
94
94
|
return {
|
|
95
95
|
/**
|
|
96
96
|
* Creates a payment for a specified account. This function is idempotent.
|
|
97
|
-
* @summary Create
|
|
97
|
+
* @summary Create the payment
|
|
98
98
|
* @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
|
|
99
99
|
* @param {CreatePaymentRequestDto} createPaymentRequestDto
|
|
100
100
|
* @param {string} [authorization] Bearer Token
|
|
@@ -148,16 +148,16 @@ var PaymentsApiAxiosParamCreator = function (configuration) {
|
|
|
148
148
|
});
|
|
149
149
|
},
|
|
150
150
|
/**
|
|
151
|
-
* Retrieves the details of
|
|
152
|
-
* @summary Retrieve
|
|
153
|
-
* @param {string} code
|
|
151
|
+
* 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.
|
|
152
|
+
* @summary Retrieve the payment
|
|
153
|
+
* @param {string} code
|
|
154
|
+
* @param {string} code2 Unique identifier for the object.
|
|
155
|
+
* @param {string} expand Fields to expand response by
|
|
154
156
|
* @param {string} [authorization] Bearer Token
|
|
155
|
-
* @param {string} [expand] Fields to expand response by
|
|
156
|
-
* @param {string} [expand2] Fields to expand response by
|
|
157
157
|
* @param {*} [options] Override http request option.
|
|
158
158
|
* @throws {RequiredError}
|
|
159
159
|
*/
|
|
160
|
-
getPayment: function (code,
|
|
160
|
+
getPayment: function (code, code2, expand, authorization, options) {
|
|
161
161
|
if (options === void 0) { options = {}; }
|
|
162
162
|
return __awaiter(_this, void 0, void 0, function () {
|
|
163
163
|
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
@@ -166,7 +166,12 @@ var PaymentsApiAxiosParamCreator = function (configuration) {
|
|
|
166
166
|
case 0:
|
|
167
167
|
// verify required parameter 'code' is not null or undefined
|
|
168
168
|
(0, common_1.assertParamExists)('getPayment', 'code', code);
|
|
169
|
-
|
|
169
|
+
// verify required parameter 'code2' is not null or undefined
|
|
170
|
+
(0, common_1.assertParamExists)('getPayment', 'code2', code2);
|
|
171
|
+
// verify required parameter 'expand' is not null or undefined
|
|
172
|
+
(0, common_1.assertParamExists)('getPayment', 'expand', expand);
|
|
173
|
+
localVarPath = "/paymentservice/v1/payments/{code}"
|
|
174
|
+
.replace("{".concat("code", "}"), encodeURIComponent(String(code)));
|
|
170
175
|
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
171
176
|
if (configuration) {
|
|
172
177
|
baseOptions = configuration.baseOptions;
|
|
@@ -182,15 +187,12 @@ var PaymentsApiAxiosParamCreator = function (configuration) {
|
|
|
182
187
|
// authentication bearer required
|
|
183
188
|
// http bearer authentication required
|
|
184
189
|
_a.sent();
|
|
185
|
-
if (
|
|
186
|
-
localVarQueryParameter['code'] =
|
|
190
|
+
if (code2 !== undefined) {
|
|
191
|
+
localVarQueryParameter['code'] = code2;
|
|
187
192
|
}
|
|
188
193
|
if (expand !== undefined) {
|
|
189
194
|
localVarQueryParameter['expand'] = expand;
|
|
190
195
|
}
|
|
191
|
-
if (expand2 !== undefined) {
|
|
192
|
-
localVarQueryParameter['expand'] = expand2;
|
|
193
|
-
}
|
|
194
196
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
195
197
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
196
198
|
}
|
|
@@ -206,13 +208,13 @@ var PaymentsApiAxiosParamCreator = function (configuration) {
|
|
|
206
208
|
});
|
|
207
209
|
},
|
|
208
210
|
/**
|
|
209
|
-
* Returns a list of payments you
|
|
211
|
+
* 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.
|
|
210
212
|
* @summary List payments
|
|
211
213
|
* @param {string} [authorization] Bearer Token
|
|
212
214
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
213
215
|
* @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.
|
|
214
216
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
215
|
-
* @param {any} [search]
|
|
217
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
216
218
|
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
217
219
|
* @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
218
220
|
* @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
@@ -289,7 +291,7 @@ var PaymentsApiFp = function (configuration) {
|
|
|
289
291
|
return {
|
|
290
292
|
/**
|
|
291
293
|
* Creates a payment for a specified account. This function is idempotent.
|
|
292
|
-
* @summary Create
|
|
294
|
+
* @summary Create the payment
|
|
293
295
|
* @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
|
|
294
296
|
* @param {CreatePaymentRequestDto} createPaymentRequestDto
|
|
295
297
|
* @param {string} [authorization] Bearer Token
|
|
@@ -310,21 +312,21 @@ var PaymentsApiFp = function (configuration) {
|
|
|
310
312
|
});
|
|
311
313
|
},
|
|
312
314
|
/**
|
|
313
|
-
* Retrieves the details of
|
|
314
|
-
* @summary Retrieve
|
|
315
|
-
* @param {string} code
|
|
315
|
+
* 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.
|
|
316
|
+
* @summary Retrieve the payment
|
|
317
|
+
* @param {string} code
|
|
318
|
+
* @param {string} code2 Unique identifier for the object.
|
|
319
|
+
* @param {string} expand Fields to expand response by
|
|
316
320
|
* @param {string} [authorization] Bearer Token
|
|
317
|
-
* @param {string} [expand] Fields to expand response by
|
|
318
|
-
* @param {string} [expand2] Fields to expand response by
|
|
319
321
|
* @param {*} [options] Override http request option.
|
|
320
322
|
* @throws {RequiredError}
|
|
321
323
|
*/
|
|
322
|
-
getPayment: function (code,
|
|
324
|
+
getPayment: function (code, code2, expand, authorization, options) {
|
|
323
325
|
return __awaiter(this, void 0, void 0, function () {
|
|
324
326
|
var localVarAxiosArgs;
|
|
325
327
|
return __generator(this, function (_a) {
|
|
326
328
|
switch (_a.label) {
|
|
327
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.getPayment(code,
|
|
329
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.getPayment(code, code2, expand, authorization, options)];
|
|
328
330
|
case 1:
|
|
329
331
|
localVarAxiosArgs = _a.sent();
|
|
330
332
|
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
@@ -333,13 +335,13 @@ var PaymentsApiFp = function (configuration) {
|
|
|
333
335
|
});
|
|
334
336
|
},
|
|
335
337
|
/**
|
|
336
|
-
* Returns a list of payments you
|
|
338
|
+
* 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.
|
|
337
339
|
* @summary List payments
|
|
338
340
|
* @param {string} [authorization] Bearer Token
|
|
339
341
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
340
342
|
* @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.
|
|
341
343
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
342
|
-
* @param {any} [search]
|
|
344
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
343
345
|
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
344
346
|
* @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
345
347
|
* @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
@@ -371,7 +373,7 @@ var PaymentsApiFactory = function (configuration, basePath, axios) {
|
|
|
371
373
|
return {
|
|
372
374
|
/**
|
|
373
375
|
* Creates a payment for a specified account. This function is idempotent.
|
|
374
|
-
* @summary Create
|
|
376
|
+
* @summary Create the payment
|
|
375
377
|
* @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
|
|
376
378
|
* @param {CreatePaymentRequestDto} createPaymentRequestDto
|
|
377
379
|
* @param {string} [authorization] Bearer Token
|
|
@@ -382,26 +384,26 @@ var PaymentsApiFactory = function (configuration, basePath, axios) {
|
|
|
382
384
|
return localVarFp.createPayment(idempotencyKey, createPaymentRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
383
385
|
},
|
|
384
386
|
/**
|
|
385
|
-
* Retrieves the details of
|
|
386
|
-
* @summary Retrieve
|
|
387
|
-
* @param {string} code
|
|
387
|
+
* 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.
|
|
388
|
+
* @summary Retrieve the payment
|
|
389
|
+
* @param {string} code
|
|
390
|
+
* @param {string} code2 Unique identifier for the object.
|
|
391
|
+
* @param {string} expand Fields to expand response by
|
|
388
392
|
* @param {string} [authorization] Bearer Token
|
|
389
|
-
* @param {string} [expand] Fields to expand response by
|
|
390
|
-
* @param {string} [expand2] Fields to expand response by
|
|
391
393
|
* @param {*} [options] Override http request option.
|
|
392
394
|
* @throws {RequiredError}
|
|
393
395
|
*/
|
|
394
|
-
getPayment: function (code,
|
|
395
|
-
return localVarFp.getPayment(code,
|
|
396
|
+
getPayment: function (code, code2, expand, authorization, options) {
|
|
397
|
+
return localVarFp.getPayment(code, code2, expand, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
396
398
|
},
|
|
397
399
|
/**
|
|
398
|
-
* Returns a list of payments you
|
|
400
|
+
* 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.
|
|
399
401
|
* @summary List payments
|
|
400
402
|
* @param {string} [authorization] Bearer Token
|
|
401
403
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
402
404
|
* @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.
|
|
403
405
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
404
|
-
* @param {any} [search]
|
|
406
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
405
407
|
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
406
408
|
* @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
407
409
|
* @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
@@ -427,7 +429,7 @@ var PaymentsApi = /** @class */ (function (_super) {
|
|
|
427
429
|
}
|
|
428
430
|
/**
|
|
429
431
|
* Creates a payment for a specified account. This function is idempotent.
|
|
430
|
-
* @summary Create
|
|
432
|
+
* @summary Create the payment
|
|
431
433
|
* @param {PaymentsApiCreatePaymentRequest} requestParameters Request parameters.
|
|
432
434
|
* @param {*} [options] Override http request option.
|
|
433
435
|
* @throws {RequiredError}
|
|
@@ -438,8 +440,8 @@ var PaymentsApi = /** @class */ (function (_super) {
|
|
|
438
440
|
return (0, exports.PaymentsApiFp)(this.configuration).createPayment(requestParameters.idempotencyKey, requestParameters.createPaymentRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
439
441
|
};
|
|
440
442
|
/**
|
|
441
|
-
* Retrieves the details of
|
|
442
|
-
* @summary Retrieve
|
|
443
|
+
* 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.
|
|
444
|
+
* @summary Retrieve the payment
|
|
443
445
|
* @param {PaymentsApiGetPaymentRequest} requestParameters Request parameters.
|
|
444
446
|
* @param {*} [options] Override http request option.
|
|
445
447
|
* @throws {RequiredError}
|
|
@@ -447,10 +449,10 @@ var PaymentsApi = /** @class */ (function (_super) {
|
|
|
447
449
|
*/
|
|
448
450
|
PaymentsApi.prototype.getPayment = function (requestParameters, options) {
|
|
449
451
|
var _this = this;
|
|
450
|
-
return (0, exports.PaymentsApiFp)(this.configuration).getPayment(requestParameters.code, requestParameters.
|
|
452
|
+
return (0, exports.PaymentsApiFp)(this.configuration).getPayment(requestParameters.code, requestParameters.code2, requestParameters.expand, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
451
453
|
};
|
|
452
454
|
/**
|
|
453
|
-
* Returns a list of payments you
|
|
455
|
+
* 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.
|
|
454
456
|
* @summary List payments
|
|
455
457
|
* @param {PaymentsApiListPaymentsRequest} requestParameters Request parameters.
|
|
456
458
|
* @param {*} [options] Override http request option.
|
|
@@ -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
|
|
@@ -33,19 +33,19 @@ export declare const RefundsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
33
33
|
*
|
|
34
34
|
* @param {string} code
|
|
35
35
|
* @param {string} code2 Unique identifier for the object.
|
|
36
|
+
* @param {string} expand Fields to expand response by
|
|
36
37
|
* @param {string} [authorization] Bearer Token
|
|
37
|
-
* @param {string} [expand] Fields to expand response by
|
|
38
38
|
* @param {*} [options] Override http request option.
|
|
39
39
|
* @throws {RequiredError}
|
|
40
40
|
*/
|
|
41
|
-
getRefund: (code: string, code2: string,
|
|
41
|
+
getRefund: (code: string, code2: string, expand: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
42
42
|
/**
|
|
43
43
|
*
|
|
44
44
|
* @param {string} [authorization] Bearer Token
|
|
45
45
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
46
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.
|
|
47
47
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
48
|
-
* @param {any} [search]
|
|
48
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
49
49
|
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
50
50
|
* @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
51
51
|
* @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
@@ -71,19 +71,19 @@ export declare const RefundsApiFp: (configuration?: Configuration) => {
|
|
|
71
71
|
*
|
|
72
72
|
* @param {string} code
|
|
73
73
|
* @param {string} code2 Unique identifier for the object.
|
|
74
|
+
* @param {string} expand Fields to expand response by
|
|
74
75
|
* @param {string} [authorization] Bearer Token
|
|
75
|
-
* @param {string} [expand] Fields to expand response by
|
|
76
76
|
* @param {*} [options] Override http request option.
|
|
77
77
|
* @throws {RequiredError}
|
|
78
78
|
*/
|
|
79
|
-
getRefund(code: string, code2: string,
|
|
79
|
+
getRefund(code: string, code2: string, expand: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetRefundResponseClass>>;
|
|
80
80
|
/**
|
|
81
81
|
*
|
|
82
82
|
* @param {string} [authorization] Bearer Token
|
|
83
83
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
84
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.
|
|
85
85
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
86
|
-
* @param {any} [search]
|
|
86
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
87
87
|
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
88
88
|
* @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
89
89
|
* @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
@@ -109,19 +109,19 @@ export declare const RefundsApiFactory: (configuration?: Configuration, basePath
|
|
|
109
109
|
*
|
|
110
110
|
* @param {string} code
|
|
111
111
|
* @param {string} code2 Unique identifier for the object.
|
|
112
|
+
* @param {string} expand Fields to expand response by
|
|
112
113
|
* @param {string} [authorization] Bearer Token
|
|
113
|
-
* @param {string} [expand] Fields to expand response by
|
|
114
114
|
* @param {*} [options] Override http request option.
|
|
115
115
|
* @throws {RequiredError}
|
|
116
116
|
*/
|
|
117
|
-
getRefund(code: string, code2: string,
|
|
117
|
+
getRefund(code: string, code2: string, expand: string, authorization?: string, options?: any): AxiosPromise<GetRefundResponseClass>;
|
|
118
118
|
/**
|
|
119
119
|
*
|
|
120
120
|
* @param {string} [authorization] Bearer Token
|
|
121
121
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
122
122
|
* @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.
|
|
123
123
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
124
|
-
* @param {any} [search]
|
|
124
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
125
125
|
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
126
126
|
* @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
127
127
|
* @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
@@ -168,17 +168,17 @@ export interface RefundsApiGetRefundRequest {
|
|
|
168
168
|
*/
|
|
169
169
|
readonly code2: string;
|
|
170
170
|
/**
|
|
171
|
-
*
|
|
171
|
+
* Fields to expand response by
|
|
172
172
|
* @type {string}
|
|
173
173
|
* @memberof RefundsApiGetRefund
|
|
174
174
|
*/
|
|
175
|
-
readonly
|
|
175
|
+
readonly expand: string;
|
|
176
176
|
/**
|
|
177
|
-
*
|
|
177
|
+
* Bearer Token
|
|
178
178
|
* @type {string}
|
|
179
179
|
* @memberof RefundsApiGetRefund
|
|
180
180
|
*/
|
|
181
|
-
readonly
|
|
181
|
+
readonly authorization?: string;
|
|
182
182
|
}
|
|
183
183
|
/**
|
|
184
184
|
* Request parameters for listRefunds operation in RefundsApi.
|
|
@@ -211,7 +211,7 @@ export interface RefundsApiListRefundsRequest {
|
|
|
211
211
|
*/
|
|
212
212
|
readonly filter?: any;
|
|
213
213
|
/**
|
|
214
|
-
*
|
|
214
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
215
215
|
* @type {any}
|
|
216
216
|
* @memberof RefundsApiListRefunds
|
|
217
217
|
*/
|