@emilgroup/payment-sdk 1.16.1-beta.8 → 1.16.1-beta.80
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 +16 -16
- package/api/bank-orders-api.ts +16 -16
- package/api/bank-transaction-api.ts +12 -12
- package/api/billing-addresses-api.ts +12 -12
- package/api/credit-allocation-api.ts +12 -12
- package/api/exceeding-credits-api.ts +12 -12
- package/api/ibanvalidator-api.ts +165 -0
- package/api/payment-methods-api.ts +12 -12
- package/api/payment-receipts-api.ts +676 -0
- package/api/payment-reminders-api.ts +16 -16
- package/api/payment-requests-api.ts +20 -20
- package/api/payments-api.ts +12 -12
- package/api/payout-methods-api.ts +138 -20
- package/api/refunds-api.ts +12 -12
- package/api/tenant-bank-account-api.ts +12 -12
- package/api/webhooks-api.ts +125 -14
- package/api.ts +4 -0
- package/base.ts +1 -0
- package/dist/api/bank-accounts-api.d.ts +16 -16
- package/dist/api/bank-accounts-api.js +13 -13
- package/dist/api/bank-orders-api.d.ts +16 -16
- package/dist/api/bank-orders-api.js +14 -14
- package/dist/api/bank-transaction-api.d.ts +12 -12
- package/dist/api/bank-transaction-api.js +10 -10
- package/dist/api/billing-addresses-api.d.ts +12 -12
- package/dist/api/billing-addresses-api.js +10 -10
- package/dist/api/credit-allocation-api.d.ts +12 -12
- package/dist/api/credit-allocation-api.js +10 -10
- package/dist/api/exceeding-credits-api.d.ts +12 -12
- package/dist/api/exceeding-credits-api.js +10 -10
- package/dist/api/ibanvalidator-api.d.ts +97 -0
- package/dist/api/ibanvalidator-api.js +224 -0
- package/dist/api/payment-methods-api.d.ts +12 -12
- package/dist/api/payment-methods-api.js +10 -10
- package/dist/api/payment-receipts-api.d.ts +383 -0
- package/dist/api/payment-receipts-api.js +637 -0
- package/dist/api/payment-reminders-api.d.ts +16 -16
- package/dist/api/payment-reminders-api.js +13 -13
- package/dist/api/payment-requests-api.d.ts +20 -20
- package/dist/api/payment-requests-api.js +15 -15
- package/dist/api/payments-api.d.ts +12 -12
- package/dist/api/payments-api.js +10 -10
- package/dist/api/payout-methods-api.d.ts +85 -20
- package/dist/api/payout-methods-api.js +115 -16
- package/dist/api/refunds-api.d.ts +12 -12
- package/dist/api/refunds-api.js +10 -10
- package/dist/api/tenant-bank-account-api.d.ts +12 -12
- package/dist/api/tenant-bank-account-api.js +10 -10
- package/dist/api/webhooks-api.d.ts +73 -9
- package/dist/api/webhooks-api.js +100 -11
- package/dist/api.d.ts +2 -0
- package/dist/api.js +2 -0
- package/dist/base.d.ts +2 -1
- package/dist/base.js +1 -0
- package/dist/models/bank-account-class-without-expand-properties.d.ts +6 -0
- package/dist/models/bank-account-class.d.ts +6 -0
- package/dist/models/bank-data-class.d.ts +36 -0
- package/dist/models/bank-data-class.js +15 -0
- package/dist/models/create-payment-receipt-request-dto.d.ts +65 -0
- package/dist/models/create-payment-receipt-request-dto.js +20 -0
- package/dist/models/create-payment-receipt-response-class.d.ts +25 -0
- package/dist/models/create-payment-receipt-response-class.js +15 -0
- package/dist/models/create-payment-request-request-dto.d.ts +20 -8
- package/dist/models/create-payment-request-request-dto.js +3 -5
- package/dist/models/create-payout-method-by-bank-account-request-dto.d.ts +36 -0
- package/dist/models/create-payout-method-by-bank-account-request-dto.js +15 -0
- package/dist/models/create-payout-method-request-dto.d.ts +8 -2
- package/dist/models/credit-allocation-class.d.ts +6 -0
- package/dist/models/credit-allocation-entity.d.ts +6 -0
- package/dist/models/get-payment-receipt-response-class.d.ts +25 -0
- package/dist/models/get-payment-receipt-response-class.js +15 -0
- package/dist/models/index.d.ts +10 -0
- package/dist/models/index.js +10 -0
- package/dist/models/list-payment-receipts-response-class.d.ts +43 -0
- package/dist/models/list-payment-receipts-response-class.js +15 -0
- package/dist/models/payment-class-without-expand-properties.d.ts +1 -1
- package/dist/models/payment-class.d.ts +1 -1
- package/dist/models/payment-entity.d.ts +1 -1
- package/dist/models/payment-receipt-class.d.ts +101 -0
- package/dist/models/payment-receipt-class.js +20 -0
- package/dist/models/payment-request-class.d.ts +35 -10
- package/dist/models/payment-request-class.js +4 -6
- package/dist/models/payout-method-class.d.ts +6 -0
- package/dist/models/update-payment-receipt-response-class.d.ts +25 -0
- package/dist/models/update-payment-receipt-response-class.js +15 -0
- package/dist/models/update-payment-request-request-dto.d.ts +2 -2
- package/dist/models/update-payment-request-request-dto.js +1 -1
- package/dist/models/validate-iban-request-dto.d.ts +24 -0
- package/dist/models/validate-iban-request-dto.js +15 -0
- package/dist/models/validate-iban-response-class.d.ts +31 -0
- package/dist/models/validate-iban-response-class.js +15 -0
- package/models/bank-account-class-without-expand-properties.ts +6 -0
- package/models/bank-account-class.ts +6 -0
- package/models/bank-data-class.ts +42 -0
- package/models/create-payment-receipt-request-dto.ts +74 -0
- package/models/create-payment-receipt-response-class.ts +31 -0
- package/models/create-payment-request-request-dto.ts +18 -8
- package/models/create-payout-method-by-bank-account-request-dto.ts +42 -0
- package/models/create-payout-method-request-dto.ts +8 -2
- package/models/credit-allocation-class.ts +6 -0
- package/models/credit-allocation-entity.ts +6 -0
- package/models/get-payment-receipt-response-class.ts +31 -0
- package/models/index.ts +10 -0
- package/models/list-payment-receipts-response-class.ts +49 -0
- package/models/payment-class-without-expand-properties.ts +1 -1
- package/models/payment-class.ts +1 -1
- package/models/payment-entity.ts +1 -1
- package/models/payment-receipt-class.ts +110 -0
- package/models/payment-request-class.ts +33 -10
- package/models/payout-method-class.ts +6 -0
- package/models/update-payment-receipt-response-class.ts +31 -0
- package/models/update-payment-request-request-dto.ts +2 -2
- package/models/validate-iban-request-dto.ts +30 -0
- package/models/validate-iban-response-class.ts +37 -0
- package/package.json +2 -2
package/api/webhooks-api.ts
CHANGED
|
@@ -31,20 +31,66 @@ export const WebhooksApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
31
31
|
* @summary Handle the webhook from PSP
|
|
32
32
|
* @param {string} pspType The type of the payment service provider (PSP).<br/> <br/> <i>Supported PSP: braintree, stripe, b4u, eis, adyen</i>
|
|
33
33
|
* @param {string} tenantSlug Unique slug identifier representing a tenant.
|
|
34
|
-
* @param {string} productSlug
|
|
35
34
|
* @param {object} body Accepts a webhook payload. The structure may vary depending on the payment service provider.
|
|
36
35
|
* @param {*} [options] Override http request option.
|
|
37
36
|
* @throws {RequiredError}
|
|
38
37
|
*/
|
|
39
|
-
postWebhook: async (pspType: string, tenantSlug: string,
|
|
38
|
+
postWebhook: async (pspType: string, tenantSlug: string, body: object, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
40
39
|
// verify required parameter 'pspType' is not null or undefined
|
|
41
40
|
assertParamExists('postWebhook', 'pspType', pspType)
|
|
42
41
|
// verify required parameter 'tenantSlug' is not null or undefined
|
|
43
42
|
assertParamExists('postWebhook', 'tenantSlug', tenantSlug)
|
|
44
|
-
// verify required parameter 'productSlug' is not null or undefined
|
|
45
|
-
assertParamExists('postWebhook', 'productSlug', productSlug)
|
|
46
43
|
// verify required parameter 'body' is not null or undefined
|
|
47
44
|
assertParamExists('postWebhook', 'body', body)
|
|
45
|
+
const localVarPath = `/paymentservice/v1/webhooks/{pspType}/{tenantSlug}`
|
|
46
|
+
.replace(`{${"pspType"}}`, encodeURIComponent(String(pspType)))
|
|
47
|
+
.replace(`{${"tenantSlug"}}`, encodeURIComponent(String(tenantSlug)));
|
|
48
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
49
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
50
|
+
let baseOptions;
|
|
51
|
+
let baseAccessToken;
|
|
52
|
+
if (configuration) {
|
|
53
|
+
baseOptions = configuration.baseOptions;
|
|
54
|
+
baseAccessToken = configuration.accessToken;
|
|
55
|
+
}
|
|
56
|
+
|
|
57
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
58
|
+
const localVarHeaderParameter = {} as any;
|
|
59
|
+
const localVarQueryParameter = {} as any;
|
|
60
|
+
|
|
61
|
+
|
|
62
|
+
|
|
63
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
64
|
+
|
|
65
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
66
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
67
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
68
|
+
localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration)
|
|
69
|
+
|
|
70
|
+
return {
|
|
71
|
+
url: toPathString(localVarUrlObj),
|
|
72
|
+
options: localVarRequestOptions,
|
|
73
|
+
};
|
|
74
|
+
},
|
|
75
|
+
/**
|
|
76
|
+
* This will processes the webhook from external payment service provider. **Required Permissions** none
|
|
77
|
+
* @summary Handle the webhook from PSP
|
|
78
|
+
* @param {string} pspType The type of the payment service provider (PSP).<br/> <br/> <i>Supported PSP: braintree, stripe, b4u, eis, adyen</i>
|
|
79
|
+
* @param {string} tenantSlug Unique slug identifier representing a tenant.
|
|
80
|
+
* @param {string} productSlug Optional product slug associated with the webhook.
|
|
81
|
+
* @param {object} body Accepts a webhook payload. The structure may vary depending on the payment service provider.
|
|
82
|
+
* @param {*} [options] Override http request option.
|
|
83
|
+
* @throws {RequiredError}
|
|
84
|
+
*/
|
|
85
|
+
postWebhookWithProductSlug: async (pspType: string, tenantSlug: string, productSlug: string, body: object, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
86
|
+
// verify required parameter 'pspType' is not null or undefined
|
|
87
|
+
assertParamExists('postWebhookWithProductSlug', 'pspType', pspType)
|
|
88
|
+
// verify required parameter 'tenantSlug' is not null or undefined
|
|
89
|
+
assertParamExists('postWebhookWithProductSlug', 'tenantSlug', tenantSlug)
|
|
90
|
+
// verify required parameter 'productSlug' is not null or undefined
|
|
91
|
+
assertParamExists('postWebhookWithProductSlug', 'productSlug', productSlug)
|
|
92
|
+
// verify required parameter 'body' is not null or undefined
|
|
93
|
+
assertParamExists('postWebhookWithProductSlug', 'body', body)
|
|
48
94
|
const localVarPath = `/paymentservice/v1/webhooks/{pspType}/{tenantSlug}/{productSlug}`
|
|
49
95
|
.replace(`{${"pspType"}}`, encodeURIComponent(String(pspType)))
|
|
50
96
|
.replace(`{${"tenantSlug"}}`, encodeURIComponent(String(tenantSlug)))
|
|
@@ -91,13 +137,26 @@ export const WebhooksApiFp = function(configuration?: Configuration) {
|
|
|
91
137
|
* @summary Handle the webhook from PSP
|
|
92
138
|
* @param {string} pspType The type of the payment service provider (PSP).<br/> <br/> <i>Supported PSP: braintree, stripe, b4u, eis, adyen</i>
|
|
93
139
|
* @param {string} tenantSlug Unique slug identifier representing a tenant.
|
|
94
|
-
* @param {string} productSlug
|
|
95
140
|
* @param {object} body Accepts a webhook payload. The structure may vary depending on the payment service provider.
|
|
96
141
|
* @param {*} [options] Override http request option.
|
|
97
142
|
* @throws {RequiredError}
|
|
98
143
|
*/
|
|
99
|
-
async postWebhook(pspType: string, tenantSlug: string,
|
|
100
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.postWebhook(pspType, tenantSlug,
|
|
144
|
+
async postWebhook(pspType: string, tenantSlug: string, body: object, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
145
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.postWebhook(pspType, tenantSlug, body, options);
|
|
146
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
147
|
+
},
|
|
148
|
+
/**
|
|
149
|
+
* This will processes the webhook from external payment service provider. **Required Permissions** none
|
|
150
|
+
* @summary Handle the webhook from PSP
|
|
151
|
+
* @param {string} pspType The type of the payment service provider (PSP).<br/> <br/> <i>Supported PSP: braintree, stripe, b4u, eis, adyen</i>
|
|
152
|
+
* @param {string} tenantSlug Unique slug identifier representing a tenant.
|
|
153
|
+
* @param {string} productSlug Optional product slug associated with the webhook.
|
|
154
|
+
* @param {object} body Accepts a webhook payload. The structure may vary depending on the payment service provider.
|
|
155
|
+
* @param {*} [options] Override http request option.
|
|
156
|
+
* @throws {RequiredError}
|
|
157
|
+
*/
|
|
158
|
+
async postWebhookWithProductSlug(pspType: string, tenantSlug: string, productSlug: string, body: object, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
159
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.postWebhookWithProductSlug(pspType, tenantSlug, productSlug, body, options);
|
|
101
160
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
102
161
|
},
|
|
103
162
|
}
|
|
@@ -115,13 +174,25 @@ export const WebhooksApiFactory = function (configuration?: Configuration, baseP
|
|
|
115
174
|
* @summary Handle the webhook from PSP
|
|
116
175
|
* @param {string} pspType The type of the payment service provider (PSP).<br/> <br/> <i>Supported PSP: braintree, stripe, b4u, eis, adyen</i>
|
|
117
176
|
* @param {string} tenantSlug Unique slug identifier representing a tenant.
|
|
118
|
-
* @param {string} productSlug
|
|
119
177
|
* @param {object} body Accepts a webhook payload. The structure may vary depending on the payment service provider.
|
|
120
178
|
* @param {*} [options] Override http request option.
|
|
121
179
|
* @throws {RequiredError}
|
|
122
180
|
*/
|
|
123
|
-
postWebhook(pspType: string, tenantSlug: string,
|
|
124
|
-
return localVarFp.postWebhook(pspType, tenantSlug,
|
|
181
|
+
postWebhook(pspType: string, tenantSlug: string, body: object, options?: any): AxiosPromise<void> {
|
|
182
|
+
return localVarFp.postWebhook(pspType, tenantSlug, body, options).then((request) => request(axios, basePath));
|
|
183
|
+
},
|
|
184
|
+
/**
|
|
185
|
+
* This will processes the webhook from external payment service provider. **Required Permissions** none
|
|
186
|
+
* @summary Handle the webhook from PSP
|
|
187
|
+
* @param {string} pspType The type of the payment service provider (PSP).<br/> <br/> <i>Supported PSP: braintree, stripe, b4u, eis, adyen</i>
|
|
188
|
+
* @param {string} tenantSlug Unique slug identifier representing a tenant.
|
|
189
|
+
* @param {string} productSlug Optional product slug associated with the webhook.
|
|
190
|
+
* @param {object} body Accepts a webhook payload. The structure may vary depending on the payment service provider.
|
|
191
|
+
* @param {*} [options] Override http request option.
|
|
192
|
+
* @throws {RequiredError}
|
|
193
|
+
*/
|
|
194
|
+
postWebhookWithProductSlug(pspType: string, tenantSlug: string, productSlug: string, body: object, options?: any): AxiosPromise<void> {
|
|
195
|
+
return localVarFp.postWebhookWithProductSlug(pspType, tenantSlug, productSlug, body, options).then((request) => request(axios, basePath));
|
|
125
196
|
},
|
|
126
197
|
};
|
|
127
198
|
};
|
|
@@ -147,16 +218,44 @@ export interface WebhooksApiPostWebhookRequest {
|
|
|
147
218
|
readonly tenantSlug: string
|
|
148
219
|
|
|
149
220
|
/**
|
|
150
|
-
*
|
|
151
|
-
* @type {
|
|
221
|
+
* Accepts a webhook payload. The structure may vary depending on the payment service provider.
|
|
222
|
+
* @type {object}
|
|
152
223
|
* @memberof WebhooksApiPostWebhook
|
|
153
224
|
*/
|
|
225
|
+
readonly body: object
|
|
226
|
+
}
|
|
227
|
+
|
|
228
|
+
/**
|
|
229
|
+
* Request parameters for postWebhookWithProductSlug operation in WebhooksApi.
|
|
230
|
+
* @export
|
|
231
|
+
* @interface WebhooksApiPostWebhookWithProductSlugRequest
|
|
232
|
+
*/
|
|
233
|
+
export interface WebhooksApiPostWebhookWithProductSlugRequest {
|
|
234
|
+
/**
|
|
235
|
+
* The type of the payment service provider (PSP).<br/> <br/> <i>Supported PSP: braintree, stripe, b4u, eis, adyen</i>
|
|
236
|
+
* @type {string}
|
|
237
|
+
* @memberof WebhooksApiPostWebhookWithProductSlug
|
|
238
|
+
*/
|
|
239
|
+
readonly pspType: string
|
|
240
|
+
|
|
241
|
+
/**
|
|
242
|
+
* Unique slug identifier representing a tenant.
|
|
243
|
+
* @type {string}
|
|
244
|
+
* @memberof WebhooksApiPostWebhookWithProductSlug
|
|
245
|
+
*/
|
|
246
|
+
readonly tenantSlug: string
|
|
247
|
+
|
|
248
|
+
/**
|
|
249
|
+
* Optional product slug associated with the webhook.
|
|
250
|
+
* @type {string}
|
|
251
|
+
* @memberof WebhooksApiPostWebhookWithProductSlug
|
|
252
|
+
*/
|
|
154
253
|
readonly productSlug: string
|
|
155
254
|
|
|
156
255
|
/**
|
|
157
256
|
* Accepts a webhook payload. The structure may vary depending on the payment service provider.
|
|
158
257
|
* @type {object}
|
|
159
|
-
* @memberof
|
|
258
|
+
* @memberof WebhooksApiPostWebhookWithProductSlug
|
|
160
259
|
*/
|
|
161
260
|
readonly body: object
|
|
162
261
|
}
|
|
@@ -177,6 +276,18 @@ export class WebhooksApi extends BaseAPI {
|
|
|
177
276
|
* @memberof WebhooksApi
|
|
178
277
|
*/
|
|
179
278
|
public postWebhook(requestParameters: WebhooksApiPostWebhookRequest, options?: AxiosRequestConfig) {
|
|
180
|
-
return WebhooksApiFp(this.configuration).postWebhook(requestParameters.pspType, requestParameters.tenantSlug, requestParameters.
|
|
279
|
+
return WebhooksApiFp(this.configuration).postWebhook(requestParameters.pspType, requestParameters.tenantSlug, requestParameters.body, options).then((request) => request(this.axios, this.basePath));
|
|
280
|
+
}
|
|
281
|
+
|
|
282
|
+
/**
|
|
283
|
+
* This will processes the webhook from external payment service provider. **Required Permissions** none
|
|
284
|
+
* @summary Handle the webhook from PSP
|
|
285
|
+
* @param {WebhooksApiPostWebhookWithProductSlugRequest} requestParameters Request parameters.
|
|
286
|
+
* @param {*} [options] Override http request option.
|
|
287
|
+
* @throws {RequiredError}
|
|
288
|
+
* @memberof WebhooksApi
|
|
289
|
+
*/
|
|
290
|
+
public postWebhookWithProductSlug(requestParameters: WebhooksApiPostWebhookWithProductSlugRequest, options?: AxiosRequestConfig) {
|
|
291
|
+
return WebhooksApiFp(this.configuration).postWebhookWithProductSlug(requestParameters.pspType, requestParameters.tenantSlug, requestParameters.productSlug, requestParameters.body, options).then((request) => request(this.axios, this.basePath));
|
|
181
292
|
}
|
|
182
293
|
}
|
package/api.ts
CHANGED
|
@@ -27,7 +27,9 @@ import { BillingAddressesApi } from './api';
|
|
|
27
27
|
import { CreditAllocationApi } from './api';
|
|
28
28
|
import { ExceedingCreditsApi } from './api';
|
|
29
29
|
import { HealthCheckApi } from './api';
|
|
30
|
+
import { IBANValidatorApi } from './api';
|
|
30
31
|
import { PaymentMethodsApi } from './api';
|
|
32
|
+
import { PaymentReceiptsApi } from './api';
|
|
31
33
|
import { PaymentRemindersApi } from './api';
|
|
32
34
|
import { PaymentRequestsApi } from './api';
|
|
33
35
|
import { PaymentSetupApi } from './api';
|
|
@@ -46,7 +48,9 @@ export * from './api/billing-addresses-api';
|
|
|
46
48
|
export * from './api/credit-allocation-api';
|
|
47
49
|
export * from './api/exceeding-credits-api';
|
|
48
50
|
export * from './api/health-check-api';
|
|
51
|
+
export * from './api/ibanvalidator-api';
|
|
49
52
|
export * from './api/payment-methods-api';
|
|
53
|
+
export * from './api/payment-receipts-api';
|
|
50
54
|
export * from './api/payment-reminders-api';
|
|
51
55
|
export * from './api/payment-requests-api';
|
|
52
56
|
export * from './api/payment-setup-api';
|
package/base.ts
CHANGED
|
@@ -53,6 +53,7 @@ export enum Environment {
|
|
|
53
53
|
Staging = 'https://apiv2-staging.emil.de',
|
|
54
54
|
Development = 'https://apiv2-dev.emil.de',
|
|
55
55
|
ProductionZurich = 'https://eu-central-2.apiv2.emil.de',
|
|
56
|
+
StagingZurich = 'https://eu-central-2.apiv2-staging.emil.de',
|
|
56
57
|
}
|
|
57
58
|
|
|
58
59
|
let _retry_count = 0
|
|
@@ -53,16 +53,16 @@ export declare const BankAccountsApiAxiosParamCreator: (configuration?: Configur
|
|
|
53
53
|
*/
|
|
54
54
|
getBankAccount: (code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
55
55
|
/**
|
|
56
|
-
* Returns a list of bank accounts you have previously created.
|
|
56
|
+
* Returns a list of bank accounts you have previously created. The bank accounts are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
57
57
|
* @summary List bank accounts
|
|
58
58
|
* @param {string} [authorization] Bearer Token
|
|
59
59
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
60
60
|
* @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.
|
|
61
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
62
|
-
* @param {string} [search]
|
|
61
|
+
* @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, accountCode, partnerCode</i>
|
|
62
|
+
* @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: accountHolder, bankName</i>
|
|
63
63
|
* @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>
|
|
64
64
|
* @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: primaryBankAccount<i>
|
|
65
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
65
|
+
* @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, accountCode, partnerCode</i>
|
|
66
66
|
* @param {*} [options] Override http request option.
|
|
67
67
|
* @throws {RequiredError}
|
|
68
68
|
*/
|
|
@@ -122,16 +122,16 @@ export declare const BankAccountsApiFp: (configuration?: Configuration) => {
|
|
|
122
122
|
*/
|
|
123
123
|
getBankAccount(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetBankAccountResponseClass>>;
|
|
124
124
|
/**
|
|
125
|
-
* Returns a list of bank accounts you have previously created.
|
|
125
|
+
* Returns a list of bank accounts you have previously created. The bank accounts are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
126
126
|
* @summary List bank accounts
|
|
127
127
|
* @param {string} [authorization] Bearer Token
|
|
128
128
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
129
129
|
* @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.
|
|
130
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
131
|
-
* @param {string} [search]
|
|
130
|
+
* @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, accountCode, partnerCode</i>
|
|
131
|
+
* @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: accountHolder, bankName</i>
|
|
132
132
|
* @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>
|
|
133
133
|
* @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: primaryBankAccount<i>
|
|
134
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
134
|
+
* @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, accountCode, partnerCode</i>
|
|
135
135
|
* @param {*} [options] Override http request option.
|
|
136
136
|
* @throws {RequiredError}
|
|
137
137
|
*/
|
|
@@ -191,16 +191,16 @@ export declare const BankAccountsApiFactory: (configuration?: Configuration, bas
|
|
|
191
191
|
*/
|
|
192
192
|
getBankAccount(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetBankAccountResponseClass>;
|
|
193
193
|
/**
|
|
194
|
-
* Returns a list of bank accounts you have previously created.
|
|
194
|
+
* Returns a list of bank accounts you have previously created. The bank accounts are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
195
195
|
* @summary List bank accounts
|
|
196
196
|
* @param {string} [authorization] Bearer Token
|
|
197
197
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
198
198
|
* @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.
|
|
199
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
200
|
-
* @param {string} [search]
|
|
199
|
+
* @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, accountCode, partnerCode</i>
|
|
200
|
+
* @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: accountHolder, bankName</i>
|
|
201
201
|
* @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>
|
|
202
202
|
* @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: primaryBankAccount<i>
|
|
203
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
203
|
+
* @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, accountCode, partnerCode</i>
|
|
204
204
|
* @param {*} [options] Override http request option.
|
|
205
205
|
* @throws {RequiredError}
|
|
206
206
|
*/
|
|
@@ -314,13 +314,13 @@ export interface BankAccountsApiListBankAccountsRequest {
|
|
|
314
314
|
*/
|
|
315
315
|
readonly pageToken?: string;
|
|
316
316
|
/**
|
|
317
|
-
* Filter the response by one or multiple fields.
|
|
317
|
+
* 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, accountCode, partnerCode</i>
|
|
318
318
|
* @type {string}
|
|
319
319
|
* @memberof BankAccountsApiListBankAccounts
|
|
320
320
|
*/
|
|
321
321
|
readonly filter?: string;
|
|
322
322
|
/**
|
|
323
|
-
*
|
|
323
|
+
* Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: accountHolder, bankName</i>
|
|
324
324
|
* @type {string}
|
|
325
325
|
* @memberof BankAccountsApiListBankAccounts
|
|
326
326
|
*/
|
|
@@ -338,7 +338,7 @@ export interface BankAccountsApiListBankAccountsRequest {
|
|
|
338
338
|
*/
|
|
339
339
|
readonly expand?: string;
|
|
340
340
|
/**
|
|
341
|
-
* Filters the response by one or multiple fields.
|
|
341
|
+
* 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, accountCode, partnerCode</i>
|
|
342
342
|
* @type {string}
|
|
343
343
|
* @memberof BankAccountsApiListBankAccounts
|
|
344
344
|
*/
|
|
@@ -429,7 +429,7 @@ export declare class BankAccountsApi extends BaseAPI {
|
|
|
429
429
|
*/
|
|
430
430
|
getBankAccount(requestParameters: BankAccountsApiGetBankAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetBankAccountResponseClass, any, {}>>;
|
|
431
431
|
/**
|
|
432
|
-
* Returns a list of bank accounts you have previously created.
|
|
432
|
+
* Returns a list of bank accounts you have previously created. The bank accounts are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
433
433
|
* @summary List bank accounts
|
|
434
434
|
* @param {BankAccountsApiListBankAccountsRequest} requestParameters Request parameters.
|
|
435
435
|
* @param {*} [options] Override http request option.
|
|
@@ -242,16 +242,16 @@ var BankAccountsApiAxiosParamCreator = function (configuration) {
|
|
|
242
242
|
});
|
|
243
243
|
},
|
|
244
244
|
/**
|
|
245
|
-
* Returns a list of bank accounts you have previously created.
|
|
245
|
+
* Returns a list of bank accounts you have previously created. The bank accounts are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
246
246
|
* @summary List bank accounts
|
|
247
247
|
* @param {string} [authorization] Bearer Token
|
|
248
248
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
249
249
|
* @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.
|
|
250
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
251
|
-
* @param {string} [search]
|
|
250
|
+
* @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, accountCode, partnerCode</i>
|
|
251
|
+
* @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: accountHolder, bankName</i>
|
|
252
252
|
* @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>
|
|
253
253
|
* @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: primaryBankAccount<i>
|
|
254
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
254
|
+
* @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, accountCode, partnerCode</i>
|
|
255
255
|
* @param {*} [options] Override http request option.
|
|
256
256
|
* @throws {RequiredError}
|
|
257
257
|
*/
|
|
@@ -494,16 +494,16 @@ var BankAccountsApiFp = function (configuration) {
|
|
|
494
494
|
});
|
|
495
495
|
},
|
|
496
496
|
/**
|
|
497
|
-
* Returns a list of bank accounts you have previously created.
|
|
497
|
+
* Returns a list of bank accounts you have previously created. The bank accounts are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
498
498
|
* @summary List bank accounts
|
|
499
499
|
* @param {string} [authorization] Bearer Token
|
|
500
500
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
501
501
|
* @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.
|
|
502
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
503
|
-
* @param {string} [search]
|
|
502
|
+
* @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, accountCode, partnerCode</i>
|
|
503
|
+
* @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: accountHolder, bankName</i>
|
|
504
504
|
* @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>
|
|
505
505
|
* @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: primaryBankAccount<i>
|
|
506
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
506
|
+
* @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, accountCode, partnerCode</i>
|
|
507
507
|
* @param {*} [options] Override http request option.
|
|
508
508
|
* @throws {RequiredError}
|
|
509
509
|
*/
|
|
@@ -609,16 +609,16 @@ var BankAccountsApiFactory = function (configuration, basePath, axios) {
|
|
|
609
609
|
return localVarFp.getBankAccount(code, authorization, expand, options).then(function (request) { return request(axios, basePath); });
|
|
610
610
|
},
|
|
611
611
|
/**
|
|
612
|
-
* Returns a list of bank accounts you have previously created.
|
|
612
|
+
* Returns a list of bank accounts you have previously created. The bank accounts are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
613
613
|
* @summary List bank accounts
|
|
614
614
|
* @param {string} [authorization] Bearer Token
|
|
615
615
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
616
616
|
* @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.
|
|
617
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
618
|
-
* @param {string} [search]
|
|
617
|
+
* @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, accountCode, partnerCode</i>
|
|
618
|
+
* @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: accountHolder, bankName</i>
|
|
619
619
|
* @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>
|
|
620
620
|
* @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: primaryBankAccount<i>
|
|
621
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
621
|
+
* @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, accountCode, partnerCode</i>
|
|
622
622
|
* @param {*} [options] Override http request option.
|
|
623
623
|
* @throws {RequiredError}
|
|
624
624
|
*/
|
|
@@ -700,7 +700,7 @@ var BankAccountsApi = /** @class */ (function (_super) {
|
|
|
700
700
|
return (0, exports.BankAccountsApiFp)(this.configuration).getBankAccount(requestParameters.code, requestParameters.authorization, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
701
701
|
};
|
|
702
702
|
/**
|
|
703
|
-
* Returns a list of bank accounts you have previously created.
|
|
703
|
+
* Returns a list of bank accounts you have previously created. The bank accounts are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
704
704
|
* @summary List bank accounts
|
|
705
705
|
* @param {BankAccountsApiListBankAccountsRequest} requestParameters Request parameters.
|
|
706
706
|
* @param {*} [options] Override http request option.
|
|
@@ -24,7 +24,7 @@ import { UpdateBankOrderResponseClass } from '../models';
|
|
|
24
24
|
*/
|
|
25
25
|
export declare const BankOrdersApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
26
26
|
/**
|
|
27
|
-
* This will create a bank order. **Required Permissions** \"payment-management.bank-orders.create\", \"
|
|
27
|
+
* This will create a bank order. **Required Permissions** \"payment-management.bank-orders.create\", \"payment-management.bank-accounts.view\", \"billing-management.invoices.view\"
|
|
28
28
|
* @summary Create the bank order
|
|
29
29
|
* @param {CreateBankOrderRequestDto} createBankOrderRequestDto
|
|
30
30
|
* @param {string} [authorization] Bearer Token
|
|
@@ -52,16 +52,16 @@ export declare const BankOrdersApiAxiosParamCreator: (configuration?: Configurat
|
|
|
52
52
|
*/
|
|
53
53
|
getBankOrder: (code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
54
54
|
/**
|
|
55
|
-
* Returns a list of bank orders you have previously created.
|
|
55
|
+
* Returns a list of bank orders you have previously created. The bank orders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.bank-orders.view\"
|
|
56
56
|
* @summary List bank orders
|
|
57
57
|
* @param {string} [authorization] Bearer Token
|
|
58
58
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
59
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.
|
|
60
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
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, orderNumber, status, type, tenantBankAccountCode</i>
|
|
61
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: code, description, orderNumber, tenantBankAccountCode</i>
|
|
62
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, executionDate, dueDate, orderNumber, tenantBankAccountCode, amount, createdAt, updatedAt</i>
|
|
63
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: tenantBankAccount, xmlFile<i>
|
|
64
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
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, orderNumber, status, type, tenantBankAccountCode</i>
|
|
65
65
|
* @param {*} [options] Override http request option.
|
|
66
66
|
* @throws {RequiredError}
|
|
67
67
|
*/
|
|
@@ -83,7 +83,7 @@ export declare const BankOrdersApiAxiosParamCreator: (configuration?: Configurat
|
|
|
83
83
|
*/
|
|
84
84
|
export declare const BankOrdersApiFp: (configuration?: Configuration) => {
|
|
85
85
|
/**
|
|
86
|
-
* This will create a bank order. **Required Permissions** \"payment-management.bank-orders.create\", \"
|
|
86
|
+
* This will create a bank order. **Required Permissions** \"payment-management.bank-orders.create\", \"payment-management.bank-accounts.view\", \"billing-management.invoices.view\"
|
|
87
87
|
* @summary Create the bank order
|
|
88
88
|
* @param {CreateBankOrderRequestDto} createBankOrderRequestDto
|
|
89
89
|
* @param {string} [authorization] Bearer Token
|
|
@@ -111,16 +111,16 @@ export declare const BankOrdersApiFp: (configuration?: Configuration) => {
|
|
|
111
111
|
*/
|
|
112
112
|
getBankOrder(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetBankOrderResponseClass>>;
|
|
113
113
|
/**
|
|
114
|
-
* Returns a list of bank orders you have previously created.
|
|
114
|
+
* Returns a list of bank orders you have previously created. The bank orders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.bank-orders.view\"
|
|
115
115
|
* @summary List bank orders
|
|
116
116
|
* @param {string} [authorization] Bearer Token
|
|
117
117
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
118
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.
|
|
119
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
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, orderNumber, status, type, tenantBankAccountCode</i>
|
|
120
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: code, description, orderNumber, tenantBankAccountCode</i>
|
|
121
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, executionDate, dueDate, orderNumber, tenantBankAccountCode, amount, createdAt, updatedAt</i>
|
|
122
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: tenantBankAccount, xmlFile<i>
|
|
123
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
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, orderNumber, status, type, tenantBankAccountCode</i>
|
|
124
124
|
* @param {*} [options] Override http request option.
|
|
125
125
|
* @throws {RequiredError}
|
|
126
126
|
*/
|
|
@@ -142,7 +142,7 @@ export declare const BankOrdersApiFp: (configuration?: Configuration) => {
|
|
|
142
142
|
*/
|
|
143
143
|
export declare const BankOrdersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
144
144
|
/**
|
|
145
|
-
* This will create a bank order. **Required Permissions** \"payment-management.bank-orders.create\", \"
|
|
145
|
+
* This will create a bank order. **Required Permissions** \"payment-management.bank-orders.create\", \"payment-management.bank-accounts.view\", \"billing-management.invoices.view\"
|
|
146
146
|
* @summary Create the bank order
|
|
147
147
|
* @param {CreateBankOrderRequestDto} createBankOrderRequestDto
|
|
148
148
|
* @param {string} [authorization] Bearer Token
|
|
@@ -170,16 +170,16 @@ export declare const BankOrdersApiFactory: (configuration?: Configuration, baseP
|
|
|
170
170
|
*/
|
|
171
171
|
getBankOrder(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetBankOrderResponseClass>;
|
|
172
172
|
/**
|
|
173
|
-
* Returns a list of bank orders you have previously created.
|
|
173
|
+
* Returns a list of bank orders you have previously created. The bank orders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.bank-orders.view\"
|
|
174
174
|
* @summary List bank orders
|
|
175
175
|
* @param {string} [authorization] Bearer Token
|
|
176
176
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
177
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.
|
|
178
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
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, orderNumber, status, type, tenantBankAccountCode</i>
|
|
179
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: code, description, orderNumber, tenantBankAccountCode</i>
|
|
180
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, executionDate, dueDate, orderNumber, tenantBankAccountCode, amount, createdAt, updatedAt</i>
|
|
181
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: tenantBankAccount, xmlFile<i>
|
|
182
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
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, orderNumber, status, type, tenantBankAccountCode</i>
|
|
183
183
|
* @param {*} [options] Override http request option.
|
|
184
184
|
* @throws {RequiredError}
|
|
185
185
|
*/
|
|
@@ -283,7 +283,7 @@ export interface BankOrdersApiListBankOrdersRequest {
|
|
|
283
283
|
*/
|
|
284
284
|
readonly pageToken?: string;
|
|
285
285
|
/**
|
|
286
|
-
* Filter the response by one or multiple fields.
|
|
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, orderNumber, status, type, tenantBankAccountCode</i>
|
|
287
287
|
* @type {string}
|
|
288
288
|
* @memberof BankOrdersApiListBankOrders
|
|
289
289
|
*/
|
|
@@ -307,7 +307,7 @@ export interface BankOrdersApiListBankOrdersRequest {
|
|
|
307
307
|
*/
|
|
308
308
|
readonly expand?: string;
|
|
309
309
|
/**
|
|
310
|
-
* Filters the response by one or multiple fields.
|
|
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, orderNumber, status, type, tenantBankAccountCode</i>
|
|
311
311
|
* @type {string}
|
|
312
312
|
* @memberof BankOrdersApiListBankOrders
|
|
313
313
|
*/
|
|
@@ -346,7 +346,7 @@ export interface BankOrdersApiUpdateBankOrderRequest {
|
|
|
346
346
|
*/
|
|
347
347
|
export declare class BankOrdersApi extends BaseAPI {
|
|
348
348
|
/**
|
|
349
|
-
* This will create a bank order. **Required Permissions** \"payment-management.bank-orders.create\", \"
|
|
349
|
+
* This will create a bank order. **Required Permissions** \"payment-management.bank-orders.create\", \"payment-management.bank-accounts.view\", \"billing-management.invoices.view\"
|
|
350
350
|
* @summary Create the bank order
|
|
351
351
|
* @param {BankOrdersApiCreateBankOrderRequest} requestParameters Request parameters.
|
|
352
352
|
* @param {*} [options] Override http request option.
|
|
@@ -373,7 +373,7 @@ export declare class BankOrdersApi extends BaseAPI {
|
|
|
373
373
|
*/
|
|
374
374
|
getBankOrder(requestParameters: BankOrdersApiGetBankOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetBankOrderResponseClass, any, {}>>;
|
|
375
375
|
/**
|
|
376
|
-
* Returns a list of bank orders you have previously created.
|
|
376
|
+
* Returns a list of bank orders you have previously created. The bank orders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.bank-orders.view\"
|
|
377
377
|
* @summary List bank orders
|
|
378
378
|
* @param {BankOrdersApiListBankOrdersRequest} requestParameters Request parameters.
|
|
379
379
|
* @param {*} [options] Override http request option.
|