@emilgroup/payment-sdk-node 1.23.1-beta.10 → 1.23.1-beta.101
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 +169 -0
- package/api/payment-methods-api.ts +12 -12
- package/api/payment-receipts-api.ts +680 -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 +228 -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 +641 -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/bank-transaction-entity.d.ts +4 -2
- package/dist/models/create-payment-order-dto.d.ts +4 -2
- package/dist/models/create-payment-order-request-dto.d.ts +4 -2
- 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-dto.d.ts +4 -2
- package/dist/models/create-payment-request-request-dto.d.ts +54 -11
- package/dist/models/create-payment-request-request-dto.js +8 -4
- 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/invoice-match-suggestion-entity.d.ts +4 -2
- 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 +5 -3
- 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 +68 -12
- package/dist/models/payment-request-class.js +9 -5
- 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/dist/models/validate-pspconfig-request-dto.d.ts +4 -2
- 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/bank-transaction-entity.ts +2 -2
- package/models/create-payment-order-dto.ts +2 -2
- package/models/create-payment-order-request-dto.ts +2 -2
- 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-dto.ts +2 -2
- package/models/create-payment-request-request-dto.ts +53 -11
- 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/invoice-match-suggestion-entity.ts +2 -2
- 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 +3 -3
- package/models/payment-receipt-class.ts +110 -0
- package/models/payment-request-class.ts +67 -12
- 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/models/validate-pspconfig-request-dto.ts +2 -2
- package/package.json +2 -2
|
@@ -97,7 +97,7 @@ var BankOrdersApiAxiosParamCreator = function (configuration) {
|
|
|
97
97
|
var _this = this;
|
|
98
98
|
return {
|
|
99
99
|
/**
|
|
100
|
-
* This will create a bank order. **Required Permissions** \"payment-management.bank-orders.create\", \"
|
|
100
|
+
* This will create a bank order. **Required Permissions** \"payment-management.bank-orders.create\", \"payment-management.bank-accounts.view\", \"billing-management.invoices.view\"
|
|
101
101
|
* @summary Create the bank order
|
|
102
102
|
* @param {CreateBankOrderRequestDto} createBankOrderRequestDto
|
|
103
103
|
* @param {string} [authorization] Bearer Token
|
|
@@ -246,16 +246,16 @@ var BankOrdersApiAxiosParamCreator = function (configuration) {
|
|
|
246
246
|
});
|
|
247
247
|
},
|
|
248
248
|
/**
|
|
249
|
-
* Returns a list of bank orders you have previously created.
|
|
249
|
+
* 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\"
|
|
250
250
|
* @summary List bank orders
|
|
251
251
|
* @param {string} [authorization] Bearer Token
|
|
252
252
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
253
253
|
* @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.
|
|
254
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
254
|
+
* @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>
|
|
255
255
|
* @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>
|
|
256
256
|
* @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>
|
|
257
257
|
* @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>
|
|
258
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
258
|
+
* @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>
|
|
259
259
|
* @param {*} [options] Override http request option.
|
|
260
260
|
* @throws {RequiredError}
|
|
261
261
|
*/
|
|
@@ -381,7 +381,7 @@ var BankOrdersApiFp = function (configuration) {
|
|
|
381
381
|
var localVarAxiosParamCreator = (0, exports.BankOrdersApiAxiosParamCreator)(configuration);
|
|
382
382
|
return {
|
|
383
383
|
/**
|
|
384
|
-
* This will create a bank order. **Required Permissions** \"payment-management.bank-orders.create\", \"
|
|
384
|
+
* This will create a bank order. **Required Permissions** \"payment-management.bank-orders.create\", \"payment-management.bank-accounts.view\", \"billing-management.invoices.view\"
|
|
385
385
|
* @summary Create the bank order
|
|
386
386
|
* @param {CreateBankOrderRequestDto} createBankOrderRequestDto
|
|
387
387
|
* @param {string} [authorization] Bearer Token
|
|
@@ -445,16 +445,16 @@ var BankOrdersApiFp = function (configuration) {
|
|
|
445
445
|
});
|
|
446
446
|
},
|
|
447
447
|
/**
|
|
448
|
-
* Returns a list of bank orders you have previously created.
|
|
448
|
+
* 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\"
|
|
449
449
|
* @summary List bank orders
|
|
450
450
|
* @param {string} [authorization] Bearer Token
|
|
451
451
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
452
452
|
* @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.
|
|
453
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
453
|
+
* @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>
|
|
454
454
|
* @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>
|
|
455
455
|
* @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>
|
|
456
456
|
* @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>
|
|
457
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
457
|
+
* @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>
|
|
458
458
|
* @param {*} [options] Override http request option.
|
|
459
459
|
* @throws {RequiredError}
|
|
460
460
|
*/
|
|
@@ -504,7 +504,7 @@ var BankOrdersApiFactory = function (configuration, basePath, axios) {
|
|
|
504
504
|
var localVarFp = (0, exports.BankOrdersApiFp)(configuration);
|
|
505
505
|
return {
|
|
506
506
|
/**
|
|
507
|
-
* This will create a bank order. **Required Permissions** \"payment-management.bank-orders.create\", \"
|
|
507
|
+
* This will create a bank order. **Required Permissions** \"payment-management.bank-orders.create\", \"payment-management.bank-accounts.view\", \"billing-management.invoices.view\"
|
|
508
508
|
* @summary Create the bank order
|
|
509
509
|
* @param {CreateBankOrderRequestDto} createBankOrderRequestDto
|
|
510
510
|
* @param {string} [authorization] Bearer Token
|
|
@@ -538,16 +538,16 @@ var BankOrdersApiFactory = function (configuration, basePath, axios) {
|
|
|
538
538
|
return localVarFp.getBankOrder(code, authorization, expand, options).then(function (request) { return request(axios, basePath); });
|
|
539
539
|
},
|
|
540
540
|
/**
|
|
541
|
-
* Returns a list of bank orders you have previously created.
|
|
541
|
+
* 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\"
|
|
542
542
|
* @summary List bank orders
|
|
543
543
|
* @param {string} [authorization] Bearer Token
|
|
544
544
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
545
545
|
* @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.
|
|
546
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
546
|
+
* @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>
|
|
547
547
|
* @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>
|
|
548
548
|
* @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>
|
|
549
549
|
* @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>
|
|
550
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
550
|
+
* @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>
|
|
551
551
|
* @param {*} [options] Override http request option.
|
|
552
552
|
* @throws {RequiredError}
|
|
553
553
|
*/
|
|
@@ -581,7 +581,7 @@ var BankOrdersApi = /** @class */ (function (_super) {
|
|
|
581
581
|
return _super !== null && _super.apply(this, arguments) || this;
|
|
582
582
|
}
|
|
583
583
|
/**
|
|
584
|
-
* This will create a bank order. **Required Permissions** \"payment-management.bank-orders.create\", \"
|
|
584
|
+
* This will create a bank order. **Required Permissions** \"payment-management.bank-orders.create\", \"payment-management.bank-accounts.view\", \"billing-management.invoices.view\"
|
|
585
585
|
* @summary Create the bank order
|
|
586
586
|
* @param {BankOrdersApiCreateBankOrderRequest} requestParameters Request parameters.
|
|
587
587
|
* @param {*} [options] Override http request option.
|
|
@@ -617,7 +617,7 @@ var BankOrdersApi = /** @class */ (function (_super) {
|
|
|
617
617
|
return (0, exports.BankOrdersApiFp)(this.configuration).getBankOrder(requestParameters.code, requestParameters.authorization, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
618
618
|
};
|
|
619
619
|
/**
|
|
620
|
-
* Returns a list of bank orders you have previously created.
|
|
620
|
+
* 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\"
|
|
621
621
|
* @summary List bank orders
|
|
622
622
|
* @param {BankOrdersApiListBankOrdersRequest} requestParameters Request parameters.
|
|
623
623
|
* @param {*} [options] Override http request option.
|
|
@@ -63,16 +63,16 @@ export declare const BankTransactionApiAxiosParamCreator: (configuration?: Confi
|
|
|
63
63
|
*/
|
|
64
64
|
linkBankTransaction: (code: string, linkBankTransactionRequestDtoRest: LinkBankTransactionRequestDtoRest, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
65
65
|
/**
|
|
66
|
-
* Returns a list of bank transactions you have previously created.
|
|
66
|
+
* Returns a list of bank transactions you have previously created. The bank transactions 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\"
|
|
67
67
|
* @summary List bank transactions
|
|
68
68
|
* @param {string} [authorization] Bearer Token
|
|
69
69
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
70
70
|
* @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.
|
|
71
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
71
|
+
* @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, bankAccountId, bankAccountNumber, messageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked</i>
|
|
72
72
|
* @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, amount</i>
|
|
73
73
|
* @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, transactionDate, entryDate</i>
|
|
74
74
|
* @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: bankAccount, invoiceMatchSuggestions, suggestionGenerationProgress, linkedBankOrder, bankTransactionInvoices<i>
|
|
75
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
75
|
+
* @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, bankAccountId, bankAccountNumber, messageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked</i>
|
|
76
76
|
* @param {*} [options] Override http request option.
|
|
77
77
|
* @throws {RequiredError}
|
|
78
78
|
*/
|
|
@@ -131,16 +131,16 @@ export declare const BankTransactionApiFp: (configuration?: Configuration) => {
|
|
|
131
131
|
*/
|
|
132
132
|
linkBankTransaction(code: string, linkBankTransactionRequestDtoRest: LinkBankTransactionRequestDtoRest, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LinkBankTransactionsResponseClass>>;
|
|
133
133
|
/**
|
|
134
|
-
* Returns a list of bank transactions you have previously created.
|
|
134
|
+
* Returns a list of bank transactions you have previously created. The bank transactions 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\"
|
|
135
135
|
* @summary List bank transactions
|
|
136
136
|
* @param {string} [authorization] Bearer Token
|
|
137
137
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
138
138
|
* @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.
|
|
139
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
139
|
+
* @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, bankAccountId, bankAccountNumber, messageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked</i>
|
|
140
140
|
* @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, amount</i>
|
|
141
141
|
* @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, transactionDate, entryDate</i>
|
|
142
142
|
* @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: bankAccount, invoiceMatchSuggestions, suggestionGenerationProgress, linkedBankOrder, bankTransactionInvoices<i>
|
|
143
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
143
|
+
* @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, bankAccountId, bankAccountNumber, messageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked</i>
|
|
144
144
|
* @param {*} [options] Override http request option.
|
|
145
145
|
* @throws {RequiredError}
|
|
146
146
|
*/
|
|
@@ -199,16 +199,16 @@ export declare const BankTransactionApiFactory: (configuration?: Configuration,
|
|
|
199
199
|
*/
|
|
200
200
|
linkBankTransaction(code: string, linkBankTransactionRequestDtoRest: LinkBankTransactionRequestDtoRest, authorization?: string, options?: any): AxiosPromise<LinkBankTransactionsResponseClass>;
|
|
201
201
|
/**
|
|
202
|
-
* Returns a list of bank transactions you have previously created.
|
|
202
|
+
* Returns a list of bank transactions you have previously created. The bank transactions 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\"
|
|
203
203
|
* @summary List bank transactions
|
|
204
204
|
* @param {string} [authorization] Bearer Token
|
|
205
205
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
206
206
|
* @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.
|
|
207
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
207
|
+
* @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, bankAccountId, bankAccountNumber, messageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked</i>
|
|
208
208
|
* @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, amount</i>
|
|
209
209
|
* @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, transactionDate, entryDate</i>
|
|
210
210
|
* @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: bankAccount, invoiceMatchSuggestions, suggestionGenerationProgress, linkedBankOrder, bankTransactionInvoices<i>
|
|
211
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
211
|
+
* @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, bankAccountId, bankAccountNumber, messageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked</i>
|
|
212
212
|
* @param {*} [options] Override http request option.
|
|
213
213
|
* @throws {RequiredError}
|
|
214
214
|
*/
|
|
@@ -336,7 +336,7 @@ export interface BankTransactionApiListBankTransactionsRequest {
|
|
|
336
336
|
*/
|
|
337
337
|
readonly pageToken?: string;
|
|
338
338
|
/**
|
|
339
|
-
* Filter the response by one or multiple fields.
|
|
339
|
+
* 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, bankAccountId, bankAccountNumber, messageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked</i>
|
|
340
340
|
* @type {string}
|
|
341
341
|
* @memberof BankTransactionApiListBankTransactions
|
|
342
342
|
*/
|
|
@@ -360,7 +360,7 @@ export interface BankTransactionApiListBankTransactionsRequest {
|
|
|
360
360
|
*/
|
|
361
361
|
readonly expand?: string;
|
|
362
362
|
/**
|
|
363
|
-
* Filters the response by one or multiple fields.
|
|
363
|
+
* 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, bankAccountId, bankAccountNumber, messageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked</i>
|
|
364
364
|
* @type {string}
|
|
365
365
|
* @memberof BankTransactionApiListBankTransactions
|
|
366
366
|
*/
|
|
@@ -429,7 +429,7 @@ export declare class BankTransactionApi extends BaseAPI {
|
|
|
429
429
|
*/
|
|
430
430
|
linkBankTransaction(requestParameters: BankTransactionApiLinkBankTransactionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<LinkBankTransactionsResponseClass, any, {}>>;
|
|
431
431
|
/**
|
|
432
|
-
* Returns a list of bank transactions you have previously created.
|
|
432
|
+
* Returns a list of bank transactions you have previously created. The bank transactions 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 transactions
|
|
434
434
|
* @param {BankTransactionApiListBankTransactionsRequest} requestParameters Request parameters.
|
|
435
435
|
* @param {*} [options] Override http request option.
|
|
@@ -303,16 +303,16 @@ var BankTransactionApiAxiosParamCreator = function (configuration) {
|
|
|
303
303
|
});
|
|
304
304
|
},
|
|
305
305
|
/**
|
|
306
|
-
* Returns a list of bank transactions you have previously created.
|
|
306
|
+
* Returns a list of bank transactions you have previously created. The bank transactions 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\"
|
|
307
307
|
* @summary List bank transactions
|
|
308
308
|
* @param {string} [authorization] Bearer Token
|
|
309
309
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
310
310
|
* @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.
|
|
311
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
311
|
+
* @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, bankAccountId, bankAccountNumber, messageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked</i>
|
|
312
312
|
* @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, amount</i>
|
|
313
313
|
* @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, transactionDate, entryDate</i>
|
|
314
314
|
* @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: bankAccount, invoiceMatchSuggestions, suggestionGenerationProgress, linkedBankOrder, bankTransactionInvoices<i>
|
|
315
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
315
|
+
* @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, bankAccountId, bankAccountNumber, messageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked</i>
|
|
316
316
|
* @param {*} [options] Override http request option.
|
|
317
317
|
* @throws {RequiredError}
|
|
318
318
|
*/
|
|
@@ -519,16 +519,16 @@ var BankTransactionApiFp = function (configuration) {
|
|
|
519
519
|
});
|
|
520
520
|
},
|
|
521
521
|
/**
|
|
522
|
-
* Returns a list of bank transactions you have previously created.
|
|
522
|
+
* Returns a list of bank transactions you have previously created. The bank transactions 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\"
|
|
523
523
|
* @summary List bank transactions
|
|
524
524
|
* @param {string} [authorization] Bearer Token
|
|
525
525
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
526
526
|
* @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.
|
|
527
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
527
|
+
* @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, bankAccountId, bankAccountNumber, messageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked</i>
|
|
528
528
|
* @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, amount</i>
|
|
529
529
|
* @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, transactionDate, entryDate</i>
|
|
530
530
|
* @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: bankAccount, invoiceMatchSuggestions, suggestionGenerationProgress, linkedBankOrder, bankTransactionInvoices<i>
|
|
531
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
531
|
+
* @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, bankAccountId, bankAccountNumber, messageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked</i>
|
|
532
532
|
* @param {*} [options] Override http request option.
|
|
533
533
|
* @throws {RequiredError}
|
|
534
534
|
*/
|
|
@@ -623,16 +623,16 @@ var BankTransactionApiFactory = function (configuration, basePath, axios) {
|
|
|
623
623
|
return localVarFp.linkBankTransaction(code, linkBankTransactionRequestDtoRest, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
624
624
|
},
|
|
625
625
|
/**
|
|
626
|
-
* Returns a list of bank transactions you have previously created.
|
|
626
|
+
* Returns a list of bank transactions you have previously created. The bank transactions 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\"
|
|
627
627
|
* @summary List bank transactions
|
|
628
628
|
* @param {string} [authorization] Bearer Token
|
|
629
629
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
630
630
|
* @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.
|
|
631
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
631
|
+
* @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, bankAccountId, bankAccountNumber, messageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked</i>
|
|
632
632
|
* @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, amount</i>
|
|
633
633
|
* @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, transactionDate, entryDate</i>
|
|
634
634
|
* @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: bankAccount, invoiceMatchSuggestions, suggestionGenerationProgress, linkedBankOrder, bankTransactionInvoices<i>
|
|
635
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
635
|
+
* @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, bankAccountId, bankAccountNumber, messageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked</i>
|
|
636
636
|
* @param {*} [options] Override http request option.
|
|
637
637
|
* @throws {RequiredError}
|
|
638
638
|
*/
|
|
@@ -713,7 +713,7 @@ var BankTransactionApi = /** @class */ (function (_super) {
|
|
|
713
713
|
return (0, exports.BankTransactionApiFp)(this.configuration).linkBankTransaction(requestParameters.code, requestParameters.linkBankTransactionRequestDtoRest, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
714
714
|
};
|
|
715
715
|
/**
|
|
716
|
-
* Returns a list of bank transactions you have previously created.
|
|
716
|
+
* Returns a list of bank transactions you have previously created. The bank transactions 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\"
|
|
717
717
|
* @summary List bank transactions
|
|
718
718
|
* @param {BankTransactionApiListBankTransactionsRequest} requestParameters Request parameters.
|
|
719
719
|
* @param {*} [options] Override http request option.
|
|
@@ -51,16 +51,16 @@ export declare const BillingAddressesApiAxiosParamCreator: (configuration?: Conf
|
|
|
51
51
|
*/
|
|
52
52
|
getBillingAddress: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
53
53
|
/**
|
|
54
|
-
* Returns a list of Billing Addresses you have previously created.
|
|
54
|
+
* Returns a list of Billing Addresses you have previously created. The Billing Addresses 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\"
|
|
55
55
|
* @summary List Billing Addresses
|
|
56
56
|
* @param {string} [authorization] Bearer Token
|
|
57
57
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
58
58
|
* @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.
|
|
59
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
59
|
+
* @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, city, zipCode, countryCode, accountCode, partnerCode</i>
|
|
60
60
|
* @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: firstName, lastName, accountCode, partnerCode</i>
|
|
61
61
|
* @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, code, createdAt, updatedAt</i>
|
|
62
62
|
* @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/>
|
|
63
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
63
|
+
* @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, city, zipCode, countryCode, accountCode, partnerCode</i>
|
|
64
64
|
* @param {*} [options] Override http request option.
|
|
65
65
|
* @throws {RequiredError}
|
|
66
66
|
*/
|
|
@@ -109,16 +109,16 @@ export declare const BillingAddressesApiFp: (configuration?: Configuration) => {
|
|
|
109
109
|
*/
|
|
110
110
|
getBillingAddress(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetBillingAddressResponseClass>>;
|
|
111
111
|
/**
|
|
112
|
-
* Returns a list of Billing Addresses you have previously created.
|
|
112
|
+
* Returns a list of Billing Addresses you have previously created. The Billing Addresses 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\"
|
|
113
113
|
* @summary List Billing Addresses
|
|
114
114
|
* @param {string} [authorization] Bearer Token
|
|
115
115
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
116
116
|
* @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.
|
|
117
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
117
|
+
* @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, city, zipCode, countryCode, accountCode, partnerCode</i>
|
|
118
118
|
* @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: firstName, lastName, accountCode, partnerCode</i>
|
|
119
119
|
* @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, code, createdAt, updatedAt</i>
|
|
120
120
|
* @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/>
|
|
121
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
121
|
+
* @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, city, zipCode, countryCode, accountCode, partnerCode</i>
|
|
122
122
|
* @param {*} [options] Override http request option.
|
|
123
123
|
* @throws {RequiredError}
|
|
124
124
|
*/
|
|
@@ -167,16 +167,16 @@ export declare const BillingAddressesApiFactory: (configuration?: Configuration,
|
|
|
167
167
|
*/
|
|
168
168
|
getBillingAddress(code: string, authorization?: string, options?: any): AxiosPromise<GetBillingAddressResponseClass>;
|
|
169
169
|
/**
|
|
170
|
-
* Returns a list of Billing Addresses you have previously created.
|
|
170
|
+
* Returns a list of Billing Addresses you have previously created. The Billing Addresses 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\"
|
|
171
171
|
* @summary List Billing Addresses
|
|
172
172
|
* @param {string} [authorization] Bearer Token
|
|
173
173
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
174
174
|
* @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.
|
|
175
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
175
|
+
* @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, city, zipCode, countryCode, accountCode, partnerCode</i>
|
|
176
176
|
* @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: firstName, lastName, accountCode, partnerCode</i>
|
|
177
177
|
* @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, code, createdAt, updatedAt</i>
|
|
178
178
|
* @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/>
|
|
179
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
179
|
+
* @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, city, zipCode, countryCode, accountCode, partnerCode</i>
|
|
180
180
|
* @param {*} [options] Override http request option.
|
|
181
181
|
* @throws {RequiredError}
|
|
182
182
|
*/
|
|
@@ -274,7 +274,7 @@ export interface BillingAddressesApiListBillingAddressesRequest {
|
|
|
274
274
|
*/
|
|
275
275
|
readonly pageToken?: string;
|
|
276
276
|
/**
|
|
277
|
-
* Filter the response by one or multiple fields.
|
|
277
|
+
* 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, city, zipCode, countryCode, accountCode, partnerCode</i>
|
|
278
278
|
* @type {string}
|
|
279
279
|
* @memberof BillingAddressesApiListBillingAddresses
|
|
280
280
|
*/
|
|
@@ -298,7 +298,7 @@ export interface BillingAddressesApiListBillingAddressesRequest {
|
|
|
298
298
|
*/
|
|
299
299
|
readonly expand?: string;
|
|
300
300
|
/**
|
|
301
|
-
* Filters the response by one or multiple fields.
|
|
301
|
+
* 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, city, zipCode, countryCode, accountCode, partnerCode</i>
|
|
302
302
|
* @type {string}
|
|
303
303
|
* @memberof BillingAddressesApiListBillingAddresses
|
|
304
304
|
*/
|
|
@@ -364,7 +364,7 @@ export declare class BillingAddressesApi extends BaseAPI {
|
|
|
364
364
|
*/
|
|
365
365
|
getBillingAddress(requestParameters: BillingAddressesApiGetBillingAddressRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetBillingAddressResponseClass, any, {}>>;
|
|
366
366
|
/**
|
|
367
|
-
* Returns a list of Billing Addresses you have previously created.
|
|
367
|
+
* Returns a list of Billing Addresses you have previously created. The Billing Addresses 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\"
|
|
368
368
|
* @summary List Billing Addresses
|
|
369
369
|
* @param {BillingAddressesApiListBillingAddressesRequest} requestParameters Request parameters.
|
|
370
370
|
* @param {*} [options] Override http request option.
|
|
@@ -242,16 +242,16 @@ var BillingAddressesApiAxiosParamCreator = function (configuration) {
|
|
|
242
242
|
});
|
|
243
243
|
},
|
|
244
244
|
/**
|
|
245
|
-
* Returns a list of Billing Addresses you have previously created.
|
|
245
|
+
* Returns a list of Billing Addresses you have previously created. The Billing Addresses 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\"
|
|
246
246
|
* @summary List Billing Addresses
|
|
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.
|
|
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: id, code, city, zipCode, countryCode, accountCode, partnerCode</i>
|
|
251
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: firstName, lastName, accountCode, partnerCode</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, code, createdAt, updatedAt</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/>
|
|
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: id, code, city, zipCode, countryCode, accountCode, partnerCode</i>
|
|
255
255
|
* @param {*} [options] Override http request option.
|
|
256
256
|
* @throws {RequiredError}
|
|
257
257
|
*/
|
|
@@ -440,16 +440,16 @@ var BillingAddressesApiFp = function (configuration) {
|
|
|
440
440
|
});
|
|
441
441
|
},
|
|
442
442
|
/**
|
|
443
|
-
* Returns a list of Billing Addresses you have previously created.
|
|
443
|
+
* Returns a list of Billing Addresses you have previously created. The Billing Addresses 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\"
|
|
444
444
|
* @summary List Billing Addresses
|
|
445
445
|
* @param {string} [authorization] Bearer Token
|
|
446
446
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
447
447
|
* @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.
|
|
448
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
448
|
+
* @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, city, zipCode, countryCode, accountCode, partnerCode</i>
|
|
449
449
|
* @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: firstName, lastName, accountCode, partnerCode</i>
|
|
450
450
|
* @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, code, createdAt, updatedAt</i>
|
|
451
451
|
* @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/>
|
|
452
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
452
|
+
* @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, city, zipCode, countryCode, accountCode, partnerCode</i>
|
|
453
453
|
* @param {*} [options] Override http request option.
|
|
454
454
|
* @throws {RequiredError}
|
|
455
455
|
*/
|
|
@@ -532,16 +532,16 @@ var BillingAddressesApiFactory = function (configuration, basePath, axios) {
|
|
|
532
532
|
return localVarFp.getBillingAddress(code, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
533
533
|
},
|
|
534
534
|
/**
|
|
535
|
-
* Returns a list of Billing Addresses you have previously created.
|
|
535
|
+
* Returns a list of Billing Addresses you have previously created. The Billing Addresses 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\"
|
|
536
536
|
* @summary List Billing Addresses
|
|
537
537
|
* @param {string} [authorization] Bearer Token
|
|
538
538
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
539
539
|
* @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.
|
|
540
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
540
|
+
* @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, city, zipCode, countryCode, accountCode, partnerCode</i>
|
|
541
541
|
* @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: firstName, lastName, accountCode, partnerCode</i>
|
|
542
542
|
* @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, code, createdAt, updatedAt</i>
|
|
543
543
|
* @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/>
|
|
544
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
544
|
+
* @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, city, zipCode, countryCode, accountCode, partnerCode</i>
|
|
545
545
|
* @param {*} [options] Override http request option.
|
|
546
546
|
* @throws {RequiredError}
|
|
547
547
|
*/
|
|
@@ -611,7 +611,7 @@ var BillingAddressesApi = /** @class */ (function (_super) {
|
|
|
611
611
|
return (0, exports.BillingAddressesApiFp)(this.configuration).getBillingAddress(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
612
612
|
};
|
|
613
613
|
/**
|
|
614
|
-
* Returns a list of Billing Addresses you have previously created.
|
|
614
|
+
* Returns a list of Billing Addresses you have previously created. The Billing Addresses 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\"
|
|
615
615
|
* @summary List Billing Addresses
|
|
616
616
|
* @param {BillingAddressesApiListBillingAddressesRequest} requestParameters Request parameters.
|
|
617
617
|
* @param {*} [options] Override http request option.
|