@emilgroup/payment-sdk 1.13.1-beta.2 → 1.13.1-beta.20
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 +691 -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 +642 -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.
|
|
@@ -93,7 +93,7 @@ var PaymentMethodsApiAxiosParamCreator = function (configuration) {
|
|
|
93
93
|
var _this = this;
|
|
94
94
|
return {
|
|
95
95
|
/**
|
|
96
|
-
* 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.
|
|
96
|
+
* 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\"
|
|
97
97
|
* @summary Create the payment method
|
|
98
98
|
* @param {CreatePspPaymentMethodRequestDto} createPspPaymentMethodRequestDto
|
|
99
99
|
* @param {string} [authorization] Bearer Token
|
|
@@ -142,7 +142,7 @@ var PaymentMethodsApiAxiosParamCreator = function (configuration) {
|
|
|
142
142
|
});
|
|
143
143
|
},
|
|
144
144
|
/**
|
|
145
|
-
* 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.
|
|
145
|
+
* 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\"
|
|
146
146
|
* @summary Retrieve the payment method
|
|
147
147
|
* @param {string} code
|
|
148
148
|
* @param {string} [authorization] Bearer Token
|
|
@@ -190,17 +190,20 @@ var PaymentMethodsApiAxiosParamCreator = function (configuration) {
|
|
|
190
190
|
});
|
|
191
191
|
},
|
|
192
192
|
/**
|
|
193
|
-
* 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.
|
|
193
|
+
* 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\"
|
|
194
194
|
* @summary List payment methods
|
|
195
195
|
* @param {string} [authorization] Bearer Token
|
|
196
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
197
|
+
* @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.
|
|
196
198
|
* @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>
|
|
197
|
-
* @param {string} [
|
|
199
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
198
200
|
* @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>
|
|
199
201
|
* @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/>
|
|
202
|
+
* @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>
|
|
200
203
|
* @param {*} [options] Override http request option.
|
|
201
204
|
* @throws {RequiredError}
|
|
202
205
|
*/
|
|
203
|
-
listPaymentMethods: function (authorization, filter,
|
|
206
|
+
listPaymentMethods: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
204
207
|
if (options === void 0) { options = {}; }
|
|
205
208
|
return __awaiter(_this, void 0, void 0, function () {
|
|
206
209
|
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
@@ -223,11 +226,17 @@ var PaymentMethodsApiAxiosParamCreator = function (configuration) {
|
|
|
223
226
|
// authentication bearer required
|
|
224
227
|
// http bearer authentication required
|
|
225
228
|
_a.sent();
|
|
229
|
+
if (pageSize !== undefined) {
|
|
230
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
231
|
+
}
|
|
232
|
+
if (pageToken !== undefined) {
|
|
233
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
234
|
+
}
|
|
226
235
|
if (filter !== undefined) {
|
|
227
236
|
localVarQueryParameter['filter'] = filter;
|
|
228
237
|
}
|
|
229
|
-
if (
|
|
230
|
-
localVarQueryParameter['
|
|
238
|
+
if (search !== undefined) {
|
|
239
|
+
localVarQueryParameter['search'] = search;
|
|
231
240
|
}
|
|
232
241
|
if (order !== undefined) {
|
|
233
242
|
localVarQueryParameter['order'] = order;
|
|
@@ -235,6 +244,9 @@ var PaymentMethodsApiAxiosParamCreator = function (configuration) {
|
|
|
235
244
|
if (expand !== undefined) {
|
|
236
245
|
localVarQueryParameter['expand'] = expand;
|
|
237
246
|
}
|
|
247
|
+
if (filters !== undefined) {
|
|
248
|
+
localVarQueryParameter['filters'] = filters;
|
|
249
|
+
}
|
|
238
250
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
239
251
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
240
252
|
}
|
|
@@ -260,7 +272,7 @@ var PaymentMethodsApiFp = function (configuration) {
|
|
|
260
272
|
var localVarAxiosParamCreator = (0, exports.PaymentMethodsApiAxiosParamCreator)(configuration);
|
|
261
273
|
return {
|
|
262
274
|
/**
|
|
263
|
-
* 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.
|
|
275
|
+
* 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\"
|
|
264
276
|
* @summary Create the payment method
|
|
265
277
|
* @param {CreatePspPaymentMethodRequestDto} createPspPaymentMethodRequestDto
|
|
266
278
|
* @param {string} [authorization] Bearer Token
|
|
@@ -281,7 +293,7 @@ var PaymentMethodsApiFp = function (configuration) {
|
|
|
281
293
|
});
|
|
282
294
|
},
|
|
283
295
|
/**
|
|
284
|
-
* 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.
|
|
296
|
+
* 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\"
|
|
285
297
|
* @summary Retrieve the payment method
|
|
286
298
|
* @param {string} code
|
|
287
299
|
* @param {string} [authorization] Bearer Token
|
|
@@ -302,22 +314,25 @@ var PaymentMethodsApiFp = function (configuration) {
|
|
|
302
314
|
});
|
|
303
315
|
},
|
|
304
316
|
/**
|
|
305
|
-
* 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.
|
|
317
|
+
* 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\"
|
|
306
318
|
* @summary List payment methods
|
|
307
319
|
* @param {string} [authorization] Bearer Token
|
|
320
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
321
|
+
* @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.
|
|
308
322
|
* @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>
|
|
309
|
-
* @param {string} [
|
|
323
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
310
324
|
* @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>
|
|
311
325
|
* @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/>
|
|
326
|
+
* @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>
|
|
312
327
|
* @param {*} [options] Override http request option.
|
|
313
328
|
* @throws {RequiredError}
|
|
314
329
|
*/
|
|
315
|
-
listPaymentMethods: function (authorization, filter,
|
|
330
|
+
listPaymentMethods: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
316
331
|
return __awaiter(this, void 0, void 0, function () {
|
|
317
332
|
var localVarAxiosArgs;
|
|
318
333
|
return __generator(this, function (_a) {
|
|
319
334
|
switch (_a.label) {
|
|
320
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.listPaymentMethods(authorization, filter,
|
|
335
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.listPaymentMethods(authorization, pageSize, pageToken, filter, search, order, expand, filters, options)];
|
|
321
336
|
case 1:
|
|
322
337
|
localVarAxiosArgs = _a.sent();
|
|
323
338
|
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
@@ -336,7 +351,7 @@ var PaymentMethodsApiFactory = function (configuration, basePath, axios) {
|
|
|
336
351
|
var localVarFp = (0, exports.PaymentMethodsApiFp)(configuration);
|
|
337
352
|
return {
|
|
338
353
|
/**
|
|
339
|
-
* 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.
|
|
354
|
+
* 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\"
|
|
340
355
|
* @summary Create the payment method
|
|
341
356
|
* @param {CreatePspPaymentMethodRequestDto} createPspPaymentMethodRequestDto
|
|
342
357
|
* @param {string} [authorization] Bearer Token
|
|
@@ -347,7 +362,7 @@ var PaymentMethodsApiFactory = function (configuration, basePath, axios) {
|
|
|
347
362
|
return localVarFp.createPaymentMethod(createPspPaymentMethodRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
348
363
|
},
|
|
349
364
|
/**
|
|
350
|
-
* 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.
|
|
365
|
+
* 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\"
|
|
351
366
|
* @summary Retrieve the payment method
|
|
352
367
|
* @param {string} code
|
|
353
368
|
* @param {string} [authorization] Bearer Token
|
|
@@ -358,18 +373,21 @@ var PaymentMethodsApiFactory = function (configuration, basePath, axios) {
|
|
|
358
373
|
return localVarFp.getPaymentMethod(code, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
359
374
|
},
|
|
360
375
|
/**
|
|
361
|
-
* 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.
|
|
376
|
+
* 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\"
|
|
362
377
|
* @summary List payment methods
|
|
363
378
|
* @param {string} [authorization] Bearer Token
|
|
379
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
380
|
+
* @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.
|
|
364
381
|
* @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>
|
|
365
|
-
* @param {string} [
|
|
382
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
366
383
|
* @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>
|
|
367
384
|
* @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/>
|
|
385
|
+
* @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>
|
|
368
386
|
* @param {*} [options] Override http request option.
|
|
369
387
|
* @throws {RequiredError}
|
|
370
388
|
*/
|
|
371
|
-
listPaymentMethods: function (authorization, filter,
|
|
372
|
-
return localVarFp.listPaymentMethods(authorization, filter,
|
|
389
|
+
listPaymentMethods: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
390
|
+
return localVarFp.listPaymentMethods(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
|
|
373
391
|
},
|
|
374
392
|
};
|
|
375
393
|
};
|
|
@@ -386,7 +404,7 @@ var PaymentMethodsApi = /** @class */ (function (_super) {
|
|
|
386
404
|
return _super !== null && _super.apply(this, arguments) || this;
|
|
387
405
|
}
|
|
388
406
|
/**
|
|
389
|
-
* 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.
|
|
407
|
+
* 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\"
|
|
390
408
|
* @summary Create the payment method
|
|
391
409
|
* @param {PaymentMethodsApiCreatePaymentMethodRequest} requestParameters Request parameters.
|
|
392
410
|
* @param {*} [options] Override http request option.
|
|
@@ -398,7 +416,7 @@ var PaymentMethodsApi = /** @class */ (function (_super) {
|
|
|
398
416
|
return (0, exports.PaymentMethodsApiFp)(this.configuration).createPaymentMethod(requestParameters.createPspPaymentMethodRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
399
417
|
};
|
|
400
418
|
/**
|
|
401
|
-
* 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.
|
|
419
|
+
* 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\"
|
|
402
420
|
* @summary Retrieve the payment method
|
|
403
421
|
* @param {PaymentMethodsApiGetPaymentMethodRequest} requestParameters Request parameters.
|
|
404
422
|
* @param {*} [options] Override http request option.
|
|
@@ -410,7 +428,7 @@ var PaymentMethodsApi = /** @class */ (function (_super) {
|
|
|
410
428
|
return (0, exports.PaymentMethodsApiFp)(this.configuration).getPaymentMethod(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
411
429
|
};
|
|
412
430
|
/**
|
|
413
|
-
* 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.
|
|
431
|
+
* 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\"
|
|
414
432
|
* @summary List payment methods
|
|
415
433
|
* @param {PaymentMethodsApiListPaymentMethodsRequest} requestParameters Request parameters.
|
|
416
434
|
* @param {*} [options] Override http request option.
|
|
@@ -420,7 +438,7 @@ var PaymentMethodsApi = /** @class */ (function (_super) {
|
|
|
420
438
|
PaymentMethodsApi.prototype.listPaymentMethods = function (requestParameters, options) {
|
|
421
439
|
var _this = this;
|
|
422
440
|
if (requestParameters === void 0) { requestParameters = {}; }
|
|
423
|
-
return (0, exports.PaymentMethodsApiFp)(this.configuration).listPaymentMethods(requestParameters.authorization, requestParameters.filter, requestParameters.
|
|
441
|
+
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); });
|
|
424
442
|
};
|
|
425
443
|
return PaymentMethodsApi;
|
|
426
444
|
}(base_1.BaseAPI));
|