@emilgroup/payment-sdk 1.4.1-beta.4 → 1.4.1-beta.40
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 +15 -7
- package/README.md +2 -2
- package/api/bank-accounts-api.ts +501 -89
- package/api/bank-transaction-api.ts +303 -97
- package/api/{default-api.ts → health-check-api.ts} +23 -19
- package/api/payment-methods-api.ts +62 -243
- package/api/payment-reminders-api.ts +58 -100
- package/api/payment-setup-api.ts +18 -10
- package/api/payments-api.ts +73 -136
- package/api/refunds-api.ts +436 -0
- package/api/tenant-bank-account-api.ts +100 -102
- package/api/webhooks-api.ts +18 -14
- package/api.ts +6 -4
- package/base.ts +23 -11
- package/common.ts +4 -4
- package/configuration.ts +2 -2
- package/dist/api/bank-accounts-api.d.ts +293 -70
- package/dist/api/bank-accounts-api.js +433 -63
- package/dist/api/bank-transaction-api.d.ts +193 -83
- package/dist/api/bank-transaction-api.js +253 -66
- package/dist/api/health-check-api.d.ts +70 -0
- package/dist/api/{default-api.js → health-check-api.js} +32 -28
- package/dist/api/payment-methods-api.d.ts +52 -152
- package/dist/api/payment-methods-api.js +49 -179
- package/dist/api/payment-reminders-api.d.ts +53 -80
- package/dist/api/payment-reminders-api.js +45 -63
- package/dist/api/payment-setup-api.d.ts +18 -10
- package/dist/api/payment-setup-api.js +18 -10
- package/dist/api/payments-api.d.ts +63 -99
- package/dist/api/payments-api.js +56 -86
- package/dist/api/refunds-api.d.ts +251 -0
- package/dist/api/refunds-api.js +439 -0
- package/dist/api/tenant-bank-account-api.d.ts +94 -89
- package/dist/api/tenant-bank-account-api.js +72 -64
- package/dist/api/webhooks-api.d.ts +18 -14
- package/dist/api/webhooks-api.js +16 -12
- package/dist/api.d.ts +4 -3
- package/dist/api.js +4 -3
- package/dist/base.d.ts +7 -4
- package/dist/base.js +32 -23
- package/dist/common.d.ts +4 -4
- package/dist/common.js +2 -2
- package/dist/configuration.d.ts +2 -2
- package/dist/configuration.js +2 -2
- package/dist/index.d.ts +2 -2
- package/dist/index.js +2 -2
- package/dist/models/{bank-transaction-response-class.d.ts → bank-transaction-class-without-expand-properties.d.ts} +32 -34
- package/dist/models/{bank-transaction-response-class.js → bank-transaction-class-without-expand-properties.js} +2 -2
- package/dist/models/create-bank-account-request-dto.d.ts +42 -0
- package/dist/models/{get-request-dto.js → create-bank-account-request-dto.js} +2 -2
- package/dist/models/create-payment-reminder-request-dto.d.ts +2 -2
- package/dist/models/create-payment-reminder-request-dto.js +2 -2
- package/dist/models/create-payment-request-dto.d.ts +4 -4
- package/dist/models/create-payment-request-dto.js +2 -2
- package/dist/models/create-refund-request-dto.d.ts +24 -0
- package/dist/models/{get-bank-transactions-response-class.js → create-refund-request-dto.js} +2 -2
- package/dist/models/create-tenant-bank-account-request-dto.d.ts +2 -2
- package/dist/models/create-tenant-bank-account-request-dto.js +2 -2
- package/dist/models/create-tenant-bank-account-response-class.d.ts +25 -0
- package/dist/models/{list-bank-transactions-response-class.js → create-tenant-bank-account-response-class.js} +2 -2
- package/dist/models/deactivate-payment-reminder-request-dto.d.ts +2 -2
- package/dist/models/deactivate-payment-reminder-request-dto.js +2 -2
- package/dist/models/get-tenant-bank-account-response-class.d.ts +6 -6
- package/dist/models/get-tenant-bank-account-response-class.js +2 -2
- package/dist/models/index.d.ts +13 -6
- package/dist/models/index.js +13 -6
- package/dist/models/inline-response200.d.ts +2 -2
- package/dist/models/inline-response200.js +2 -2
- package/dist/models/inline-response503.d.ts +2 -2
- package/dist/models/inline-response503.js +2 -2
- package/dist/models/link-bank-transaction-request-dto-rest.d.ts +24 -0
- package/dist/models/link-bank-transaction-request-dto-rest.js +15 -0
- package/dist/models/list-tenant-bank-account-response-class.d.ts +31 -0
- package/dist/models/list-tenant-bank-account-response-class.js +15 -0
- package/dist/models/set-primary-bank-account-request-dto-rest.d.ts +24 -0
- package/dist/models/set-primary-bank-account-request-dto-rest.js +15 -0
- package/dist/models/tenant-bank-account-class-without-expand-properties.d.ts +78 -0
- package/dist/models/tenant-bank-account-class-without-expand-properties.js +15 -0
- package/dist/models/tenant-bank-account-class.d.ts +85 -0
- package/dist/models/tenant-bank-account-class.js +15 -0
- package/dist/models/unlink-bank-transaction-request-dto-rest.d.ts +24 -0
- package/dist/models/unlink-bank-transaction-request-dto-rest.js +15 -0
- package/dist/models/update-bank-account-request-dto-rest.d.ts +30 -0
- package/dist/models/update-bank-account-request-dto-rest.js +15 -0
- package/dist/models/update-bank-account-request-dto.d.ts +36 -0
- package/dist/models/update-bank-account-request-dto.js +15 -0
- package/dist/models/update-tenant-bank-account-response-class.d.ts +25 -0
- package/dist/models/update-tenant-bank-account-response-class.js +15 -0
- package/dist/models/update-tenant-bank-account-rest-request-dto.d.ts +2 -2
- package/dist/models/update-tenant-bank-account-rest-request-dto.js +2 -2
- package/dist/models/validate-pspconfig-request-dto.d.ts +2 -2
- package/dist/models/validate-pspconfig-request-dto.js +2 -2
- package/index.ts +2 -2
- package/models/{bank-transaction-response-class.ts → bank-transaction-class-without-expand-properties.ts} +32 -34
- package/models/create-bank-account-request-dto.ts +48 -0
- package/models/create-payment-reminder-request-dto.ts +2 -2
- package/models/create-payment-request-dto.ts +4 -4
- package/models/create-refund-request-dto.ts +30 -0
- package/models/create-tenant-bank-account-request-dto.ts +2 -2
- package/models/create-tenant-bank-account-response-class.ts +31 -0
- package/models/deactivate-payment-reminder-request-dto.ts +2 -2
- package/models/get-tenant-bank-account-response-class.ts +6 -6
- package/models/index.ts +13 -6
- package/models/inline-response200.ts +2 -2
- package/models/inline-response503.ts +2 -2
- package/models/link-bank-transaction-request-dto-rest.ts +30 -0
- package/models/list-tenant-bank-account-response-class.ts +37 -0
- package/models/set-primary-bank-account-request-dto-rest.ts +30 -0
- package/models/{tenant-bank-account-response-class.ts → tenant-bank-account-class-without-expand-properties.ts} +24 -12
- package/models/tenant-bank-account-class.ts +91 -0
- package/models/unlink-bank-transaction-request-dto-rest.ts +30 -0
- package/models/update-bank-account-request-dto-rest.ts +36 -0
- package/models/update-bank-account-request-dto.ts +42 -0
- package/models/update-tenant-bank-account-response-class.ts +31 -0
- package/models/update-tenant-bank-account-rest-request-dto.ts +2 -2
- package/models/validate-pspconfig-request-dto.ts +2 -2
- package/package.json +1 -1
- package/dist/api/default-api.d.ts +0 -66
- package/dist/models/get-bank-transactions-response-class.d.ts +0 -25
- package/dist/models/get-request-dto.d.ts +0 -30
- package/dist/models/list-bank-transactions-response-class.d.ts +0 -31
- package/dist/models/tenant-bank-account-response-class.d.ts +0 -66
- package/dist/models/tenant-bank-account-response-class.js +0 -15
- package/dist/models/transaction-class.d.ts +0 -54
- package/dist/models/transaction-class.js +0 -15
- package/models/get-bank-transactions-response-class.ts +0 -31
- package/models/get-request-dto.ts +0 -36
- package/models/list-bank-transactions-response-class.ts +0 -37
- package/models/transaction-class.ts +0 -60
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Emil Payment Service
|
|
3
|
-
* This service directly communicates with the various Payment Service Providers (PSPs)
|
|
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
4
|
*
|
|
5
5
|
* The version of the OpenAPI document: 1.0
|
|
6
|
-
* Contact:
|
|
6
|
+
* Contact: kontakt@emil.de
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
9
|
* https://openapi-generator.tech
|
|
@@ -12,47 +12,65 @@
|
|
|
12
12
|
import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
13
13
|
import { Configuration } from '../configuration';
|
|
14
14
|
import { RequestArgs, BaseAPI } from '../base';
|
|
15
|
-
import {
|
|
16
|
-
import {
|
|
15
|
+
import { LinkBankTransactionRequestDtoRest } from '../models';
|
|
16
|
+
import { UnlinkBankTransactionRequestDtoRest } from '../models';
|
|
17
17
|
/**
|
|
18
18
|
* BankTransactionApi - axios parameter creator
|
|
19
19
|
* @export
|
|
20
20
|
*/
|
|
21
21
|
export declare const BankTransactionApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
22
22
|
/**
|
|
23
|
-
* Retrieves the details of the
|
|
24
|
-
* @summary Retrieve the
|
|
23
|
+
* Retrieves the details of the bank transaction that was previously created. Supply the unique bank transaction code that was returned when you created it and Emil Api will return the corresponding bank transaction information.
|
|
24
|
+
* @summary Retrieve the bank transaction
|
|
25
25
|
* @param {string} code
|
|
26
26
|
* @param {string} [authorization] Bearer Token
|
|
27
|
-
* @param {string} [expand] Expand the
|
|
27
|
+
* @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<i>
|
|
28
28
|
* @param {*} [options] Override http request option.
|
|
29
29
|
* @throws {RequiredError}
|
|
30
30
|
*/
|
|
31
31
|
getBankTransaction: (code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
32
32
|
/**
|
|
33
|
-
*
|
|
33
|
+
* This will import bank transactions from a swift MT940 file
|
|
34
34
|
* @summary Create the bank transactions
|
|
35
|
+
* @param {any} file Swift MT940 file to import bank transactions from. Extension must be .txt or .sta.<br/> Allowed Content Types: text/plain, application/octet-stream
|
|
35
36
|
* @param {string} [authorization] Bearer Token
|
|
36
|
-
* @param {any} [file]
|
|
37
37
|
* @param {*} [options] Override http request option.
|
|
38
38
|
* @throws {RequiredError}
|
|
39
39
|
*/
|
|
40
|
-
importBankTransactions: (
|
|
40
|
+
importBankTransactions: (file: any, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
41
41
|
/**
|
|
42
|
-
*
|
|
42
|
+
* Links a bank transaction with an invoice
|
|
43
|
+
* @summary Link bank transaction
|
|
44
|
+
* @param {string} code Code of the bank transaction to link
|
|
45
|
+
* @param {LinkBankTransactionRequestDtoRest} linkBankTransactionRequestDtoRest
|
|
46
|
+
* @param {string} [authorization] Bearer Token
|
|
47
|
+
* @param {*} [options] Override http request option.
|
|
48
|
+
* @throws {RequiredError}
|
|
49
|
+
*/
|
|
50
|
+
linkBankTransaction: (code: string, linkBankTransactionRequestDtoRest: LinkBankTransactionRequestDtoRest, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
51
|
+
/**
|
|
52
|
+
* 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.
|
|
43
53
|
* @summary List bank transactions
|
|
44
54
|
* @param {string} [authorization] Bearer Token
|
|
45
|
-
* @param {
|
|
46
|
-
* @param {
|
|
47
|
-
* @param {
|
|
48
|
-
* @param {
|
|
49
|
-
* @param {
|
|
50
|
-
* @param {string} [expand] Expand the response with additional entities
|
|
51
|
-
* @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
55
|
+
* @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, swiftMessageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked</i>
|
|
56
|
+
* @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, swiftMessageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked</i>
|
|
57
|
+
* @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>
|
|
58
|
+
* @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, amount, transactionDate, entryDate</i>
|
|
59
|
+
* @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<i>
|
|
52
60
|
* @param {*} [options] Override http request option.
|
|
53
61
|
* @throws {RequiredError}
|
|
54
62
|
*/
|
|
55
|
-
listBankTransactions: (authorization?: string,
|
|
63
|
+
listBankTransactions: (authorization?: string, filter?: string, filters?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
64
|
+
/**
|
|
65
|
+
* Unlinks an already linked bank transaction
|
|
66
|
+
* @summary Unlink bank transaction
|
|
67
|
+
* @param {string} code Code of the bank transaction to unlink
|
|
68
|
+
* @param {UnlinkBankTransactionRequestDtoRest} unlinkBankTransactionRequestDtoRest
|
|
69
|
+
* @param {string} [authorization] Bearer Token
|
|
70
|
+
* @param {*} [options] Override http request option.
|
|
71
|
+
* @throws {RequiredError}
|
|
72
|
+
*/
|
|
73
|
+
unlinkBankTransaction: (code: string, unlinkBankTransactionRequestDtoRest: UnlinkBankTransactionRequestDtoRest, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
56
74
|
};
|
|
57
75
|
/**
|
|
58
76
|
* BankTransactionApi - functional programming interface
|
|
@@ -60,39 +78,57 @@ export declare const BankTransactionApiAxiosParamCreator: (configuration?: Confi
|
|
|
60
78
|
*/
|
|
61
79
|
export declare const BankTransactionApiFp: (configuration?: Configuration) => {
|
|
62
80
|
/**
|
|
63
|
-
* Retrieves the details of the
|
|
64
|
-
* @summary Retrieve the
|
|
81
|
+
* Retrieves the details of the bank transaction that was previously created. Supply the unique bank transaction code that was returned when you created it and Emil Api will return the corresponding bank transaction information.
|
|
82
|
+
* @summary Retrieve the bank transaction
|
|
65
83
|
* @param {string} code
|
|
66
84
|
* @param {string} [authorization] Bearer Token
|
|
67
|
-
* @param {string} [expand] Expand the
|
|
85
|
+
* @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<i>
|
|
68
86
|
* @param {*} [options] Override http request option.
|
|
69
87
|
* @throws {RequiredError}
|
|
70
88
|
*/
|
|
71
|
-
getBankTransaction(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
89
|
+
getBankTransaction(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
72
90
|
/**
|
|
73
|
-
*
|
|
91
|
+
* This will import bank transactions from a swift MT940 file
|
|
74
92
|
* @summary Create the bank transactions
|
|
93
|
+
* @param {any} file Swift MT940 file to import bank transactions from. Extension must be .txt or .sta.<br/> Allowed Content Types: text/plain, application/octet-stream
|
|
94
|
+
* @param {string} [authorization] Bearer Token
|
|
95
|
+
* @param {*} [options] Override http request option.
|
|
96
|
+
* @throws {RequiredError}
|
|
97
|
+
*/
|
|
98
|
+
importBankTransactions(file: any, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
99
|
+
/**
|
|
100
|
+
* Links a bank transaction with an invoice
|
|
101
|
+
* @summary Link bank transaction
|
|
102
|
+
* @param {string} code Code of the bank transaction to link
|
|
103
|
+
* @param {LinkBankTransactionRequestDtoRest} linkBankTransactionRequestDtoRest
|
|
75
104
|
* @param {string} [authorization] Bearer Token
|
|
76
|
-
* @param {any} [file]
|
|
77
105
|
* @param {*} [options] Override http request option.
|
|
78
106
|
* @throws {RequiredError}
|
|
79
107
|
*/
|
|
80
|
-
|
|
108
|
+
linkBankTransaction(code: string, linkBankTransactionRequestDtoRest: LinkBankTransactionRequestDtoRest, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
81
109
|
/**
|
|
82
|
-
* Returns a list of bank transactions you have previously created.
|
|
110
|
+
* 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.
|
|
83
111
|
* @summary List bank transactions
|
|
84
112
|
* @param {string} [authorization] Bearer Token
|
|
85
|
-
* @param {
|
|
86
|
-
* @param {
|
|
87
|
-
* @param {
|
|
88
|
-
* @param {
|
|
89
|
-
* @param {
|
|
90
|
-
* @param {string} [expand] Expand the response with additional entities
|
|
91
|
-
* @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
113
|
+
* @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, swiftMessageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked</i>
|
|
114
|
+
* @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, swiftMessageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked</i>
|
|
115
|
+
* @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>
|
|
116
|
+
* @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, amount, transactionDate, entryDate</i>
|
|
117
|
+
* @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<i>
|
|
92
118
|
* @param {*} [options] Override http request option.
|
|
93
119
|
* @throws {RequiredError}
|
|
94
120
|
*/
|
|
95
|
-
listBankTransactions(authorization?: string,
|
|
121
|
+
listBankTransactions(authorization?: string, filter?: string, filters?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
122
|
+
/**
|
|
123
|
+
* Unlinks an already linked bank transaction
|
|
124
|
+
* @summary Unlink bank transaction
|
|
125
|
+
* @param {string} code Code of the bank transaction to unlink
|
|
126
|
+
* @param {UnlinkBankTransactionRequestDtoRest} unlinkBankTransactionRequestDtoRest
|
|
127
|
+
* @param {string} [authorization] Bearer Token
|
|
128
|
+
* @param {*} [options] Override http request option.
|
|
129
|
+
* @throws {RequiredError}
|
|
130
|
+
*/
|
|
131
|
+
unlinkBankTransaction(code: string, unlinkBankTransactionRequestDtoRest: UnlinkBankTransactionRequestDtoRest, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
96
132
|
};
|
|
97
133
|
/**
|
|
98
134
|
* BankTransactionApi - factory interface
|
|
@@ -100,39 +136,57 @@ export declare const BankTransactionApiFp: (configuration?: Configuration) => {
|
|
|
100
136
|
*/
|
|
101
137
|
export declare const BankTransactionApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
102
138
|
/**
|
|
103
|
-
* Retrieves the details of the
|
|
104
|
-
* @summary Retrieve the
|
|
139
|
+
* Retrieves the details of the bank transaction that was previously created. Supply the unique bank transaction code that was returned when you created it and Emil Api will return the corresponding bank transaction information.
|
|
140
|
+
* @summary Retrieve the bank transaction
|
|
105
141
|
* @param {string} code
|
|
106
142
|
* @param {string} [authorization] Bearer Token
|
|
107
|
-
* @param {string} [expand] Expand the
|
|
143
|
+
* @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<i>
|
|
108
144
|
* @param {*} [options] Override http request option.
|
|
109
145
|
* @throws {RequiredError}
|
|
110
146
|
*/
|
|
111
|
-
getBankTransaction(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<
|
|
147
|
+
getBankTransaction(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<void>;
|
|
112
148
|
/**
|
|
113
|
-
*
|
|
149
|
+
* This will import bank transactions from a swift MT940 file
|
|
114
150
|
* @summary Create the bank transactions
|
|
151
|
+
* @param {any} file Swift MT940 file to import bank transactions from. Extension must be .txt or .sta.<br/> Allowed Content Types: text/plain, application/octet-stream
|
|
115
152
|
* @param {string} [authorization] Bearer Token
|
|
116
|
-
* @param {any} [file]
|
|
117
153
|
* @param {*} [options] Override http request option.
|
|
118
154
|
* @throws {RequiredError}
|
|
119
155
|
*/
|
|
120
|
-
importBankTransactions(
|
|
156
|
+
importBankTransactions(file: any, authorization?: string, options?: any): AxiosPromise<void>;
|
|
121
157
|
/**
|
|
122
|
-
*
|
|
158
|
+
* Links a bank transaction with an invoice
|
|
159
|
+
* @summary Link bank transaction
|
|
160
|
+
* @param {string} code Code of the bank transaction to link
|
|
161
|
+
* @param {LinkBankTransactionRequestDtoRest} linkBankTransactionRequestDtoRest
|
|
162
|
+
* @param {string} [authorization] Bearer Token
|
|
163
|
+
* @param {*} [options] Override http request option.
|
|
164
|
+
* @throws {RequiredError}
|
|
165
|
+
*/
|
|
166
|
+
linkBankTransaction(code: string, linkBankTransactionRequestDtoRest: LinkBankTransactionRequestDtoRest, authorization?: string, options?: any): AxiosPromise<void>;
|
|
167
|
+
/**
|
|
168
|
+
* 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.
|
|
123
169
|
* @summary List bank transactions
|
|
124
170
|
* @param {string} [authorization] Bearer Token
|
|
125
|
-
* @param {
|
|
126
|
-
* @param {
|
|
127
|
-
* @param {
|
|
128
|
-
* @param {
|
|
129
|
-
* @param {
|
|
130
|
-
* @param {string} [expand] Expand the response with additional entities
|
|
131
|
-
* @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
171
|
+
* @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, swiftMessageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked</i>
|
|
172
|
+
* @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, swiftMessageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked</i>
|
|
173
|
+
* @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>
|
|
174
|
+
* @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, amount, transactionDate, entryDate</i>
|
|
175
|
+
* @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<i>
|
|
132
176
|
* @param {*} [options] Override http request option.
|
|
133
177
|
* @throws {RequiredError}
|
|
134
178
|
*/
|
|
135
|
-
listBankTransactions(authorization?: string,
|
|
179
|
+
listBankTransactions(authorization?: string, filter?: string, filters?: string, search?: string, order?: string, expand?: string, options?: any): AxiosPromise<void>;
|
|
180
|
+
/**
|
|
181
|
+
* Unlinks an already linked bank transaction
|
|
182
|
+
* @summary Unlink bank transaction
|
|
183
|
+
* @param {string} code Code of the bank transaction to unlink
|
|
184
|
+
* @param {UnlinkBankTransactionRequestDtoRest} unlinkBankTransactionRequestDtoRest
|
|
185
|
+
* @param {string} [authorization] Bearer Token
|
|
186
|
+
* @param {*} [options] Override http request option.
|
|
187
|
+
* @throws {RequiredError}
|
|
188
|
+
*/
|
|
189
|
+
unlinkBankTransaction(code: string, unlinkBankTransactionRequestDtoRest: UnlinkBankTransactionRequestDtoRest, authorization?: string, options?: any): AxiosPromise<void>;
|
|
136
190
|
};
|
|
137
191
|
/**
|
|
138
192
|
* Request parameters for getBankTransaction operation in BankTransactionApi.
|
|
@@ -153,7 +207,7 @@ export interface BankTransactionApiGetBankTransactionRequest {
|
|
|
153
207
|
*/
|
|
154
208
|
readonly authorization?: string;
|
|
155
209
|
/**
|
|
156
|
-
* Expand the
|
|
210
|
+
* 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<i>
|
|
157
211
|
* @type {string}
|
|
158
212
|
* @memberof BankTransactionApiGetBankTransaction
|
|
159
213
|
*/
|
|
@@ -165,18 +219,43 @@ export interface BankTransactionApiGetBankTransactionRequest {
|
|
|
165
219
|
* @interface BankTransactionApiImportBankTransactionsRequest
|
|
166
220
|
*/
|
|
167
221
|
export interface BankTransactionApiImportBankTransactionsRequest {
|
|
222
|
+
/**
|
|
223
|
+
* Swift MT940 file to import bank transactions from. Extension must be .txt or .sta.<br/> Allowed Content Types: text/plain, application/octet-stream
|
|
224
|
+
* @type {any}
|
|
225
|
+
* @memberof BankTransactionApiImportBankTransactions
|
|
226
|
+
*/
|
|
227
|
+
readonly file: any;
|
|
168
228
|
/**
|
|
169
229
|
* Bearer Token
|
|
170
230
|
* @type {string}
|
|
171
231
|
* @memberof BankTransactionApiImportBankTransactions
|
|
172
232
|
*/
|
|
173
233
|
readonly authorization?: string;
|
|
234
|
+
}
|
|
235
|
+
/**
|
|
236
|
+
* Request parameters for linkBankTransaction operation in BankTransactionApi.
|
|
237
|
+
* @export
|
|
238
|
+
* @interface BankTransactionApiLinkBankTransactionRequest
|
|
239
|
+
*/
|
|
240
|
+
export interface BankTransactionApiLinkBankTransactionRequest {
|
|
241
|
+
/**
|
|
242
|
+
* Code of the bank transaction to link
|
|
243
|
+
* @type {string}
|
|
244
|
+
* @memberof BankTransactionApiLinkBankTransaction
|
|
245
|
+
*/
|
|
246
|
+
readonly code: string;
|
|
174
247
|
/**
|
|
175
248
|
*
|
|
176
|
-
* @type {
|
|
177
|
-
* @memberof
|
|
249
|
+
* @type {LinkBankTransactionRequestDtoRest}
|
|
250
|
+
* @memberof BankTransactionApiLinkBankTransaction
|
|
251
|
+
*/
|
|
252
|
+
readonly linkBankTransactionRequestDtoRest: LinkBankTransactionRequestDtoRest;
|
|
253
|
+
/**
|
|
254
|
+
* Bearer Token
|
|
255
|
+
* @type {string}
|
|
256
|
+
* @memberof BankTransactionApiLinkBankTransaction
|
|
178
257
|
*/
|
|
179
|
-
readonly
|
|
258
|
+
readonly authorization?: string;
|
|
180
259
|
}
|
|
181
260
|
/**
|
|
182
261
|
* Request parameters for listBankTransactions operation in BankTransactionApi.
|
|
@@ -191,47 +270,60 @@ export interface BankTransactionApiListBankTransactionsRequest {
|
|
|
191
270
|
*/
|
|
192
271
|
readonly authorization?: string;
|
|
193
272
|
/**
|
|
194
|
-
*
|
|
195
|
-
* @type {
|
|
273
|
+
* 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, swiftMessageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked</i>
|
|
274
|
+
* @type {string}
|
|
196
275
|
* @memberof BankTransactionApiListBankTransactions
|
|
197
276
|
*/
|
|
198
|
-
readonly
|
|
277
|
+
readonly filter?: string;
|
|
199
278
|
/**
|
|
200
|
-
*
|
|
201
|
-
* @type {
|
|
279
|
+
* 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, swiftMessageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked</i>
|
|
280
|
+
* @type {string}
|
|
202
281
|
* @memberof BankTransactionApiListBankTransactions
|
|
203
282
|
*/
|
|
204
|
-
readonly
|
|
283
|
+
readonly filters?: string;
|
|
205
284
|
/**
|
|
206
|
-
*
|
|
207
|
-
* @type {
|
|
285
|
+
* 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>
|
|
286
|
+
* @type {string}
|
|
208
287
|
* @memberof BankTransactionApiListBankTransactions
|
|
209
288
|
*/
|
|
210
|
-
readonly
|
|
289
|
+
readonly search?: string;
|
|
211
290
|
/**
|
|
212
|
-
*
|
|
213
|
-
* @type {
|
|
291
|
+
* 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, amount, transactionDate, entryDate</i>
|
|
292
|
+
* @type {string}
|
|
214
293
|
* @memberof BankTransactionApiListBankTransactions
|
|
215
294
|
*/
|
|
216
|
-
readonly
|
|
295
|
+
readonly order?: string;
|
|
217
296
|
/**
|
|
218
|
-
*
|
|
219
|
-
* @type {
|
|
297
|
+
* 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<i>
|
|
298
|
+
* @type {string}
|
|
220
299
|
* @memberof BankTransactionApiListBankTransactions
|
|
221
300
|
*/
|
|
222
|
-
readonly
|
|
301
|
+
readonly expand?: string;
|
|
302
|
+
}
|
|
303
|
+
/**
|
|
304
|
+
* Request parameters for unlinkBankTransaction operation in BankTransactionApi.
|
|
305
|
+
* @export
|
|
306
|
+
* @interface BankTransactionApiUnlinkBankTransactionRequest
|
|
307
|
+
*/
|
|
308
|
+
export interface BankTransactionApiUnlinkBankTransactionRequest {
|
|
223
309
|
/**
|
|
224
|
-
*
|
|
310
|
+
* Code of the bank transaction to unlink
|
|
225
311
|
* @type {string}
|
|
226
|
-
* @memberof
|
|
312
|
+
* @memberof BankTransactionApiUnlinkBankTransaction
|
|
227
313
|
*/
|
|
228
|
-
readonly
|
|
314
|
+
readonly code: string;
|
|
229
315
|
/**
|
|
230
|
-
*
|
|
231
|
-
* @type {
|
|
232
|
-
* @memberof
|
|
316
|
+
*
|
|
317
|
+
* @type {UnlinkBankTransactionRequestDtoRest}
|
|
318
|
+
* @memberof BankTransactionApiUnlinkBankTransaction
|
|
233
319
|
*/
|
|
234
|
-
readonly
|
|
320
|
+
readonly unlinkBankTransactionRequestDtoRest: UnlinkBankTransactionRequestDtoRest;
|
|
321
|
+
/**
|
|
322
|
+
* Bearer Token
|
|
323
|
+
* @type {string}
|
|
324
|
+
* @memberof BankTransactionApiUnlinkBankTransaction
|
|
325
|
+
*/
|
|
326
|
+
readonly authorization?: string;
|
|
235
327
|
}
|
|
236
328
|
/**
|
|
237
329
|
* BankTransactionApi - object-oriented interface
|
|
@@ -241,25 +333,34 @@ export interface BankTransactionApiListBankTransactionsRequest {
|
|
|
241
333
|
*/
|
|
242
334
|
export declare class BankTransactionApi extends BaseAPI {
|
|
243
335
|
/**
|
|
244
|
-
* Retrieves the details of the
|
|
245
|
-
* @summary Retrieve the
|
|
336
|
+
* Retrieves the details of the bank transaction that was previously created. Supply the unique bank transaction code that was returned when you created it and Emil Api will return the corresponding bank transaction information.
|
|
337
|
+
* @summary Retrieve the bank transaction
|
|
246
338
|
* @param {BankTransactionApiGetBankTransactionRequest} requestParameters Request parameters.
|
|
247
339
|
* @param {*} [options] Override http request option.
|
|
248
340
|
* @throws {RequiredError}
|
|
249
341
|
* @memberof BankTransactionApi
|
|
250
342
|
*/
|
|
251
|
-
getBankTransaction(requestParameters: BankTransactionApiGetBankTransactionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
343
|
+
getBankTransaction(requestParameters: BankTransactionApiGetBankTransactionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
252
344
|
/**
|
|
253
|
-
*
|
|
345
|
+
* This will import bank transactions from a swift MT940 file
|
|
254
346
|
* @summary Create the bank transactions
|
|
255
347
|
* @param {BankTransactionApiImportBankTransactionsRequest} requestParameters Request parameters.
|
|
256
348
|
* @param {*} [options] Override http request option.
|
|
257
349
|
* @throws {RequiredError}
|
|
258
350
|
* @memberof BankTransactionApi
|
|
259
351
|
*/
|
|
260
|
-
importBankTransactions(requestParameters
|
|
352
|
+
importBankTransactions(requestParameters: BankTransactionApiImportBankTransactionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
261
353
|
/**
|
|
262
|
-
*
|
|
354
|
+
* Links a bank transaction with an invoice
|
|
355
|
+
* @summary Link bank transaction
|
|
356
|
+
* @param {BankTransactionApiLinkBankTransactionRequest} requestParameters Request parameters.
|
|
357
|
+
* @param {*} [options] Override http request option.
|
|
358
|
+
* @throws {RequiredError}
|
|
359
|
+
* @memberof BankTransactionApi
|
|
360
|
+
*/
|
|
361
|
+
linkBankTransaction(requestParameters: BankTransactionApiLinkBankTransactionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
362
|
+
/**
|
|
363
|
+
* 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.
|
|
263
364
|
* @summary List bank transactions
|
|
264
365
|
* @param {BankTransactionApiListBankTransactionsRequest} requestParameters Request parameters.
|
|
265
366
|
* @param {*} [options] Override http request option.
|
|
@@ -267,4 +368,13 @@ export declare class BankTransactionApi extends BaseAPI {
|
|
|
267
368
|
* @memberof BankTransactionApi
|
|
268
369
|
*/
|
|
269
370
|
listBankTransactions(requestParameters?: BankTransactionApiListBankTransactionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
371
|
+
/**
|
|
372
|
+
* Unlinks an already linked bank transaction
|
|
373
|
+
* @summary Unlink bank transaction
|
|
374
|
+
* @param {BankTransactionApiUnlinkBankTransactionRequest} requestParameters Request parameters.
|
|
375
|
+
* @param {*} [options] Override http request option.
|
|
376
|
+
* @throws {RequiredError}
|
|
377
|
+
* @memberof BankTransactionApi
|
|
378
|
+
*/
|
|
379
|
+
unlinkBankTransaction(requestParameters: BankTransactionApiUnlinkBankTransactionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
270
380
|
}
|