@emilgroup/payment-sdk-node 1.21.1-beta.2 → 1.21.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 +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 { ListRefundsResponseClass } from '../models';
|
|
|
22
22
|
*/
|
|
23
23
|
export declare const RefundsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
24
24
|
/**
|
|
25
|
-
* This will create a refund in the database.
|
|
25
|
+
* This will create a refund in the database. **Required Permissions** \"payment-management.payments.create\"
|
|
26
26
|
* @summary Create the refund
|
|
27
27
|
* @param {CreateRefundRequestDto} createRefundRequestDto
|
|
28
28
|
* @param {string} [authorization] Bearer Token
|
|
@@ -31,7 +31,7 @@ export declare const RefundsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
31
31
|
*/
|
|
32
32
|
createRefund: (createRefundRequestDto: CreateRefundRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
33
33
|
/**
|
|
34
|
-
* Retrieves the details of the refund that was previously created. Supply the unique refund code that was returned when you created it and Emil Api will return the corresponding refund information.
|
|
34
|
+
* Retrieves the details of the refund that was previously created. Supply the unique refund code that was returned when you created it and Emil Api will return the corresponding refund information. **Required Permissions** \"payment-management.payments.view\"
|
|
35
35
|
* @summary Retrieve the refund
|
|
36
36
|
* @param {string} code
|
|
37
37
|
* @param {string} [authorization] Bearer Token
|
|
@@ -41,18 +41,20 @@ export declare const RefundsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
41
41
|
*/
|
|
42
42
|
getRefund: (code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
43
43
|
/**
|
|
44
|
-
* Returns a list of refunds you have previously created. The refunds are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
44
|
+
* Returns a list of refunds you have previously created. The refunds 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\"
|
|
45
45
|
* @summary List refunds
|
|
46
46
|
* @param {string} [authorization] Bearer Token
|
|
47
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
48
|
+
* @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.
|
|
47
49
|
* @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, status, reason, psp, accountCode, invoiceCode</i>
|
|
48
|
-
* @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, status, reason, psp, accountCode, invoiceCode</i>
|
|
49
50
|
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: id, createdAt, updatedAt, amount, psp, accountCode, invoiceCode, reason, status</i>
|
|
50
51
|
* @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, updatedAt, amount</i>
|
|
51
52
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: refundItems<i>
|
|
53
|
+
* @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, status, reason, psp, accountCode, invoiceCode</i>
|
|
52
54
|
* @param {*} [options] Override http request option.
|
|
53
55
|
* @throws {RequiredError}
|
|
54
56
|
*/
|
|
55
|
-
listRefunds: (authorization?: string,
|
|
57
|
+
listRefunds: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
56
58
|
};
|
|
57
59
|
/**
|
|
58
60
|
* RefundsApi - functional programming interface
|
|
@@ -60,7 +62,7 @@ export declare const RefundsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
60
62
|
*/
|
|
61
63
|
export declare const RefundsApiFp: (configuration?: Configuration) => {
|
|
62
64
|
/**
|
|
63
|
-
* This will create a refund in the database.
|
|
65
|
+
* This will create a refund in the database. **Required Permissions** \"payment-management.payments.create\"
|
|
64
66
|
* @summary Create the refund
|
|
65
67
|
* @param {CreateRefundRequestDto} createRefundRequestDto
|
|
66
68
|
* @param {string} [authorization] Bearer Token
|
|
@@ -69,7 +71,7 @@ export declare const RefundsApiFp: (configuration?: Configuration) => {
|
|
|
69
71
|
*/
|
|
70
72
|
createRefund(createRefundRequestDto: CreateRefundRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateRefundResponseClass>>;
|
|
71
73
|
/**
|
|
72
|
-
* Retrieves the details of the refund that was previously created. Supply the unique refund code that was returned when you created it and Emil Api will return the corresponding refund information.
|
|
74
|
+
* Retrieves the details of the refund that was previously created. Supply the unique refund code that was returned when you created it and Emil Api will return the corresponding refund information. **Required Permissions** \"payment-management.payments.view\"
|
|
73
75
|
* @summary Retrieve the refund
|
|
74
76
|
* @param {string} code
|
|
75
77
|
* @param {string} [authorization] Bearer Token
|
|
@@ -79,18 +81,20 @@ export declare const RefundsApiFp: (configuration?: Configuration) => {
|
|
|
79
81
|
*/
|
|
80
82
|
getRefund(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetRefundResponseClass>>;
|
|
81
83
|
/**
|
|
82
|
-
* Returns a list of refunds you have previously created. The refunds are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
84
|
+
* Returns a list of refunds you have previously created. The refunds 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\"
|
|
83
85
|
* @summary List refunds
|
|
84
86
|
* @param {string} [authorization] Bearer Token
|
|
87
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
88
|
+
* @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.
|
|
85
89
|
* @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, status, reason, psp, accountCode, invoiceCode</i>
|
|
86
|
-
* @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, status, reason, psp, accountCode, invoiceCode</i>
|
|
87
90
|
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: id, createdAt, updatedAt, amount, psp, accountCode, invoiceCode, reason, status</i>
|
|
88
91
|
* @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, updatedAt, amount</i>
|
|
89
92
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: refundItems<i>
|
|
93
|
+
* @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, status, reason, psp, accountCode, invoiceCode</i>
|
|
90
94
|
* @param {*} [options] Override http request option.
|
|
91
95
|
* @throws {RequiredError}
|
|
92
96
|
*/
|
|
93
|
-
listRefunds(authorization?: string,
|
|
97
|
+
listRefunds(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListRefundsResponseClass>>;
|
|
94
98
|
};
|
|
95
99
|
/**
|
|
96
100
|
* RefundsApi - factory interface
|
|
@@ -98,7 +102,7 @@ export declare const RefundsApiFp: (configuration?: Configuration) => {
|
|
|
98
102
|
*/
|
|
99
103
|
export declare const RefundsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
100
104
|
/**
|
|
101
|
-
* This will create a refund in the database.
|
|
105
|
+
* This will create a refund in the database. **Required Permissions** \"payment-management.payments.create\"
|
|
102
106
|
* @summary Create the refund
|
|
103
107
|
* @param {CreateRefundRequestDto} createRefundRequestDto
|
|
104
108
|
* @param {string} [authorization] Bearer Token
|
|
@@ -107,7 +111,7 @@ export declare const RefundsApiFactory: (configuration?: Configuration, basePath
|
|
|
107
111
|
*/
|
|
108
112
|
createRefund(createRefundRequestDto: CreateRefundRequestDto, authorization?: string, options?: any): AxiosPromise<CreateRefundResponseClass>;
|
|
109
113
|
/**
|
|
110
|
-
* Retrieves the details of the refund that was previously created. Supply the unique refund code that was returned when you created it and Emil Api will return the corresponding refund information.
|
|
114
|
+
* Retrieves the details of the refund that was previously created. Supply the unique refund code that was returned when you created it and Emil Api will return the corresponding refund information. **Required Permissions** \"payment-management.payments.view\"
|
|
111
115
|
* @summary Retrieve the refund
|
|
112
116
|
* @param {string} code
|
|
113
117
|
* @param {string} [authorization] Bearer Token
|
|
@@ -117,18 +121,20 @@ export declare const RefundsApiFactory: (configuration?: Configuration, basePath
|
|
|
117
121
|
*/
|
|
118
122
|
getRefund(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetRefundResponseClass>;
|
|
119
123
|
/**
|
|
120
|
-
* Returns a list of refunds you have previously created. The refunds are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
124
|
+
* Returns a list of refunds you have previously created. The refunds 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\"
|
|
121
125
|
* @summary List refunds
|
|
122
126
|
* @param {string} [authorization] Bearer Token
|
|
127
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
128
|
+
* @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.
|
|
123
129
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, id, status, reason, psp, accountCode, invoiceCode</i>
|
|
124
|
-
* @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, status, reason, psp, accountCode, invoiceCode</i>
|
|
125
130
|
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: id, createdAt, updatedAt, amount, psp, accountCode, invoiceCode, reason, status</i>
|
|
126
131
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, updatedAt, amount</i>
|
|
127
132
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: refundItems<i>
|
|
133
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, id, status, reason, psp, accountCode, invoiceCode</i>
|
|
128
134
|
* @param {*} [options] Override http request option.
|
|
129
135
|
* @throws {RequiredError}
|
|
130
136
|
*/
|
|
131
|
-
listRefunds(authorization?: string,
|
|
137
|
+
listRefunds(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListRefundsResponseClass>;
|
|
132
138
|
};
|
|
133
139
|
/**
|
|
134
140
|
* Request parameters for createRefund operation in RefundsApi.
|
|
@@ -187,17 +193,23 @@ export interface RefundsApiListRefundsRequest {
|
|
|
187
193
|
*/
|
|
188
194
|
readonly authorization?: string;
|
|
189
195
|
/**
|
|
190
|
-
*
|
|
196
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
197
|
+
* @type {number}
|
|
198
|
+
* @memberof RefundsApiListRefunds
|
|
199
|
+
*/
|
|
200
|
+
readonly pageSize?: number;
|
|
201
|
+
/**
|
|
202
|
+
* 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.
|
|
191
203
|
* @type {string}
|
|
192
204
|
* @memberof RefundsApiListRefunds
|
|
193
205
|
*/
|
|
194
|
-
readonly
|
|
206
|
+
readonly pageToken?: string;
|
|
195
207
|
/**
|
|
196
|
-
*
|
|
208
|
+
* 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, status, reason, psp, accountCode, invoiceCode</i>
|
|
197
209
|
* @type {string}
|
|
198
210
|
* @memberof RefundsApiListRefunds
|
|
199
211
|
*/
|
|
200
|
-
readonly
|
|
212
|
+
readonly filter?: string;
|
|
201
213
|
/**
|
|
202
214
|
* Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: id, createdAt, updatedAt, amount, psp, accountCode, invoiceCode, reason, status</i>
|
|
203
215
|
* @type {string}
|
|
@@ -216,6 +228,12 @@ export interface RefundsApiListRefundsRequest {
|
|
|
216
228
|
* @memberof RefundsApiListRefunds
|
|
217
229
|
*/
|
|
218
230
|
readonly expand?: string;
|
|
231
|
+
/**
|
|
232
|
+
* 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, status, reason, psp, accountCode, invoiceCode</i>
|
|
233
|
+
* @type {string}
|
|
234
|
+
* @memberof RefundsApiListRefunds
|
|
235
|
+
*/
|
|
236
|
+
readonly filters?: string;
|
|
219
237
|
}
|
|
220
238
|
/**
|
|
221
239
|
* RefundsApi - object-oriented interface
|
|
@@ -225,7 +243,7 @@ export interface RefundsApiListRefundsRequest {
|
|
|
225
243
|
*/
|
|
226
244
|
export declare class RefundsApi extends BaseAPI {
|
|
227
245
|
/**
|
|
228
|
-
* This will create a refund in the database.
|
|
246
|
+
* This will create a refund in the database. **Required Permissions** \"payment-management.payments.create\"
|
|
229
247
|
* @summary Create the refund
|
|
230
248
|
* @param {RefundsApiCreateRefundRequest} requestParameters Request parameters.
|
|
231
249
|
* @param {*} [options] Override http request option.
|
|
@@ -234,7 +252,7 @@ export declare class RefundsApi extends BaseAPI {
|
|
|
234
252
|
*/
|
|
235
253
|
createRefund(requestParameters: RefundsApiCreateRefundRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateRefundResponseClass, any>>;
|
|
236
254
|
/**
|
|
237
|
-
* Retrieves the details of the refund that was previously created. Supply the unique refund code that was returned when you created it and Emil Api will return the corresponding refund information.
|
|
255
|
+
* Retrieves the details of the refund that was previously created. Supply the unique refund code that was returned when you created it and Emil Api will return the corresponding refund information. **Required Permissions** \"payment-management.payments.view\"
|
|
238
256
|
* @summary Retrieve the refund
|
|
239
257
|
* @param {RefundsApiGetRefundRequest} requestParameters Request parameters.
|
|
240
258
|
* @param {*} [options] Override http request option.
|
|
@@ -243,7 +261,7 @@ export declare class RefundsApi extends BaseAPI {
|
|
|
243
261
|
*/
|
|
244
262
|
getRefund(requestParameters: RefundsApiGetRefundRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetRefundResponseClass, any>>;
|
|
245
263
|
/**
|
|
246
|
-
* Returns a list of refunds you have previously created. The refunds are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
264
|
+
* Returns a list of refunds you have previously created. The refunds 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\"
|
|
247
265
|
* @summary List refunds
|
|
248
266
|
* @param {RefundsApiListRefundsRequest} requestParameters Request parameters.
|
|
249
267
|
* @param {*} [options] Override http request option.
|
package/dist/api/refunds-api.js
CHANGED
|
@@ -97,7 +97,7 @@ var RefundsApiAxiosParamCreator = function (configuration) {
|
|
|
97
97
|
var _this = this;
|
|
98
98
|
return {
|
|
99
99
|
/**
|
|
100
|
-
* This will create a refund in the database.
|
|
100
|
+
* This will create a refund in the database. **Required Permissions** \"payment-management.payments.create\"
|
|
101
101
|
* @summary Create the refund
|
|
102
102
|
* @param {CreateRefundRequestDto} createRefundRequestDto
|
|
103
103
|
* @param {string} [authorization] Bearer Token
|
|
@@ -146,7 +146,7 @@ var RefundsApiAxiosParamCreator = function (configuration) {
|
|
|
146
146
|
});
|
|
147
147
|
},
|
|
148
148
|
/**
|
|
149
|
-
* Retrieves the details of the refund that was previously created. Supply the unique refund code that was returned when you created it and Emil Api will return the corresponding refund information.
|
|
149
|
+
* Retrieves the details of the refund that was previously created. Supply the unique refund code that was returned when you created it and Emil Api will return the corresponding refund information. **Required Permissions** \"payment-management.payments.view\"
|
|
150
150
|
* @summary Retrieve the refund
|
|
151
151
|
* @param {string} code
|
|
152
152
|
* @param {string} [authorization] Bearer Token
|
|
@@ -198,18 +198,20 @@ var RefundsApiAxiosParamCreator = function (configuration) {
|
|
|
198
198
|
});
|
|
199
199
|
},
|
|
200
200
|
/**
|
|
201
|
-
* Returns a list of refunds you have previously created. The refunds are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
201
|
+
* Returns a list of refunds you have previously created. The refunds 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\"
|
|
202
202
|
* @summary List refunds
|
|
203
203
|
* @param {string} [authorization] Bearer Token
|
|
204
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
205
|
+
* @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.
|
|
204
206
|
* @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, status, reason, psp, accountCode, invoiceCode</i>
|
|
205
|
-
* @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, status, reason, psp, accountCode, invoiceCode</i>
|
|
206
207
|
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: id, createdAt, updatedAt, amount, psp, accountCode, invoiceCode, reason, status</i>
|
|
207
208
|
* @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, updatedAt, amount</i>
|
|
208
209
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: refundItems<i>
|
|
210
|
+
* @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, status, reason, psp, accountCode, invoiceCode</i>
|
|
209
211
|
* @param {*} [options] Override http request option.
|
|
210
212
|
* @throws {RequiredError}
|
|
211
213
|
*/
|
|
212
|
-
listRefunds: function (authorization,
|
|
214
|
+
listRefunds: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
213
215
|
if (options === void 0) { options = {}; }
|
|
214
216
|
return __awaiter(_this, void 0, void 0, function () {
|
|
215
217
|
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
@@ -232,12 +234,15 @@ var RefundsApiAxiosParamCreator = function (configuration) {
|
|
|
232
234
|
// authentication bearer required
|
|
233
235
|
// http bearer authentication required
|
|
234
236
|
_a.sent();
|
|
237
|
+
if (pageSize !== undefined) {
|
|
238
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
239
|
+
}
|
|
240
|
+
if (pageToken !== undefined) {
|
|
241
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
242
|
+
}
|
|
235
243
|
if (filter !== undefined) {
|
|
236
244
|
localVarQueryParameter['filter'] = filter;
|
|
237
245
|
}
|
|
238
|
-
if (filters !== undefined) {
|
|
239
|
-
localVarQueryParameter['filters'] = filters;
|
|
240
|
-
}
|
|
241
246
|
if (search !== undefined) {
|
|
242
247
|
localVarQueryParameter['search'] = search;
|
|
243
248
|
}
|
|
@@ -247,6 +252,9 @@ var RefundsApiAxiosParamCreator = function (configuration) {
|
|
|
247
252
|
if (expand !== undefined) {
|
|
248
253
|
localVarQueryParameter['expand'] = expand;
|
|
249
254
|
}
|
|
255
|
+
if (filters !== undefined) {
|
|
256
|
+
localVarQueryParameter['filters'] = filters;
|
|
257
|
+
}
|
|
250
258
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
251
259
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
252
260
|
}
|
|
@@ -272,7 +280,7 @@ var RefundsApiFp = function (configuration) {
|
|
|
272
280
|
var localVarAxiosParamCreator = (0, exports.RefundsApiAxiosParamCreator)(configuration);
|
|
273
281
|
return {
|
|
274
282
|
/**
|
|
275
|
-
* This will create a refund in the database.
|
|
283
|
+
* This will create a refund in the database. **Required Permissions** \"payment-management.payments.create\"
|
|
276
284
|
* @summary Create the refund
|
|
277
285
|
* @param {CreateRefundRequestDto} createRefundRequestDto
|
|
278
286
|
* @param {string} [authorization] Bearer Token
|
|
@@ -293,7 +301,7 @@ var RefundsApiFp = function (configuration) {
|
|
|
293
301
|
});
|
|
294
302
|
},
|
|
295
303
|
/**
|
|
296
|
-
* Retrieves the details of the refund that was previously created. Supply the unique refund code that was returned when you created it and Emil Api will return the corresponding refund information.
|
|
304
|
+
* Retrieves the details of the refund that was previously created. Supply the unique refund code that was returned when you created it and Emil Api will return the corresponding refund information. **Required Permissions** \"payment-management.payments.view\"
|
|
297
305
|
* @summary Retrieve the refund
|
|
298
306
|
* @param {string} code
|
|
299
307
|
* @param {string} [authorization] Bearer Token
|
|
@@ -315,23 +323,25 @@ var RefundsApiFp = function (configuration) {
|
|
|
315
323
|
});
|
|
316
324
|
},
|
|
317
325
|
/**
|
|
318
|
-
* Returns a list of refunds you have previously created. The refunds are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
326
|
+
* Returns a list of refunds you have previously created. The refunds 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\"
|
|
319
327
|
* @summary List refunds
|
|
320
328
|
* @param {string} [authorization] Bearer Token
|
|
329
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
330
|
+
* @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.
|
|
321
331
|
* @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, status, reason, psp, accountCode, invoiceCode</i>
|
|
322
|
-
* @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, status, reason, psp, accountCode, invoiceCode</i>
|
|
323
332
|
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: id, createdAt, updatedAt, amount, psp, accountCode, invoiceCode, reason, status</i>
|
|
324
333
|
* @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, updatedAt, amount</i>
|
|
325
334
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: refundItems<i>
|
|
335
|
+
* @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, status, reason, psp, accountCode, invoiceCode</i>
|
|
326
336
|
* @param {*} [options] Override http request option.
|
|
327
337
|
* @throws {RequiredError}
|
|
328
338
|
*/
|
|
329
|
-
listRefunds: function (authorization,
|
|
339
|
+
listRefunds: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
330
340
|
return __awaiter(this, void 0, void 0, function () {
|
|
331
341
|
var localVarAxiosArgs;
|
|
332
342
|
return __generator(this, function (_a) {
|
|
333
343
|
switch (_a.label) {
|
|
334
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.listRefunds(authorization,
|
|
344
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.listRefunds(authorization, pageSize, pageToken, filter, search, order, expand, filters, options)];
|
|
335
345
|
case 1:
|
|
336
346
|
localVarAxiosArgs = _a.sent();
|
|
337
347
|
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
@@ -350,7 +360,7 @@ var RefundsApiFactory = function (configuration, basePath, axios) {
|
|
|
350
360
|
var localVarFp = (0, exports.RefundsApiFp)(configuration);
|
|
351
361
|
return {
|
|
352
362
|
/**
|
|
353
|
-
* This will create a refund in the database.
|
|
363
|
+
* This will create a refund in the database. **Required Permissions** \"payment-management.payments.create\"
|
|
354
364
|
* @summary Create the refund
|
|
355
365
|
* @param {CreateRefundRequestDto} createRefundRequestDto
|
|
356
366
|
* @param {string} [authorization] Bearer Token
|
|
@@ -361,7 +371,7 @@ var RefundsApiFactory = function (configuration, basePath, axios) {
|
|
|
361
371
|
return localVarFp.createRefund(createRefundRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
362
372
|
},
|
|
363
373
|
/**
|
|
364
|
-
* Retrieves the details of the refund that was previously created. Supply the unique refund code that was returned when you created it and Emil Api will return the corresponding refund information.
|
|
374
|
+
* Retrieves the details of the refund that was previously created. Supply the unique refund code that was returned when you created it and Emil Api will return the corresponding refund information. **Required Permissions** \"payment-management.payments.view\"
|
|
365
375
|
* @summary Retrieve the refund
|
|
366
376
|
* @param {string} code
|
|
367
377
|
* @param {string} [authorization] Bearer Token
|
|
@@ -373,19 +383,21 @@ var RefundsApiFactory = function (configuration, basePath, axios) {
|
|
|
373
383
|
return localVarFp.getRefund(code, authorization, expand, options).then(function (request) { return request(axios, basePath); });
|
|
374
384
|
},
|
|
375
385
|
/**
|
|
376
|
-
* Returns a list of refunds you have previously created. The refunds are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
386
|
+
* Returns a list of refunds you have previously created. The refunds 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\"
|
|
377
387
|
* @summary List refunds
|
|
378
388
|
* @param {string} [authorization] Bearer Token
|
|
389
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
390
|
+
* @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.
|
|
379
391
|
* @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, status, reason, psp, accountCode, invoiceCode</i>
|
|
380
|
-
* @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, status, reason, psp, accountCode, invoiceCode</i>
|
|
381
392
|
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: id, createdAt, updatedAt, amount, psp, accountCode, invoiceCode, reason, status</i>
|
|
382
393
|
* @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, updatedAt, amount</i>
|
|
383
394
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: refundItems<i>
|
|
395
|
+
* @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, status, reason, psp, accountCode, invoiceCode</i>
|
|
384
396
|
* @param {*} [options] Override http request option.
|
|
385
397
|
* @throws {RequiredError}
|
|
386
398
|
*/
|
|
387
|
-
listRefunds: function (authorization,
|
|
388
|
-
return localVarFp.listRefunds(authorization,
|
|
399
|
+
listRefunds: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
400
|
+
return localVarFp.listRefunds(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
|
|
389
401
|
},
|
|
390
402
|
};
|
|
391
403
|
};
|
|
@@ -402,7 +414,7 @@ var RefundsApi = /** @class */ (function (_super) {
|
|
|
402
414
|
return _super !== null && _super.apply(this, arguments) || this;
|
|
403
415
|
}
|
|
404
416
|
/**
|
|
405
|
-
* This will create a refund in the database.
|
|
417
|
+
* This will create a refund in the database. **Required Permissions** \"payment-management.payments.create\"
|
|
406
418
|
* @summary Create the refund
|
|
407
419
|
* @param {RefundsApiCreateRefundRequest} requestParameters Request parameters.
|
|
408
420
|
* @param {*} [options] Override http request option.
|
|
@@ -414,7 +426,7 @@ var RefundsApi = /** @class */ (function (_super) {
|
|
|
414
426
|
return (0, exports.RefundsApiFp)(this.configuration).createRefund(requestParameters.createRefundRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
415
427
|
};
|
|
416
428
|
/**
|
|
417
|
-
* Retrieves the details of the refund that was previously created. Supply the unique refund code that was returned when you created it and Emil Api will return the corresponding refund information.
|
|
429
|
+
* Retrieves the details of the refund that was previously created. Supply the unique refund code that was returned when you created it and Emil Api will return the corresponding refund information. **Required Permissions** \"payment-management.payments.view\"
|
|
418
430
|
* @summary Retrieve the refund
|
|
419
431
|
* @param {RefundsApiGetRefundRequest} requestParameters Request parameters.
|
|
420
432
|
* @param {*} [options] Override http request option.
|
|
@@ -426,7 +438,7 @@ var RefundsApi = /** @class */ (function (_super) {
|
|
|
426
438
|
return (0, exports.RefundsApiFp)(this.configuration).getRefund(requestParameters.code, requestParameters.authorization, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
427
439
|
};
|
|
428
440
|
/**
|
|
429
|
-
* Returns a list of refunds you have previously created. The refunds are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
441
|
+
* Returns a list of refunds you have previously created. The refunds 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\"
|
|
430
442
|
* @summary List refunds
|
|
431
443
|
* @param {RefundsApiListRefundsRequest} requestParameters Request parameters.
|
|
432
444
|
* @param {*} [options] Override http request option.
|
|
@@ -436,7 +448,7 @@ var RefundsApi = /** @class */ (function (_super) {
|
|
|
436
448
|
RefundsApi.prototype.listRefunds = function (requestParameters, options) {
|
|
437
449
|
var _this = this;
|
|
438
450
|
if (requestParameters === void 0) { requestParameters = {}; }
|
|
439
|
-
return (0, exports.RefundsApiFp)(this.configuration).listRefunds(requestParameters.authorization, requestParameters.
|
|
451
|
+
return (0, exports.RefundsApiFp)(this.configuration).listRefunds(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); });
|
|
440
452
|
};
|
|
441
453
|
return RefundsApi;
|
|
442
454
|
}(base_1.BaseAPI));
|
|
@@ -55,15 +55,17 @@ export declare const TenantBankAccountApiAxiosParamCreator: (configuration?: Con
|
|
|
55
55
|
* Returns a list of tenant bank accounts you have previously created. The tenant bank accounts are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
56
56
|
* @summary List tenant bank accounts
|
|
57
57
|
* @param {string} [authorization] Bearer Token
|
|
58
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
59
|
+
* @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.
|
|
58
60
|
* @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: id, code, iban, bankName, accountName</i>
|
|
59
|
-
* @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: id, code, iban, bankName, accountName</i>
|
|
60
61
|
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: id, iban, bankName, accountName</i>
|
|
61
62
|
* @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>
|
|
62
63
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: bankTransactions<i>
|
|
64
|
+
* @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: id, code, iban, bankName, accountName</i>
|
|
63
65
|
* @param {*} [options] Override http request option.
|
|
64
66
|
* @throws {RequiredError}
|
|
65
67
|
*/
|
|
66
|
-
listTenantBankAccounts: (authorization?: string,
|
|
68
|
+
listTenantBankAccounts: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
67
69
|
/**
|
|
68
70
|
* Update a tenant bank account by code
|
|
69
71
|
* @summary Update the tenant bank account
|
|
@@ -112,15 +114,17 @@ export declare const TenantBankAccountApiFp: (configuration?: Configuration) =>
|
|
|
112
114
|
* Returns a list of tenant bank accounts you have previously created. The tenant bank accounts are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
113
115
|
* @summary List tenant bank accounts
|
|
114
116
|
* @param {string} [authorization] Bearer Token
|
|
117
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
118
|
+
* @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.
|
|
115
119
|
* @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: id, code, iban, bankName, accountName</i>
|
|
116
|
-
* @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: id, code, iban, bankName, accountName</i>
|
|
117
120
|
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: id, iban, bankName, accountName</i>
|
|
118
121
|
* @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>
|
|
119
122
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: bankTransactions<i>
|
|
123
|
+
* @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: id, code, iban, bankName, accountName</i>
|
|
120
124
|
* @param {*} [options] Override http request option.
|
|
121
125
|
* @throws {RequiredError}
|
|
122
126
|
*/
|
|
123
|
-
listTenantBankAccounts(authorization?: string,
|
|
127
|
+
listTenantBankAccounts(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListTenantBankAccountResponseClass>>;
|
|
124
128
|
/**
|
|
125
129
|
* Update a tenant bank account by code
|
|
126
130
|
* @summary Update the tenant bank account
|
|
@@ -169,15 +173,17 @@ export declare const TenantBankAccountApiFactory: (configuration?: Configuration
|
|
|
169
173
|
* Returns a list of tenant bank accounts you have previously created. The tenant bank accounts are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
170
174
|
* @summary List tenant bank accounts
|
|
171
175
|
* @param {string} [authorization] Bearer Token
|
|
176
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
177
|
+
* @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.
|
|
172
178
|
* @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: id, code, iban, bankName, accountName</i>
|
|
173
|
-
* @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: id, code, iban, bankName, accountName</i>
|
|
174
179
|
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: id, iban, bankName, accountName</i>
|
|
175
180
|
* @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>
|
|
176
181
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: bankTransactions<i>
|
|
182
|
+
* @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: id, code, iban, bankName, accountName</i>
|
|
177
183
|
* @param {*} [options] Override http request option.
|
|
178
184
|
* @throws {RequiredError}
|
|
179
185
|
*/
|
|
180
|
-
listTenantBankAccounts(authorization?: string,
|
|
186
|
+
listTenantBankAccounts(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListTenantBankAccountResponseClass>;
|
|
181
187
|
/**
|
|
182
188
|
* Update a tenant bank account by code
|
|
183
189
|
* @summary Update the tenant bank account
|
|
@@ -265,17 +271,23 @@ export interface TenantBankAccountApiListTenantBankAccountsRequest {
|
|
|
265
271
|
*/
|
|
266
272
|
readonly authorization?: string;
|
|
267
273
|
/**
|
|
268
|
-
*
|
|
274
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
275
|
+
* @type {number}
|
|
276
|
+
* @memberof TenantBankAccountApiListTenantBankAccounts
|
|
277
|
+
*/
|
|
278
|
+
readonly pageSize?: number;
|
|
279
|
+
/**
|
|
280
|
+
* 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.
|
|
269
281
|
* @type {string}
|
|
270
282
|
* @memberof TenantBankAccountApiListTenantBankAccounts
|
|
271
283
|
*/
|
|
272
|
-
readonly
|
|
284
|
+
readonly pageToken?: string;
|
|
273
285
|
/**
|
|
274
|
-
*
|
|
286
|
+
* 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: id, code, iban, bankName, accountName</i>
|
|
275
287
|
* @type {string}
|
|
276
288
|
* @memberof TenantBankAccountApiListTenantBankAccounts
|
|
277
289
|
*/
|
|
278
|
-
readonly
|
|
290
|
+
readonly filter?: string;
|
|
279
291
|
/**
|
|
280
292
|
* Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: id, iban, bankName, accountName</i>
|
|
281
293
|
* @type {string}
|
|
@@ -294,6 +306,12 @@ export interface TenantBankAccountApiListTenantBankAccountsRequest {
|
|
|
294
306
|
* @memberof TenantBankAccountApiListTenantBankAccounts
|
|
295
307
|
*/
|
|
296
308
|
readonly expand?: string;
|
|
309
|
+
/**
|
|
310
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, iban, bankName, accountName</i>
|
|
311
|
+
* @type {string}
|
|
312
|
+
* @memberof TenantBankAccountApiListTenantBankAccounts
|
|
313
|
+
*/
|
|
314
|
+
readonly filters?: string;
|
|
297
315
|
}
|
|
298
316
|
/**
|
|
299
317
|
* Request parameters for updateTenantBankAccount operation in TenantBankAccountApi.
|