@emilgroup/payment-sdk-node 1.21.1-beta.47 → 1.21.1-beta.49
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 +7 -0
- package/README.md +2 -2
- package/api/bank-orders-api.ts +695 -0
- package/api/bank-transaction-api.ts +8 -8
- package/api.ts +2 -0
- package/dist/api/bank-orders-api.d.ts +393 -0
- package/dist/api/bank-orders-api.js +646 -0
- package/dist/api/bank-transaction-api.d.ts +8 -8
- package/dist/api/bank-transaction-api.js +6 -6
- package/dist/api.d.ts +1 -0
- package/dist/api.js +1 -0
- package/dist/models/bank-order-class.d.ts +115 -0
- package/dist/models/bank-order-class.js +15 -0
- package/dist/models/bank-transaction-class-without-expand-properties.d.ts +18 -0
- package/dist/models/bank-transaction-class-without-expand-properties.js +5 -0
- package/dist/models/bank-transaction-class.d.ts +18 -0
- package/dist/models/bank-transaction-class.js +5 -0
- package/dist/models/create-bank-order-response-class.d.ts +25 -0
- package/dist/models/create-bank-order-response-class.js +15 -0
- package/dist/models/financial-account-class.d.ts +111 -0
- package/dist/models/financial-account-class.js +24 -0
- package/dist/models/get-bank-order-response-class.d.ts +25 -0
- package/dist/models/get-bank-order-response-class.js +15 -0
- package/dist/models/index.d.ts +6 -0
- package/dist/models/index.js +6 -0
- package/dist/models/list-bank-orders-response-class.d.ts +31 -0
- package/dist/models/list-bank-orders-response-class.js +15 -0
- package/dist/models/unlinked-bank-transaction-response-class.d.ts +18 -0
- package/dist/models/unlinked-bank-transaction-response-class.js +5 -0
- package/dist/models/update-bank-order-response-class.d.ts +25 -0
- package/dist/models/update-bank-order-response-class.js +15 -0
- package/models/bank-order-class.ts +121 -0
- package/models/bank-transaction-class-without-expand-properties.ts +21 -0
- package/models/bank-transaction-class.ts +21 -0
- package/models/create-bank-order-response-class.ts +31 -0
- package/models/financial-account-class.ts +120 -0
- package/models/get-bank-order-response-class.ts +31 -0
- package/models/index.ts +6 -0
- package/models/list-bank-orders-response-class.ts +37 -0
- package/models/unlinked-bank-transaction-response-class.ts +21 -0
- package/models/update-bank-order-response-class.ts +31 -0
- package/package.json +1 -1
|
@@ -96,7 +96,7 @@ export const BankTransactionApiAxiosParamCreator = function (configuration?: Con
|
|
|
96
96
|
* @summary Retrieve the bank transaction
|
|
97
97
|
* @param {string} code
|
|
98
98
|
* @param {string} [authorization] Bearer Token
|
|
99
|
-
* @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, transaction, invoiceMatchSuggestions, suggestionGenerationProgress<i>
|
|
99
|
+
* @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, transaction, invoiceMatchSuggestions, suggestionGenerationProgress, linkedBankOrder<i>
|
|
100
100
|
* @param {*} [options] Override http request option.
|
|
101
101
|
* @throws {RequiredError}
|
|
102
102
|
*/
|
|
@@ -254,7 +254,7 @@ export const BankTransactionApiAxiosParamCreator = function (configuration?: Con
|
|
|
254
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, bankAccountId, bankAccountNumber, messageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked</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: id, createdAt, amount</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, createdAt, transactionDate, entryDate</i>
|
|
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: bankAccount, transaction, invoiceMatchSuggestions, suggestionGenerationProgress<i>
|
|
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: bankAccount, transaction, invoiceMatchSuggestions, suggestionGenerationProgress, linkedBankOrder<i>
|
|
258
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, bankAccountId, bankAccountNumber, messageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked</i>
|
|
259
259
|
* @param {*} [options] Override http request option.
|
|
260
260
|
* @throws {RequiredError}
|
|
@@ -399,7 +399,7 @@ export const BankTransactionApiFp = function(configuration?: Configuration) {
|
|
|
399
399
|
* @summary Retrieve the bank transaction
|
|
400
400
|
* @param {string} code
|
|
401
401
|
* @param {string} [authorization] Bearer Token
|
|
402
|
-
* @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, transaction, invoiceMatchSuggestions, suggestionGenerationProgress<i>
|
|
402
|
+
* @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, transaction, invoiceMatchSuggestions, suggestionGenerationProgress, linkedBankOrder<i>
|
|
403
403
|
* @param {*} [options] Override http request option.
|
|
404
404
|
* @throws {RequiredError}
|
|
405
405
|
*/
|
|
@@ -441,7 +441,7 @@ export const BankTransactionApiFp = function(configuration?: Configuration) {
|
|
|
441
441
|
* @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>
|
|
442
442
|
* @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>
|
|
443
443
|
* @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>
|
|
444
|
-
* @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, transaction, invoiceMatchSuggestions, suggestionGenerationProgress<i>
|
|
444
|
+
* @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, transaction, invoiceMatchSuggestions, suggestionGenerationProgress, linkedBankOrder<i>
|
|
445
445
|
* @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>
|
|
446
446
|
* @param {*} [options] Override http request option.
|
|
447
447
|
* @throws {RequiredError}
|
|
@@ -489,7 +489,7 @@ export const BankTransactionApiFactory = function (configuration?: Configuration
|
|
|
489
489
|
* @summary Retrieve the bank transaction
|
|
490
490
|
* @param {string} code
|
|
491
491
|
* @param {string} [authorization] Bearer Token
|
|
492
|
-
* @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, transaction, invoiceMatchSuggestions, suggestionGenerationProgress<i>
|
|
492
|
+
* @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, transaction, invoiceMatchSuggestions, suggestionGenerationProgress, linkedBankOrder<i>
|
|
493
493
|
* @param {*} [options] Override http request option.
|
|
494
494
|
* @throws {RequiredError}
|
|
495
495
|
*/
|
|
@@ -528,7 +528,7 @@ export const BankTransactionApiFactory = function (configuration?: Configuration
|
|
|
528
528
|
* @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>
|
|
529
529
|
* @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>
|
|
530
530
|
* @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>
|
|
531
|
-
* @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, transaction, invoiceMatchSuggestions, suggestionGenerationProgress<i>
|
|
531
|
+
* @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, transaction, invoiceMatchSuggestions, suggestionGenerationProgress, linkedBankOrder<i>
|
|
532
532
|
* @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>
|
|
533
533
|
* @param {*} [options] Override http request option.
|
|
534
534
|
* @throws {RequiredError}
|
|
@@ -593,7 +593,7 @@ export interface BankTransactionApiGetBankTransactionRequest {
|
|
|
593
593
|
readonly authorization?: string
|
|
594
594
|
|
|
595
595
|
/**
|
|
596
|
-
* 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, transaction, invoiceMatchSuggestions, suggestionGenerationProgress<i>
|
|
596
|
+
* 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, transaction, invoiceMatchSuggestions, suggestionGenerationProgress, linkedBankOrder<i>
|
|
597
597
|
* @type {string}
|
|
598
598
|
* @memberof BankTransactionApiGetBankTransaction
|
|
599
599
|
*/
|
|
@@ -698,7 +698,7 @@ export interface BankTransactionApiListBankTransactionsRequest {
|
|
|
698
698
|
readonly order?: string
|
|
699
699
|
|
|
700
700
|
/**
|
|
701
|
-
* 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, transaction, invoiceMatchSuggestions, suggestionGenerationProgress<i>
|
|
701
|
+
* 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, transaction, invoiceMatchSuggestions, suggestionGenerationProgress, linkedBankOrder<i>
|
|
702
702
|
* @type {string}
|
|
703
703
|
* @memberof BankTransactionApiListBankTransactions
|
|
704
704
|
*/
|
package/api.ts
CHANGED
|
@@ -25,6 +25,7 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj
|
|
|
25
25
|
// @ts-ignore
|
|
26
26
|
import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from './base';
|
|
27
27
|
import { BankAccountsApi } from './api';
|
|
28
|
+
import { BankOrdersApi } from './api';
|
|
28
29
|
import { BankTransactionApi } from './api';
|
|
29
30
|
import { HealthCheckApi } from './api';
|
|
30
31
|
import { PaymentMethodsApi } from './api';
|
|
@@ -37,6 +38,7 @@ import { WebhooksApi } from './api';
|
|
|
37
38
|
|
|
38
39
|
|
|
39
40
|
export * from './api/bank-accounts-api';
|
|
41
|
+
export * from './api/bank-orders-api';
|
|
40
42
|
export * from './api/bank-transaction-api';
|
|
41
43
|
export * from './api/health-check-api';
|
|
42
44
|
export * from './api/payment-methods-api';
|
|
@@ -0,0 +1,393 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Emil Payment Service
|
|
3
|
+
* This service directly communicates with the various Payment Service Providers (PSPs) in order to charge or refund customers. This service will automatically connect to the PSP linked in your admin configuration; meaning if you configured Stripe, it will automatically create a payment on Stripe when you create it in Emil.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0
|
|
6
|
+
* Contact: kontakt@emil.de
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
13
|
+
import { Configuration } from '../configuration';
|
|
14
|
+
import { RequestArgs, BaseAPI } from '../base';
|
|
15
|
+
import { CreateBankOrderRequestDto } from '../models';
|
|
16
|
+
import { CreateBankOrderResponseClass } from '../models';
|
|
17
|
+
import { GetBankOrderResponseClass } from '../models';
|
|
18
|
+
import { ListBankOrdersResponseClass } from '../models';
|
|
19
|
+
import { UpdateBankOrderRequestDto } from '../models';
|
|
20
|
+
import { UpdateBankOrderResponseClass } from '../models';
|
|
21
|
+
/**
|
|
22
|
+
* BankOrdersApi - axios parameter creator
|
|
23
|
+
* @export
|
|
24
|
+
*/
|
|
25
|
+
export declare const BankOrdersApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
26
|
+
/**
|
|
27
|
+
* This will create a bank order. **Required Permissions** \"payment-management.bank-orders.create\", \"accounting-management.financialaccounts.view\", \"billing-management.invoices.view\"
|
|
28
|
+
* @summary Create the bank order
|
|
29
|
+
* @param {CreateBankOrderRequestDto} createBankOrderRequestDto
|
|
30
|
+
* @param {string} [authorization] Bearer Token
|
|
31
|
+
* @param {*} [options] Override http request option.
|
|
32
|
+
* @throws {RequiredError}
|
|
33
|
+
*/
|
|
34
|
+
createBankOrder: (createBankOrderRequestDto: CreateBankOrderRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
35
|
+
/**
|
|
36
|
+
* Deletes a bank order by code. **Required Permissions** \"payment-management.bank-orders.delete\"
|
|
37
|
+
* @summary Delete the bank order
|
|
38
|
+
* @param {string} code Unique identifier for the object.
|
|
39
|
+
* @param {string} [authorization] Bearer Token
|
|
40
|
+
* @param {*} [options] Override http request option.
|
|
41
|
+
* @throws {RequiredError}
|
|
42
|
+
*/
|
|
43
|
+
deleteBankOrder: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
44
|
+
/**
|
|
45
|
+
* Retrieves the details of the bank order that was previously created. Supply the unique bank order code that was returned when you created it and Emil Api will return the corresponding bank order information. **Required Permissions** \"payment-management.bank-orders.view\"
|
|
46
|
+
* @summary Retrieve the bank order
|
|
47
|
+
* @param {string} code
|
|
48
|
+
* @param {string} [authorization] Bearer Token
|
|
49
|
+
* @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: financialAccount<i>
|
|
50
|
+
* @param {*} [options] Override http request option.
|
|
51
|
+
* @throws {RequiredError}
|
|
52
|
+
*/
|
|
53
|
+
getBankOrder: (code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
54
|
+
/**
|
|
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
|
+
* @summary List bank orders
|
|
57
|
+
* @param {string} [authorization] Bearer Token
|
|
58
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
59
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
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, financialAccountCode</i>
|
|
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, financialAccountCode</i>
|
|
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, financialAccountCode, amount, createdAt, updatedAt</i>
|
|
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: financialAccount<i>
|
|
64
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, orderNumber, status, type, financialAccountCode</i>
|
|
65
|
+
* @param {*} [options] Override http request option.
|
|
66
|
+
* @throws {RequiredError}
|
|
67
|
+
*/
|
|
68
|
+
listBankOrders: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
69
|
+
/**
|
|
70
|
+
* Update a bank order by code **Required Permissions** \"payment-management.bank-orders.update\", \"billing-management.invoices.view\"
|
|
71
|
+
* @summary Update the bank order
|
|
72
|
+
* @param {string} code Unique identifier for the object.
|
|
73
|
+
* @param {UpdateBankOrderRequestDto} updateBankOrderRequestDto
|
|
74
|
+
* @param {string} [authorization] Bearer Token
|
|
75
|
+
* @param {*} [options] Override http request option.
|
|
76
|
+
* @throws {RequiredError}
|
|
77
|
+
*/
|
|
78
|
+
updateBankOrder: (code: string, updateBankOrderRequestDto: UpdateBankOrderRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
79
|
+
};
|
|
80
|
+
/**
|
|
81
|
+
* BankOrdersApi - functional programming interface
|
|
82
|
+
* @export
|
|
83
|
+
*/
|
|
84
|
+
export declare const BankOrdersApiFp: (configuration?: Configuration) => {
|
|
85
|
+
/**
|
|
86
|
+
* This will create a bank order. **Required Permissions** \"payment-management.bank-orders.create\", \"accounting-management.financialaccounts.view\", \"billing-management.invoices.view\"
|
|
87
|
+
* @summary Create the bank order
|
|
88
|
+
* @param {CreateBankOrderRequestDto} createBankOrderRequestDto
|
|
89
|
+
* @param {string} [authorization] Bearer Token
|
|
90
|
+
* @param {*} [options] Override http request option.
|
|
91
|
+
* @throws {RequiredError}
|
|
92
|
+
*/
|
|
93
|
+
createBankOrder(createBankOrderRequestDto: CreateBankOrderRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateBankOrderResponseClass>>;
|
|
94
|
+
/**
|
|
95
|
+
* Deletes a bank order by code. **Required Permissions** \"payment-management.bank-orders.delete\"
|
|
96
|
+
* @summary Delete the bank order
|
|
97
|
+
* @param {string} code Unique identifier for the object.
|
|
98
|
+
* @param {string} [authorization] Bearer Token
|
|
99
|
+
* @param {*} [options] Override http request option.
|
|
100
|
+
* @throws {RequiredError}
|
|
101
|
+
*/
|
|
102
|
+
deleteBankOrder(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
103
|
+
/**
|
|
104
|
+
* Retrieves the details of the bank order that was previously created. Supply the unique bank order code that was returned when you created it and Emil Api will return the corresponding bank order information. **Required Permissions** \"payment-management.bank-orders.view\"
|
|
105
|
+
* @summary Retrieve the bank order
|
|
106
|
+
* @param {string} code
|
|
107
|
+
* @param {string} [authorization] Bearer Token
|
|
108
|
+
* @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: financialAccount<i>
|
|
109
|
+
* @param {*} [options] Override http request option.
|
|
110
|
+
* @throws {RequiredError}
|
|
111
|
+
*/
|
|
112
|
+
getBankOrder(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetBankOrderResponseClass>>;
|
|
113
|
+
/**
|
|
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
|
+
* @summary List bank orders
|
|
116
|
+
* @param {string} [authorization] Bearer Token
|
|
117
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
118
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
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, financialAccountCode</i>
|
|
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, financialAccountCode</i>
|
|
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, financialAccountCode, amount, createdAt, updatedAt</i>
|
|
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: financialAccount<i>
|
|
123
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, orderNumber, status, type, financialAccountCode</i>
|
|
124
|
+
* @param {*} [options] Override http request option.
|
|
125
|
+
* @throws {RequiredError}
|
|
126
|
+
*/
|
|
127
|
+
listBankOrders(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListBankOrdersResponseClass>>;
|
|
128
|
+
/**
|
|
129
|
+
* Update a bank order by code **Required Permissions** \"payment-management.bank-orders.update\", \"billing-management.invoices.view\"
|
|
130
|
+
* @summary Update the bank order
|
|
131
|
+
* @param {string} code Unique identifier for the object.
|
|
132
|
+
* @param {UpdateBankOrderRequestDto} updateBankOrderRequestDto
|
|
133
|
+
* @param {string} [authorization] Bearer Token
|
|
134
|
+
* @param {*} [options] Override http request option.
|
|
135
|
+
* @throws {RequiredError}
|
|
136
|
+
*/
|
|
137
|
+
updateBankOrder(code: string, updateBankOrderRequestDto: UpdateBankOrderRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateBankOrderResponseClass>>;
|
|
138
|
+
};
|
|
139
|
+
/**
|
|
140
|
+
* BankOrdersApi - factory interface
|
|
141
|
+
* @export
|
|
142
|
+
*/
|
|
143
|
+
export declare const BankOrdersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
144
|
+
/**
|
|
145
|
+
* This will create a bank order. **Required Permissions** \"payment-management.bank-orders.create\", \"accounting-management.financialaccounts.view\", \"billing-management.invoices.view\"
|
|
146
|
+
* @summary Create the bank order
|
|
147
|
+
* @param {CreateBankOrderRequestDto} createBankOrderRequestDto
|
|
148
|
+
* @param {string} [authorization] Bearer Token
|
|
149
|
+
* @param {*} [options] Override http request option.
|
|
150
|
+
* @throws {RequiredError}
|
|
151
|
+
*/
|
|
152
|
+
createBankOrder(createBankOrderRequestDto: CreateBankOrderRequestDto, authorization?: string, options?: any): AxiosPromise<CreateBankOrderResponseClass>;
|
|
153
|
+
/**
|
|
154
|
+
* Deletes a bank order by code. **Required Permissions** \"payment-management.bank-orders.delete\"
|
|
155
|
+
* @summary Delete the bank order
|
|
156
|
+
* @param {string} code Unique identifier for the object.
|
|
157
|
+
* @param {string} [authorization] Bearer Token
|
|
158
|
+
* @param {*} [options] Override http request option.
|
|
159
|
+
* @throws {RequiredError}
|
|
160
|
+
*/
|
|
161
|
+
deleteBankOrder(code: string, authorization?: string, options?: any): AxiosPromise<object>;
|
|
162
|
+
/**
|
|
163
|
+
* Retrieves the details of the bank order that was previously created. Supply the unique bank order code that was returned when you created it and Emil Api will return the corresponding bank order information. **Required Permissions** \"payment-management.bank-orders.view\"
|
|
164
|
+
* @summary Retrieve the bank order
|
|
165
|
+
* @param {string} code
|
|
166
|
+
* @param {string} [authorization] Bearer Token
|
|
167
|
+
* @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: financialAccount<i>
|
|
168
|
+
* @param {*} [options] Override http request option.
|
|
169
|
+
* @throws {RequiredError}
|
|
170
|
+
*/
|
|
171
|
+
getBankOrder(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetBankOrderResponseClass>;
|
|
172
|
+
/**
|
|
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
|
+
* @summary List bank orders
|
|
175
|
+
* @param {string} [authorization] Bearer Token
|
|
176
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
177
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
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, financialAccountCode</i>
|
|
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, financialAccountCode</i>
|
|
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, financialAccountCode, amount, createdAt, updatedAt</i>
|
|
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: financialAccount<i>
|
|
182
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, orderNumber, status, type, financialAccountCode</i>
|
|
183
|
+
* @param {*} [options] Override http request option.
|
|
184
|
+
* @throws {RequiredError}
|
|
185
|
+
*/
|
|
186
|
+
listBankOrders(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListBankOrdersResponseClass>;
|
|
187
|
+
/**
|
|
188
|
+
* Update a bank order by code **Required Permissions** \"payment-management.bank-orders.update\", \"billing-management.invoices.view\"
|
|
189
|
+
* @summary Update the bank order
|
|
190
|
+
* @param {string} code Unique identifier for the object.
|
|
191
|
+
* @param {UpdateBankOrderRequestDto} updateBankOrderRequestDto
|
|
192
|
+
* @param {string} [authorization] Bearer Token
|
|
193
|
+
* @param {*} [options] Override http request option.
|
|
194
|
+
* @throws {RequiredError}
|
|
195
|
+
*/
|
|
196
|
+
updateBankOrder(code: string, updateBankOrderRequestDto: UpdateBankOrderRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateBankOrderResponseClass>;
|
|
197
|
+
};
|
|
198
|
+
/**
|
|
199
|
+
* Request parameters for createBankOrder operation in BankOrdersApi.
|
|
200
|
+
* @export
|
|
201
|
+
* @interface BankOrdersApiCreateBankOrderRequest
|
|
202
|
+
*/
|
|
203
|
+
export interface BankOrdersApiCreateBankOrderRequest {
|
|
204
|
+
/**
|
|
205
|
+
*
|
|
206
|
+
* @type {CreateBankOrderRequestDto}
|
|
207
|
+
* @memberof BankOrdersApiCreateBankOrder
|
|
208
|
+
*/
|
|
209
|
+
readonly createBankOrderRequestDto: CreateBankOrderRequestDto;
|
|
210
|
+
/**
|
|
211
|
+
* Bearer Token
|
|
212
|
+
* @type {string}
|
|
213
|
+
* @memberof BankOrdersApiCreateBankOrder
|
|
214
|
+
*/
|
|
215
|
+
readonly authorization?: string;
|
|
216
|
+
}
|
|
217
|
+
/**
|
|
218
|
+
* Request parameters for deleteBankOrder operation in BankOrdersApi.
|
|
219
|
+
* @export
|
|
220
|
+
* @interface BankOrdersApiDeleteBankOrderRequest
|
|
221
|
+
*/
|
|
222
|
+
export interface BankOrdersApiDeleteBankOrderRequest {
|
|
223
|
+
/**
|
|
224
|
+
* Unique identifier for the object.
|
|
225
|
+
* @type {string}
|
|
226
|
+
* @memberof BankOrdersApiDeleteBankOrder
|
|
227
|
+
*/
|
|
228
|
+
readonly code: string;
|
|
229
|
+
/**
|
|
230
|
+
* Bearer Token
|
|
231
|
+
* @type {string}
|
|
232
|
+
* @memberof BankOrdersApiDeleteBankOrder
|
|
233
|
+
*/
|
|
234
|
+
readonly authorization?: string;
|
|
235
|
+
}
|
|
236
|
+
/**
|
|
237
|
+
* Request parameters for getBankOrder operation in BankOrdersApi.
|
|
238
|
+
* @export
|
|
239
|
+
* @interface BankOrdersApiGetBankOrderRequest
|
|
240
|
+
*/
|
|
241
|
+
export interface BankOrdersApiGetBankOrderRequest {
|
|
242
|
+
/**
|
|
243
|
+
*
|
|
244
|
+
* @type {string}
|
|
245
|
+
* @memberof BankOrdersApiGetBankOrder
|
|
246
|
+
*/
|
|
247
|
+
readonly code: string;
|
|
248
|
+
/**
|
|
249
|
+
* Bearer Token
|
|
250
|
+
* @type {string}
|
|
251
|
+
* @memberof BankOrdersApiGetBankOrder
|
|
252
|
+
*/
|
|
253
|
+
readonly authorization?: string;
|
|
254
|
+
/**
|
|
255
|
+
* 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: financialAccount<i>
|
|
256
|
+
* @type {string}
|
|
257
|
+
* @memberof BankOrdersApiGetBankOrder
|
|
258
|
+
*/
|
|
259
|
+
readonly expand?: string;
|
|
260
|
+
}
|
|
261
|
+
/**
|
|
262
|
+
* Request parameters for listBankOrders operation in BankOrdersApi.
|
|
263
|
+
* @export
|
|
264
|
+
* @interface BankOrdersApiListBankOrdersRequest
|
|
265
|
+
*/
|
|
266
|
+
export interface BankOrdersApiListBankOrdersRequest {
|
|
267
|
+
/**
|
|
268
|
+
* Bearer Token
|
|
269
|
+
* @type {string}
|
|
270
|
+
* @memberof BankOrdersApiListBankOrders
|
|
271
|
+
*/
|
|
272
|
+
readonly authorization?: string;
|
|
273
|
+
/**
|
|
274
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
275
|
+
* @type {number}
|
|
276
|
+
* @memberof BankOrdersApiListBankOrders
|
|
277
|
+
*/
|
|
278
|
+
readonly pageSize?: number;
|
|
279
|
+
/**
|
|
280
|
+
* A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
281
|
+
* @type {string}
|
|
282
|
+
* @memberof BankOrdersApiListBankOrders
|
|
283
|
+
*/
|
|
284
|
+
readonly pageToken?: string;
|
|
285
|
+
/**
|
|
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, financialAccountCode</i>
|
|
287
|
+
* @type {string}
|
|
288
|
+
* @memberof BankOrdersApiListBankOrders
|
|
289
|
+
*/
|
|
290
|
+
readonly filter?: string;
|
|
291
|
+
/**
|
|
292
|
+
* 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, financialAccountCode</i>
|
|
293
|
+
* @type {string}
|
|
294
|
+
* @memberof BankOrdersApiListBankOrders
|
|
295
|
+
*/
|
|
296
|
+
readonly search?: string;
|
|
297
|
+
/**
|
|
298
|
+
* 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, financialAccountCode, amount, createdAt, updatedAt</i>
|
|
299
|
+
* @type {string}
|
|
300
|
+
* @memberof BankOrdersApiListBankOrders
|
|
301
|
+
*/
|
|
302
|
+
readonly order?: string;
|
|
303
|
+
/**
|
|
304
|
+
* 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: financialAccount<i>
|
|
305
|
+
* @type {string}
|
|
306
|
+
* @memberof BankOrdersApiListBankOrders
|
|
307
|
+
*/
|
|
308
|
+
readonly expand?: string;
|
|
309
|
+
/**
|
|
310
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, orderNumber, status, type, financialAccountCode</i>
|
|
311
|
+
* @type {string}
|
|
312
|
+
* @memberof BankOrdersApiListBankOrders
|
|
313
|
+
*/
|
|
314
|
+
readonly filters?: string;
|
|
315
|
+
}
|
|
316
|
+
/**
|
|
317
|
+
* Request parameters for updateBankOrder operation in BankOrdersApi.
|
|
318
|
+
* @export
|
|
319
|
+
* @interface BankOrdersApiUpdateBankOrderRequest
|
|
320
|
+
*/
|
|
321
|
+
export interface BankOrdersApiUpdateBankOrderRequest {
|
|
322
|
+
/**
|
|
323
|
+
* Unique identifier for the object.
|
|
324
|
+
* @type {string}
|
|
325
|
+
* @memberof BankOrdersApiUpdateBankOrder
|
|
326
|
+
*/
|
|
327
|
+
readonly code: string;
|
|
328
|
+
/**
|
|
329
|
+
*
|
|
330
|
+
* @type {UpdateBankOrderRequestDto}
|
|
331
|
+
* @memberof BankOrdersApiUpdateBankOrder
|
|
332
|
+
*/
|
|
333
|
+
readonly updateBankOrderRequestDto: UpdateBankOrderRequestDto;
|
|
334
|
+
/**
|
|
335
|
+
* Bearer Token
|
|
336
|
+
* @type {string}
|
|
337
|
+
* @memberof BankOrdersApiUpdateBankOrder
|
|
338
|
+
*/
|
|
339
|
+
readonly authorization?: string;
|
|
340
|
+
}
|
|
341
|
+
/**
|
|
342
|
+
* BankOrdersApi - object-oriented interface
|
|
343
|
+
* @export
|
|
344
|
+
* @class BankOrdersApi
|
|
345
|
+
* @extends {BaseAPI}
|
|
346
|
+
*/
|
|
347
|
+
export declare class BankOrdersApi extends BaseAPI {
|
|
348
|
+
/**
|
|
349
|
+
* This will create a bank order. **Required Permissions** \"payment-management.bank-orders.create\", \"accounting-management.financialaccounts.view\", \"billing-management.invoices.view\"
|
|
350
|
+
* @summary Create the bank order
|
|
351
|
+
* @param {BankOrdersApiCreateBankOrderRequest} requestParameters Request parameters.
|
|
352
|
+
* @param {*} [options] Override http request option.
|
|
353
|
+
* @throws {RequiredError}
|
|
354
|
+
* @memberof BankOrdersApi
|
|
355
|
+
*/
|
|
356
|
+
createBankOrder(requestParameters: BankOrdersApiCreateBankOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateBankOrderResponseClass, any>>;
|
|
357
|
+
/**
|
|
358
|
+
* Deletes a bank order by code. **Required Permissions** \"payment-management.bank-orders.delete\"
|
|
359
|
+
* @summary Delete the bank order
|
|
360
|
+
* @param {BankOrdersApiDeleteBankOrderRequest} requestParameters Request parameters.
|
|
361
|
+
* @param {*} [options] Override http request option.
|
|
362
|
+
* @throws {RequiredError}
|
|
363
|
+
* @memberof BankOrdersApi
|
|
364
|
+
*/
|
|
365
|
+
deleteBankOrder(requestParameters: BankOrdersApiDeleteBankOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
366
|
+
/**
|
|
367
|
+
* Retrieves the details of the bank order that was previously created. Supply the unique bank order code that was returned when you created it and Emil Api will return the corresponding bank order information. **Required Permissions** \"payment-management.bank-orders.view\"
|
|
368
|
+
* @summary Retrieve the bank order
|
|
369
|
+
* @param {BankOrdersApiGetBankOrderRequest} requestParameters Request parameters.
|
|
370
|
+
* @param {*} [options] Override http request option.
|
|
371
|
+
* @throws {RequiredError}
|
|
372
|
+
* @memberof BankOrdersApi
|
|
373
|
+
*/
|
|
374
|
+
getBankOrder(requestParameters: BankOrdersApiGetBankOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetBankOrderResponseClass, any>>;
|
|
375
|
+
/**
|
|
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
|
+
* @summary List bank orders
|
|
378
|
+
* @param {BankOrdersApiListBankOrdersRequest} requestParameters Request parameters.
|
|
379
|
+
* @param {*} [options] Override http request option.
|
|
380
|
+
* @throws {RequiredError}
|
|
381
|
+
* @memberof BankOrdersApi
|
|
382
|
+
*/
|
|
383
|
+
listBankOrders(requestParameters?: BankOrdersApiListBankOrdersRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListBankOrdersResponseClass, any>>;
|
|
384
|
+
/**
|
|
385
|
+
* Update a bank order by code **Required Permissions** \"payment-management.bank-orders.update\", \"billing-management.invoices.view\"
|
|
386
|
+
* @summary Update the bank order
|
|
387
|
+
* @param {BankOrdersApiUpdateBankOrderRequest} requestParameters Request parameters.
|
|
388
|
+
* @param {*} [options] Override http request option.
|
|
389
|
+
* @throws {RequiredError}
|
|
390
|
+
* @memberof BankOrdersApi
|
|
391
|
+
*/
|
|
392
|
+
updateBankOrder(requestParameters: BankOrdersApiUpdateBankOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateBankOrderResponseClass, any>>;
|
|
393
|
+
}
|