@emilgroup/payment-sdk-node 1.21.1-beta.2 → 1.21.1-beta.21
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 -0
- package/README.md +2 -2
- package/api/bank-accounts-api.ts +79 -37
- package/api/bank-orders-api.ts +695 -0
- package/api/bank-transaction-api.ts +187 -56
- package/api/payment-methods-api.ts +67 -25
- package/api/payment-reminders-api.ts +85 -43
- package/api/payment-setup-api.ts +8 -8
- package/api/payments-api.ts +67 -25
- package/api/refunds-api.ts +57 -29
- package/api/tenant-bank-account-api.ts +45 -17
- package/api/webhooks-api.ts +4 -4
- package/api.ts +2 -0
- package/base.ts +1 -1
- package/dist/api/bank-accounts-api.d.ts +59 -32
- package/dist/api/bank-accounts-api.js +53 -35
- package/dist/api/bank-orders-api.d.ts +393 -0
- package/dist/api/bank-orders-api.js +646 -0
- package/dist/api/bank-transaction-api.d.ts +123 -49
- package/dist/api/bank-transaction-api.js +151 -47
- package/dist/api/payment-methods-api.d.ts +47 -20
- package/dist/api/payment-methods-api.js +41 -23
- package/dist/api/payment-reminders-api.d.ts +61 -34
- package/dist/api/payment-reminders-api.js +54 -36
- package/dist/api/payment-setup-api.d.ts +8 -8
- package/dist/api/payment-setup-api.js +8 -8
- package/dist/api/payments-api.d.ts +47 -20
- package/dist/api/payments-api.js +41 -23
- package/dist/api/refunds-api.d.ts +40 -22
- package/dist/api/refunds-api.js +36 -24
- package/dist/api/tenant-bank-account-api.d.ts +28 -10
- package/dist/api/tenant-bank-account-api.js +24 -12
- package/dist/api/webhooks-api.d.ts +4 -4
- package/dist/api/webhooks-api.js +4 -4
- package/dist/api.d.ts +1 -0
- package/dist/api.js +1 -0
- package/dist/models/bank-order-class.d.ts +115 -0
- package/dist/models/bank-order-class.js +15 -0
- package/dist/models/bank-transaction-class-without-expand-properties.d.ts +8 -2
- package/dist/models/bank-transaction-class.d.ts +22 -2
- package/dist/models/create-bank-order-request-dto.d.ts +74 -0
- package/dist/models/create-bank-order-request-dto.js +28 -0
- package/dist/models/create-bank-order-response-class.d.ts +25 -0
- package/dist/models/create-bank-order-response-class.js +15 -0
- package/dist/models/create-payment-reminder-request-dto.d.ts +7 -1
- package/dist/models/create-payment-request-dto.d.ts +7 -1
- package/dist/models/create-psp-payment-method-request-dto.d.ts +7 -1
- package/dist/models/deactivated-payment-reminder-class.d.ts +7 -1
- package/dist/models/financial-account-class.d.ts +111 -0
- package/dist/models/financial-account-class.js +24 -0
- package/dist/models/generate-invoice-match-suggestions-response-class.d.ts +25 -0
- package/dist/models/generate-invoice-match-suggestions-response-class.js +15 -0
- package/dist/models/get-bank-order-response-class.d.ts +25 -0
- package/dist/models/get-bank-order-response-class.js +15 -0
- package/dist/models/index.d.ts +11 -0
- package/dist/models/index.js +11 -0
- package/dist/models/initiate-adyen-payment-setup-request-dto.d.ts +6 -0
- package/dist/models/initiate-braintree-payment-setup-request-dto.d.ts +6 -0
- package/dist/models/initiate-stripe-payment-setup-request-dto.d.ts +6 -0
- package/dist/models/invoice-match-suggestion-class.d.ts +60 -0
- package/dist/models/invoice-match-suggestion-class.js +15 -0
- package/dist/models/list-bank-orders-response-class.d.ts +31 -0
- package/dist/models/list-bank-orders-response-class.js +15 -0
- package/dist/models/payment-class-without-expand-properties.d.ts +7 -1
- package/dist/models/payment-class.d.ts +7 -1
- package/dist/models/payment-reminder-class.d.ts +7 -1
- package/dist/models/refund-class.d.ts +7 -1
- package/dist/models/suggestion-generation-progress-class.d.ts +43 -0
- package/dist/models/suggestion-generation-progress-class.js +22 -0
- package/dist/models/unlinked-bank-transaction-response-class.d.ts +8 -2
- package/dist/models/update-bank-order-request-dto.d.ts +56 -0
- package/dist/models/update-bank-order-request-dto.js +23 -0
- package/dist/models/update-bank-order-response-class.d.ts +25 -0
- package/dist/models/update-bank-order-response-class.js +15 -0
- package/models/bank-order-class.ts +121 -0
- package/models/bank-transaction-class-without-expand-properties.ts +8 -2
- package/models/bank-transaction-class.ts +22 -2
- package/models/create-bank-order-request-dto.ts +84 -0
- package/models/create-bank-order-response-class.ts +31 -0
- package/models/create-payment-reminder-request-dto.ts +7 -1
- package/models/create-payment-request-dto.ts +7 -1
- package/models/create-psp-payment-method-request-dto.ts +7 -1
- package/models/deactivated-payment-reminder-class.ts +7 -1
- package/models/financial-account-class.ts +120 -0
- package/models/generate-invoice-match-suggestions-response-class.ts +31 -0
- package/models/get-bank-order-response-class.ts +31 -0
- package/models/index.ts +11 -0
- package/models/initiate-adyen-payment-setup-request-dto.ts +6 -0
- package/models/initiate-braintree-payment-setup-request-dto.ts +6 -0
- package/models/initiate-stripe-payment-setup-request-dto.ts +6 -0
- package/models/invoice-match-suggestion-class.ts +66 -0
- package/models/list-bank-orders-response-class.ts +37 -0
- package/models/payment-class-without-expand-properties.ts +7 -1
- package/models/payment-class.ts +7 -1
- package/models/payment-reminder-class.ts +7 -1
- package/models/refund-class.ts +7 -1
- package/models/suggestion-generation-progress-class.ts +52 -0
- package/models/unlinked-bank-transaction-response-class.ts +8 -2
- package/models/update-bank-order-request-dto.ts +65 -0
- package/models/update-bank-order-response-class.ts +31 -0
- package/package.json +1 -1
- package/tsconfig.json +1 -0
|
@@ -22,7 +22,7 @@ import { ListPaymentMethodsResponseClass } from '../models';
|
|
|
22
22
|
*/
|
|
23
23
|
export declare const PaymentMethodsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
24
24
|
/**
|
|
25
|
-
* This will create payment method in the database as well as in the PSP. The newly created payment method will be set as default payment method will be used by the customer to pay or receive a refund.
|
|
25
|
+
* This will create payment method in the database as well as in the PSP. The newly created payment method will be set as default payment method will be used by the customer to pay or receive a refund. **Required Permissions** \"payment-management.payments.create\"
|
|
26
26
|
* @summary Create the payment method
|
|
27
27
|
* @param {CreatePspPaymentMethodRequestDto} createPspPaymentMethodRequestDto
|
|
28
28
|
* @param {string} [authorization] Bearer Token
|
|
@@ -31,7 +31,7 @@ export declare const PaymentMethodsApiAxiosParamCreator: (configuration?: Config
|
|
|
31
31
|
*/
|
|
32
32
|
createPaymentMethod: (createPspPaymentMethodRequestDto: CreatePspPaymentMethodRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
33
33
|
/**
|
|
34
|
-
* Retrieves the details of the payment method that was previously created. Supply the unique payment method code that was returned when you created it and Emil Api will return the corresponding payment method information.
|
|
34
|
+
* Retrieves the details of the payment method that was previously created. Supply the unique payment method code that was returned when you created it and Emil Api will return the corresponding payment method information. **Required Permissions** \"payment-management.payments.view\"
|
|
35
35
|
* @summary Retrieve the payment method
|
|
36
36
|
* @param {string} code
|
|
37
37
|
* @param {string} [authorization] Bearer Token
|
|
@@ -40,17 +40,20 @@ export declare const PaymentMethodsApiAxiosParamCreator: (configuration?: Config
|
|
|
40
40
|
*/
|
|
41
41
|
getPaymentMethod: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
42
42
|
/**
|
|
43
|
-
* Returns a list of payment methods you have previously created. The payment methods are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
43
|
+
* Returns a list of payment methods you have previously created. The payment methods are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.payments.view\"
|
|
44
44
|
* @summary List payment methods
|
|
45
45
|
* @param {string} [authorization] Bearer Token
|
|
46
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
47
|
+
* @param {string} [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.
|
|
46
48
|
* @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, productSlug</i>
|
|
47
|
-
* @param {string} [
|
|
49
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
48
50
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt</i>
|
|
49
51
|
* @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/>
|
|
52
|
+
* @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, productSlug</i>
|
|
50
53
|
* @param {*} [options] Override http request option.
|
|
51
54
|
* @throws {RequiredError}
|
|
52
55
|
*/
|
|
53
|
-
listPaymentMethods: (authorization?: string, filter?: string,
|
|
56
|
+
listPaymentMethods: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
54
57
|
};
|
|
55
58
|
/**
|
|
56
59
|
* PaymentMethodsApi - functional programming interface
|
|
@@ -58,7 +61,7 @@ export declare const PaymentMethodsApiAxiosParamCreator: (configuration?: Config
|
|
|
58
61
|
*/
|
|
59
62
|
export declare const PaymentMethodsApiFp: (configuration?: Configuration) => {
|
|
60
63
|
/**
|
|
61
|
-
* This will create payment method in the database as well as in the PSP. The newly created payment method will be set as default payment method will be used by the customer to pay or receive a refund.
|
|
64
|
+
* This will create payment method in the database as well as in the PSP. The newly created payment method will be set as default payment method will be used by the customer to pay or receive a refund. **Required Permissions** \"payment-management.payments.create\"
|
|
62
65
|
* @summary Create the payment method
|
|
63
66
|
* @param {CreatePspPaymentMethodRequestDto} createPspPaymentMethodRequestDto
|
|
64
67
|
* @param {string} [authorization] Bearer Token
|
|
@@ -67,7 +70,7 @@ export declare const PaymentMethodsApiFp: (configuration?: Configuration) => {
|
|
|
67
70
|
*/
|
|
68
71
|
createPaymentMethod(createPspPaymentMethodRequestDto: CreatePspPaymentMethodRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePaymentMethodResponseClass>>;
|
|
69
72
|
/**
|
|
70
|
-
* Retrieves the details of the payment method that was previously created. Supply the unique payment method code that was returned when you created it and Emil Api will return the corresponding payment method information.
|
|
73
|
+
* Retrieves the details of the payment method that was previously created. Supply the unique payment method code that was returned when you created it and Emil Api will return the corresponding payment method information. **Required Permissions** \"payment-management.payments.view\"
|
|
71
74
|
* @summary Retrieve the payment method
|
|
72
75
|
* @param {string} code
|
|
73
76
|
* @param {string} [authorization] Bearer Token
|
|
@@ -76,17 +79,20 @@ export declare const PaymentMethodsApiFp: (configuration?: Configuration) => {
|
|
|
76
79
|
*/
|
|
77
80
|
getPaymentMethod(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPaymentMethodResponseClass>>;
|
|
78
81
|
/**
|
|
79
|
-
* Returns a list of payment methods you have previously created. The payment methods are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
82
|
+
* Returns a list of payment methods you have previously created. The payment methods are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.payments.view\"
|
|
80
83
|
* @summary List payment methods
|
|
81
84
|
* @param {string} [authorization] Bearer Token
|
|
85
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
86
|
+
* @param {string} [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.
|
|
82
87
|
* @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, productSlug</i>
|
|
83
|
-
* @param {string} [
|
|
88
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
84
89
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt</i>
|
|
85
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/>
|
|
91
|
+
* @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, productSlug</i>
|
|
86
92
|
* @param {*} [options] Override http request option.
|
|
87
93
|
* @throws {RequiredError}
|
|
88
94
|
*/
|
|
89
|
-
listPaymentMethods(authorization?: string, filter?: string,
|
|
95
|
+
listPaymentMethods(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPaymentMethodsResponseClass>>;
|
|
90
96
|
};
|
|
91
97
|
/**
|
|
92
98
|
* PaymentMethodsApi - factory interface
|
|
@@ -94,7 +100,7 @@ export declare const PaymentMethodsApiFp: (configuration?: Configuration) => {
|
|
|
94
100
|
*/
|
|
95
101
|
export declare const PaymentMethodsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
96
102
|
/**
|
|
97
|
-
* This will create payment method in the database as well as in the PSP. The newly created payment method will be set as default payment method will be used by the customer to pay or receive a refund.
|
|
103
|
+
* This will create payment method in the database as well as in the PSP. The newly created payment method will be set as default payment method will be used by the customer to pay or receive a refund. **Required Permissions** \"payment-management.payments.create\"
|
|
98
104
|
* @summary Create the payment method
|
|
99
105
|
* @param {CreatePspPaymentMethodRequestDto} createPspPaymentMethodRequestDto
|
|
100
106
|
* @param {string} [authorization] Bearer Token
|
|
@@ -103,7 +109,7 @@ export declare const PaymentMethodsApiFactory: (configuration?: Configuration, b
|
|
|
103
109
|
*/
|
|
104
110
|
createPaymentMethod(createPspPaymentMethodRequestDto: CreatePspPaymentMethodRequestDto, authorization?: string, options?: any): AxiosPromise<CreatePaymentMethodResponseClass>;
|
|
105
111
|
/**
|
|
106
|
-
* Retrieves the details of the payment method that was previously created. Supply the unique payment method code that was returned when you created it and Emil Api will return the corresponding payment method information.
|
|
112
|
+
* Retrieves the details of the payment method that was previously created. Supply the unique payment method code that was returned when you created it and Emil Api will return the corresponding payment method information. **Required Permissions** \"payment-management.payments.view\"
|
|
107
113
|
* @summary Retrieve the payment method
|
|
108
114
|
* @param {string} code
|
|
109
115
|
* @param {string} [authorization] Bearer Token
|
|
@@ -112,17 +118,20 @@ export declare const PaymentMethodsApiFactory: (configuration?: Configuration, b
|
|
|
112
118
|
*/
|
|
113
119
|
getPaymentMethod(code: string, authorization?: string, options?: any): AxiosPromise<GetPaymentMethodResponseClass>;
|
|
114
120
|
/**
|
|
115
|
-
* Returns a list of payment methods you have previously created. The payment methods are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
121
|
+
* Returns a list of payment methods you have previously created. The payment methods are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.payments.view\"
|
|
116
122
|
* @summary List payment methods
|
|
117
123
|
* @param {string} [authorization] Bearer Token
|
|
124
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
125
|
+
* @param {string} [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.
|
|
118
126
|
* @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, productSlug</i>
|
|
119
|
-
* @param {string} [
|
|
127
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
120
128
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt</i>
|
|
121
129
|
* @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/>
|
|
130
|
+
* @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, productSlug</i>
|
|
122
131
|
* @param {*} [options] Override http request option.
|
|
123
132
|
* @throws {RequiredError}
|
|
124
133
|
*/
|
|
125
|
-
listPaymentMethods(authorization?: string, filter?: string,
|
|
134
|
+
listPaymentMethods(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPaymentMethodsResponseClass>;
|
|
126
135
|
};
|
|
127
136
|
/**
|
|
128
137
|
* Request parameters for createPaymentMethod operation in PaymentMethodsApi.
|
|
@@ -174,6 +183,18 @@ export interface PaymentMethodsApiListPaymentMethodsRequest {
|
|
|
174
183
|
* @memberof PaymentMethodsApiListPaymentMethods
|
|
175
184
|
*/
|
|
176
185
|
readonly authorization?: string;
|
|
186
|
+
/**
|
|
187
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
188
|
+
* @type {number}
|
|
189
|
+
* @memberof PaymentMethodsApiListPaymentMethods
|
|
190
|
+
*/
|
|
191
|
+
readonly pageSize?: number;
|
|
192
|
+
/**
|
|
193
|
+
* 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.
|
|
194
|
+
* @type {string}
|
|
195
|
+
* @memberof PaymentMethodsApiListPaymentMethods
|
|
196
|
+
*/
|
|
197
|
+
readonly pageToken?: string;
|
|
177
198
|
/**
|
|
178
199
|
* 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, productSlug</i>
|
|
179
200
|
* @type {string}
|
|
@@ -181,11 +202,11 @@ export interface PaymentMethodsApiListPaymentMethodsRequest {
|
|
|
181
202
|
*/
|
|
182
203
|
readonly filter?: string;
|
|
183
204
|
/**
|
|
184
|
-
*
|
|
205
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
185
206
|
* @type {string}
|
|
186
207
|
* @memberof PaymentMethodsApiListPaymentMethods
|
|
187
208
|
*/
|
|
188
|
-
readonly
|
|
209
|
+
readonly search?: string;
|
|
189
210
|
/**
|
|
190
211
|
* Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt</i>
|
|
191
212
|
* @type {string}
|
|
@@ -198,6 +219,12 @@ export interface PaymentMethodsApiListPaymentMethodsRequest {
|
|
|
198
219
|
* @memberof PaymentMethodsApiListPaymentMethods
|
|
199
220
|
*/
|
|
200
221
|
readonly expand?: string;
|
|
222
|
+
/**
|
|
223
|
+
* 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, productSlug</i>
|
|
224
|
+
* @type {string}
|
|
225
|
+
* @memberof PaymentMethodsApiListPaymentMethods
|
|
226
|
+
*/
|
|
227
|
+
readonly filters?: string;
|
|
201
228
|
}
|
|
202
229
|
/**
|
|
203
230
|
* PaymentMethodsApi - object-oriented interface
|
|
@@ -207,7 +234,7 @@ export interface PaymentMethodsApiListPaymentMethodsRequest {
|
|
|
207
234
|
*/
|
|
208
235
|
export declare class PaymentMethodsApi extends BaseAPI {
|
|
209
236
|
/**
|
|
210
|
-
* This will create payment method in the database as well as in the PSP. The newly created payment method will be set as default payment method will be used by the customer to pay or receive a refund.
|
|
237
|
+
* This will create payment method in the database as well as in the PSP. The newly created payment method will be set as default payment method will be used by the customer to pay or receive a refund. **Required Permissions** \"payment-management.payments.create\"
|
|
211
238
|
* @summary Create the payment method
|
|
212
239
|
* @param {PaymentMethodsApiCreatePaymentMethodRequest} requestParameters Request parameters.
|
|
213
240
|
* @param {*} [options] Override http request option.
|
|
@@ -216,7 +243,7 @@ export declare class PaymentMethodsApi extends BaseAPI {
|
|
|
216
243
|
*/
|
|
217
244
|
createPaymentMethod(requestParameters: PaymentMethodsApiCreatePaymentMethodRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePaymentMethodResponseClass, any>>;
|
|
218
245
|
/**
|
|
219
|
-
* Retrieves the details of the payment method that was previously created. Supply the unique payment method code that was returned when you created it and Emil Api will return the corresponding payment method information.
|
|
246
|
+
* Retrieves the details of the payment method that was previously created. Supply the unique payment method code that was returned when you created it and Emil Api will return the corresponding payment method information. **Required Permissions** \"payment-management.payments.view\"
|
|
220
247
|
* @summary Retrieve the payment method
|
|
221
248
|
* @param {PaymentMethodsApiGetPaymentMethodRequest} requestParameters Request parameters.
|
|
222
249
|
* @param {*} [options] Override http request option.
|
|
@@ -225,7 +252,7 @@ export declare class PaymentMethodsApi extends BaseAPI {
|
|
|
225
252
|
*/
|
|
226
253
|
getPaymentMethod(requestParameters: PaymentMethodsApiGetPaymentMethodRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPaymentMethodResponseClass, any>>;
|
|
227
254
|
/**
|
|
228
|
-
* Returns a list of payment methods you have previously created. The payment methods are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
255
|
+
* Returns a list of payment methods you have previously created. The payment methods are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.payments.view\"
|
|
229
256
|
* @summary List payment methods
|
|
230
257
|
* @param {PaymentMethodsApiListPaymentMethodsRequest} requestParameters Request parameters.
|
|
231
258
|
* @param {*} [options] Override http request option.
|
|
@@ -97,7 +97,7 @@ var PaymentMethodsApiAxiosParamCreator = function (configuration) {
|
|
|
97
97
|
var _this = this;
|
|
98
98
|
return {
|
|
99
99
|
/**
|
|
100
|
-
* This will create payment method in the database as well as in the PSP. The newly created payment method will be set as default payment method will be used by the customer to pay or receive a refund.
|
|
100
|
+
* This will create payment method in the database as well as in the PSP. The newly created payment method will be set as default payment method will be used by the customer to pay or receive a refund. **Required Permissions** \"payment-management.payments.create\"
|
|
101
101
|
* @summary Create the payment method
|
|
102
102
|
* @param {CreatePspPaymentMethodRequestDto} createPspPaymentMethodRequestDto
|
|
103
103
|
* @param {string} [authorization] Bearer Token
|
|
@@ -146,7 +146,7 @@ var PaymentMethodsApiAxiosParamCreator = function (configuration) {
|
|
|
146
146
|
});
|
|
147
147
|
},
|
|
148
148
|
/**
|
|
149
|
-
* Retrieves the details of the payment method that was previously created. Supply the unique payment method code that was returned when you created it and Emil Api will return the corresponding payment method information.
|
|
149
|
+
* Retrieves the details of the payment method that was previously created. Supply the unique payment method code that was returned when you created it and Emil Api will return the corresponding payment method information. **Required Permissions** \"payment-management.payments.view\"
|
|
150
150
|
* @summary Retrieve the payment method
|
|
151
151
|
* @param {string} code
|
|
152
152
|
* @param {string} [authorization] Bearer Token
|
|
@@ -194,17 +194,20 @@ var PaymentMethodsApiAxiosParamCreator = function (configuration) {
|
|
|
194
194
|
});
|
|
195
195
|
},
|
|
196
196
|
/**
|
|
197
|
-
* Returns a list of payment methods you have previously created. The payment methods are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
197
|
+
* Returns a list of payment methods you have previously created. The payment methods are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.payments.view\"
|
|
198
198
|
* @summary List payment methods
|
|
199
199
|
* @param {string} [authorization] Bearer Token
|
|
200
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
201
|
+
* @param {string} [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.
|
|
200
202
|
* @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, productSlug</i>
|
|
201
|
-
* @param {string} [
|
|
203
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
202
204
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt</i>
|
|
203
205
|
* @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/>
|
|
206
|
+
* @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, productSlug</i>
|
|
204
207
|
* @param {*} [options] Override http request option.
|
|
205
208
|
* @throws {RequiredError}
|
|
206
209
|
*/
|
|
207
|
-
listPaymentMethods: function (authorization, filter,
|
|
210
|
+
listPaymentMethods: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
208
211
|
if (options === void 0) { options = {}; }
|
|
209
212
|
return __awaiter(_this, void 0, void 0, function () {
|
|
210
213
|
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
@@ -227,11 +230,17 @@ var PaymentMethodsApiAxiosParamCreator = function (configuration) {
|
|
|
227
230
|
// authentication bearer required
|
|
228
231
|
// http bearer authentication required
|
|
229
232
|
_a.sent();
|
|
233
|
+
if (pageSize !== undefined) {
|
|
234
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
235
|
+
}
|
|
236
|
+
if (pageToken !== undefined) {
|
|
237
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
238
|
+
}
|
|
230
239
|
if (filter !== undefined) {
|
|
231
240
|
localVarQueryParameter['filter'] = filter;
|
|
232
241
|
}
|
|
233
|
-
if (
|
|
234
|
-
localVarQueryParameter['
|
|
242
|
+
if (search !== undefined) {
|
|
243
|
+
localVarQueryParameter['search'] = search;
|
|
235
244
|
}
|
|
236
245
|
if (order !== undefined) {
|
|
237
246
|
localVarQueryParameter['order'] = order;
|
|
@@ -239,6 +248,9 @@ var PaymentMethodsApiAxiosParamCreator = function (configuration) {
|
|
|
239
248
|
if (expand !== undefined) {
|
|
240
249
|
localVarQueryParameter['expand'] = expand;
|
|
241
250
|
}
|
|
251
|
+
if (filters !== undefined) {
|
|
252
|
+
localVarQueryParameter['filters'] = filters;
|
|
253
|
+
}
|
|
242
254
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
243
255
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
244
256
|
}
|
|
@@ -264,7 +276,7 @@ var PaymentMethodsApiFp = function (configuration) {
|
|
|
264
276
|
var localVarAxiosParamCreator = (0, exports.PaymentMethodsApiAxiosParamCreator)(configuration);
|
|
265
277
|
return {
|
|
266
278
|
/**
|
|
267
|
-
* This will create payment method in the database as well as in the PSP. The newly created payment method will be set as default payment method will be used by the customer to pay or receive a refund.
|
|
279
|
+
* This will create payment method in the database as well as in the PSP. The newly created payment method will be set as default payment method will be used by the customer to pay or receive a refund. **Required Permissions** \"payment-management.payments.create\"
|
|
268
280
|
* @summary Create the payment method
|
|
269
281
|
* @param {CreatePspPaymentMethodRequestDto} createPspPaymentMethodRequestDto
|
|
270
282
|
* @param {string} [authorization] Bearer Token
|
|
@@ -285,7 +297,7 @@ var PaymentMethodsApiFp = function (configuration) {
|
|
|
285
297
|
});
|
|
286
298
|
},
|
|
287
299
|
/**
|
|
288
|
-
* Retrieves the details of the payment method that was previously created. Supply the unique payment method code that was returned when you created it and Emil Api will return the corresponding payment method information.
|
|
300
|
+
* Retrieves the details of the payment method that was previously created. Supply the unique payment method code that was returned when you created it and Emil Api will return the corresponding payment method information. **Required Permissions** \"payment-management.payments.view\"
|
|
289
301
|
* @summary Retrieve the payment method
|
|
290
302
|
* @param {string} code
|
|
291
303
|
* @param {string} [authorization] Bearer Token
|
|
@@ -306,22 +318,25 @@ var PaymentMethodsApiFp = function (configuration) {
|
|
|
306
318
|
});
|
|
307
319
|
},
|
|
308
320
|
/**
|
|
309
|
-
* Returns a list of payment methods you have previously created. The payment methods are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
321
|
+
* Returns a list of payment methods you have previously created. The payment methods are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.payments.view\"
|
|
310
322
|
* @summary List payment methods
|
|
311
323
|
* @param {string} [authorization] Bearer Token
|
|
324
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
325
|
+
* @param {string} [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.
|
|
312
326
|
* @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, productSlug</i>
|
|
313
|
-
* @param {string} [
|
|
327
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
314
328
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt</i>
|
|
315
329
|
* @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/>
|
|
330
|
+
* @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, productSlug</i>
|
|
316
331
|
* @param {*} [options] Override http request option.
|
|
317
332
|
* @throws {RequiredError}
|
|
318
333
|
*/
|
|
319
|
-
listPaymentMethods: function (authorization, filter,
|
|
334
|
+
listPaymentMethods: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
320
335
|
return __awaiter(this, void 0, void 0, function () {
|
|
321
336
|
var localVarAxiosArgs;
|
|
322
337
|
return __generator(this, function (_a) {
|
|
323
338
|
switch (_a.label) {
|
|
324
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.listPaymentMethods(authorization, filter,
|
|
339
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.listPaymentMethods(authorization, pageSize, pageToken, filter, search, order, expand, filters, options)];
|
|
325
340
|
case 1:
|
|
326
341
|
localVarAxiosArgs = _a.sent();
|
|
327
342
|
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
@@ -340,7 +355,7 @@ var PaymentMethodsApiFactory = function (configuration, basePath, axios) {
|
|
|
340
355
|
var localVarFp = (0, exports.PaymentMethodsApiFp)(configuration);
|
|
341
356
|
return {
|
|
342
357
|
/**
|
|
343
|
-
* This will create payment method in the database as well as in the PSP. The newly created payment method will be set as default payment method will be used by the customer to pay or receive a refund.
|
|
358
|
+
* This will create payment method in the database as well as in the PSP. The newly created payment method will be set as default payment method will be used by the customer to pay or receive a refund. **Required Permissions** \"payment-management.payments.create\"
|
|
344
359
|
* @summary Create the payment method
|
|
345
360
|
* @param {CreatePspPaymentMethodRequestDto} createPspPaymentMethodRequestDto
|
|
346
361
|
* @param {string} [authorization] Bearer Token
|
|
@@ -351,7 +366,7 @@ var PaymentMethodsApiFactory = function (configuration, basePath, axios) {
|
|
|
351
366
|
return localVarFp.createPaymentMethod(createPspPaymentMethodRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
352
367
|
},
|
|
353
368
|
/**
|
|
354
|
-
* Retrieves the details of the payment method that was previously created. Supply the unique payment method code that was returned when you created it and Emil Api will return the corresponding payment method information.
|
|
369
|
+
* Retrieves the details of the payment method that was previously created. Supply the unique payment method code that was returned when you created it and Emil Api will return the corresponding payment method information. **Required Permissions** \"payment-management.payments.view\"
|
|
355
370
|
* @summary Retrieve the payment method
|
|
356
371
|
* @param {string} code
|
|
357
372
|
* @param {string} [authorization] Bearer Token
|
|
@@ -362,18 +377,21 @@ var PaymentMethodsApiFactory = function (configuration, basePath, axios) {
|
|
|
362
377
|
return localVarFp.getPaymentMethod(code, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
363
378
|
},
|
|
364
379
|
/**
|
|
365
|
-
* Returns a list of payment methods you have previously created. The payment methods are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
380
|
+
* Returns a list of payment methods you have previously created. The payment methods are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.payments.view\"
|
|
366
381
|
* @summary List payment methods
|
|
367
382
|
* @param {string} [authorization] Bearer Token
|
|
383
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
384
|
+
* @param {string} [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.
|
|
368
385
|
* @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, productSlug</i>
|
|
369
|
-
* @param {string} [
|
|
386
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
370
387
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt</i>
|
|
371
388
|
* @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/>
|
|
389
|
+
* @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, productSlug</i>
|
|
372
390
|
* @param {*} [options] Override http request option.
|
|
373
391
|
* @throws {RequiredError}
|
|
374
392
|
*/
|
|
375
|
-
listPaymentMethods: function (authorization, filter,
|
|
376
|
-
return localVarFp.listPaymentMethods(authorization, filter,
|
|
393
|
+
listPaymentMethods: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
394
|
+
return localVarFp.listPaymentMethods(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
|
|
377
395
|
},
|
|
378
396
|
};
|
|
379
397
|
};
|
|
@@ -390,7 +408,7 @@ var PaymentMethodsApi = /** @class */ (function (_super) {
|
|
|
390
408
|
return _super !== null && _super.apply(this, arguments) || this;
|
|
391
409
|
}
|
|
392
410
|
/**
|
|
393
|
-
* This will create payment method in the database as well as in the PSP. The newly created payment method will be set as default payment method will be used by the customer to pay or receive a refund.
|
|
411
|
+
* This will create payment method in the database as well as in the PSP. The newly created payment method will be set as default payment method will be used by the customer to pay or receive a refund. **Required Permissions** \"payment-management.payments.create\"
|
|
394
412
|
* @summary Create the payment method
|
|
395
413
|
* @param {PaymentMethodsApiCreatePaymentMethodRequest} requestParameters Request parameters.
|
|
396
414
|
* @param {*} [options] Override http request option.
|
|
@@ -402,7 +420,7 @@ var PaymentMethodsApi = /** @class */ (function (_super) {
|
|
|
402
420
|
return (0, exports.PaymentMethodsApiFp)(this.configuration).createPaymentMethod(requestParameters.createPspPaymentMethodRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
403
421
|
};
|
|
404
422
|
/**
|
|
405
|
-
* Retrieves the details of the payment method that was previously created. Supply the unique payment method code that was returned when you created it and Emil Api will return the corresponding payment method information.
|
|
423
|
+
* Retrieves the details of the payment method that was previously created. Supply the unique payment method code that was returned when you created it and Emil Api will return the corresponding payment method information. **Required Permissions** \"payment-management.payments.view\"
|
|
406
424
|
* @summary Retrieve the payment method
|
|
407
425
|
* @param {PaymentMethodsApiGetPaymentMethodRequest} requestParameters Request parameters.
|
|
408
426
|
* @param {*} [options] Override http request option.
|
|
@@ -414,7 +432,7 @@ var PaymentMethodsApi = /** @class */ (function (_super) {
|
|
|
414
432
|
return (0, exports.PaymentMethodsApiFp)(this.configuration).getPaymentMethod(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
415
433
|
};
|
|
416
434
|
/**
|
|
417
|
-
* Returns a list of payment methods you have previously created. The payment methods are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
435
|
+
* Returns a list of payment methods you have previously created. The payment methods are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.payments.view\"
|
|
418
436
|
* @summary List payment methods
|
|
419
437
|
* @param {PaymentMethodsApiListPaymentMethodsRequest} requestParameters Request parameters.
|
|
420
438
|
* @param {*} [options] Override http request option.
|
|
@@ -424,7 +442,7 @@ var PaymentMethodsApi = /** @class */ (function (_super) {
|
|
|
424
442
|
PaymentMethodsApi.prototype.listPaymentMethods = function (requestParameters, options) {
|
|
425
443
|
var _this = this;
|
|
426
444
|
if (requestParameters === void 0) { requestParameters = {}; }
|
|
427
|
-
return (0, exports.PaymentMethodsApiFp)(this.configuration).listPaymentMethods(requestParameters.authorization, requestParameters.filter, requestParameters.
|
|
445
|
+
return (0, exports.PaymentMethodsApiFp)(this.configuration).listPaymentMethods(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
428
446
|
};
|
|
429
447
|
return PaymentMethodsApi;
|
|
430
448
|
}(base_1.BaseAPI));
|