@emilgroup/payment-sdk 1.4.1-beta.9 → 1.5.1-beta.0
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 +11 -11
- package/README.md +2 -2
- package/api/bank-accounts-api.ts +500 -88
- package/api/bank-transaction-api.ts +93 -123
- package/api/{default-api.ts → health-check-api.ts} +22 -18
- package/api/payment-methods-api.ts +61 -242
- package/api/payment-reminders-api.ts +57 -99
- package/api/payment-setup-api.ts +17 -9
- package/api/payments-api.ts +72 -135
- package/api/refunds-api.ts +80 -120
- package/api/tenant-bank-account-api.ts +96 -118
- package/api/webhooks-api.ts +38 -21
- package/api.ts +3 -3
- package/base.ts +22 -10
- package/common.ts +2 -2
- package/configuration.ts +1 -1
- package/dist/api/bank-accounts-api.d.ts +292 -69
- package/dist/api/bank-accounts-api.js +432 -62
- package/dist/api/bank-transaction-api.d.ts +84 -104
- package/dist/api/bank-transaction-api.js +63 -74
- package/dist/api/health-check-api.d.ts +70 -0
- package/dist/api/{default-api.js → health-check-api.js} +31 -27
- package/dist/api/payment-methods-api.d.ts +51 -151
- package/dist/api/payment-methods-api.js +48 -178
- package/dist/api/payment-reminders-api.d.ts +52 -79
- package/dist/api/payment-reminders-api.js +44 -62
- package/dist/api/payment-setup-api.d.ts +17 -9
- package/dist/api/payment-setup-api.js +17 -9
- package/dist/api/payments-api.d.ts +62 -98
- package/dist/api/payments-api.js +55 -85
- package/dist/api/refunds-api.d.ts +73 -91
- package/dist/api/refunds-api.js +58 -68
- package/dist/api/tenant-bank-account-api.d.ts +90 -105
- package/dist/api/tenant-bank-account-api.js +63 -75
- package/dist/api/webhooks-api.d.ts +29 -16
- package/dist/api/webhooks-api.js +29 -19
- package/dist/api.d.ts +2 -2
- package/dist/api.js +2 -2
- package/dist/base.d.ts +6 -3
- package/dist/base.js +31 -22
- package/dist/common.d.ts +2 -2
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/dist/models/{bank-transaction-response-class.d.ts → bank-transaction-class-without-expand-properties.d.ts} +31 -33
- package/dist/models/{bank-transaction-response-class.js → bank-transaction-class-without-expand-properties.js} +1 -1
- package/dist/models/create-bank-account-request-dto.d.ts +42 -0
- package/dist/models/{get-refund-response-class.js → create-bank-account-request-dto.js} +1 -1
- package/dist/models/create-payment-reminder-request-dto.d.ts +1 -1
- package/dist/models/create-payment-reminder-request-dto.js +1 -1
- package/dist/models/create-payment-request-dto.d.ts +3 -3
- package/dist/models/create-payment-request-dto.js +1 -1
- package/dist/models/create-refund-request-dto.d.ts +1 -1
- package/dist/models/create-refund-request-dto.js +1 -1
- package/dist/models/create-tenant-bank-account-request-dto.d.ts +1 -1
- package/dist/models/create-tenant-bank-account-request-dto.js +1 -1
- package/dist/models/create-tenant-bank-account-response-class.d.ts +25 -0
- package/dist/models/{create-refund-response-class.js → create-tenant-bank-account-response-class.js} +1 -1
- package/dist/models/deactivate-payment-reminder-request-dto.d.ts +1 -1
- package/dist/models/deactivate-payment-reminder-request-dto.js +1 -1
- package/dist/models/get-tenant-bank-account-response-class.d.ts +5 -5
- package/dist/models/get-tenant-bank-account-response-class.js +1 -1
- package/dist/models/index.d.ts +10 -10
- package/dist/models/index.js +10 -10
- package/dist/models/inline-response200.d.ts +1 -1
- package/dist/models/inline-response200.js +1 -1
- package/dist/models/inline-response503.d.ts +1 -1
- package/dist/models/inline-response503.js +1 -1
- package/dist/models/link-bank-transaction-request-dto-rest.d.ts +1 -1
- package/dist/models/link-bank-transaction-request-dto-rest.js +1 -1
- package/dist/models/list-tenant-bank-account-response-class.d.ts +31 -0
- package/dist/models/{get-bank-transactions-response-class.js → list-tenant-bank-account-response-class.js} +1 -1
- 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-response-class.d.ts → tenant-bank-account-class-without-expand-properties.d.ts} +23 -11
- 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 +2 -2
- package/dist/models/unlink-bank-transaction-request-dto-rest.js +1 -1
- 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 +1 -1
- package/dist/models/update-tenant-bank-account-rest-request-dto.js +1 -1
- package/dist/models/validate-pspconfig-request-dto.d.ts +1 -1
- package/dist/models/validate-pspconfig-request-dto.js +1 -1
- package/index.ts +1 -1
- package/models/{bank-transaction-response-class.ts → bank-transaction-class-without-expand-properties.ts} +31 -33
- package/models/create-bank-account-request-dto.ts +48 -0
- package/models/create-payment-reminder-request-dto.ts +1 -1
- package/models/create-payment-request-dto.ts +3 -3
- package/models/create-refund-request-dto.ts +1 -1
- package/models/create-tenant-bank-account-request-dto.ts +1 -1
- package/models/create-tenant-bank-account-response-class.ts +31 -0
- package/models/deactivate-payment-reminder-request-dto.ts +1 -1
- package/models/get-tenant-bank-account-response-class.ts +5 -5
- package/models/index.ts +10 -10
- package/models/inline-response200.ts +1 -1
- package/models/inline-response503.ts +1 -1
- package/models/link-bank-transaction-request-dto-rest.ts +1 -1
- 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} +23 -11
- package/models/tenant-bank-account-class.ts +91 -0
- package/models/unlink-bank-transaction-request-dto-rest.ts +2 -2
- 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 +1 -1
- package/models/validate-pspconfig-request-dto.ts +1 -1
- package/package.json +1 -1
- package/dist/api/default-api.d.ts +0 -66
- package/dist/models/create-refund-response-class.d.ts +0 -25
- package/dist/models/get-bank-transactions-response-class.d.ts +0 -25
- package/dist/models/get-refund-response-class.d.ts +0 -25
- package/dist/models/get-request-dto.d.ts +0 -30
- package/dist/models/get-request-dto.js +0 -15
- package/dist/models/list-bank-transactions-response-class.d.ts +0 -31
- package/dist/models/list-bank-transactions-response-class.js +0 -15
- package/dist/models/list-refunds-response-class.d.ts +0 -31
- package/dist/models/list-refunds-response-class.js +0 -15
- package/dist/models/refund-class.d.ts +0 -104
- package/dist/models/refund-class.js +0 -28
- 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/create-refund-response-class.ts +0 -31
- package/models/get-bank-transactions-response-class.ts +0 -31
- package/models/get-refund-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/list-refunds-response-class.ts +0 -37
- package/models/refund-class.ts +0 -114
- package/models/transaction-class.ts +0 -60
|
@@ -1,6 +1,6 @@
|
|
|
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
6
|
* Contact: kontakt@emil.de
|
|
@@ -12,9 +12,7 @@
|
|
|
12
12
|
import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
13
13
|
import { Configuration } from '../configuration';
|
|
14
14
|
import { RequestArgs, BaseAPI } from '../base';
|
|
15
|
-
import { GetBankTransactionsResponseClass } from '../models';
|
|
16
15
|
import { LinkBankTransactionRequestDtoRest } from '../models';
|
|
17
|
-
import { ListBankTransactionsResponseClass } from '../models';
|
|
18
16
|
import { UnlinkBankTransactionRequestDtoRest } from '../models';
|
|
19
17
|
/**
|
|
20
18
|
* BankTransactionApi - axios parameter creator
|
|
@@ -22,27 +20,27 @@ import { UnlinkBankTransactionRequestDtoRest } from '../models';
|
|
|
22
20
|
*/
|
|
23
21
|
export declare const BankTransactionApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
24
22
|
/**
|
|
25
|
-
* Retrieves the details of the
|
|
26
|
-
* @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
|
|
27
25
|
* @param {string} code
|
|
28
26
|
* @param {string} [authorization] Bearer Token
|
|
29
|
-
* @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>
|
|
30
28
|
* @param {*} [options] Override http request option.
|
|
31
29
|
* @throws {RequiredError}
|
|
32
30
|
*/
|
|
33
31
|
getBankTransaction: (code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
34
32
|
/**
|
|
35
|
-
*
|
|
33
|
+
* This will import bank transactions from a swift MT940 file
|
|
36
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
|
|
37
36
|
* @param {string} [authorization] Bearer Token
|
|
38
|
-
* @param {any} [file]
|
|
39
37
|
* @param {*} [options] Override http request option.
|
|
40
38
|
* @throws {RequiredError}
|
|
41
39
|
*/
|
|
42
|
-
importBankTransactions: (
|
|
40
|
+
importBankTransactions: (file: any, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
43
41
|
/**
|
|
44
42
|
* Links a bank transaction with an invoice
|
|
45
|
-
* @summary Link
|
|
43
|
+
* @summary Link bank transaction
|
|
46
44
|
* @param {string} code Code of the bank transaction to link
|
|
47
45
|
* @param {LinkBankTransactionRequestDtoRest} linkBankTransactionRequestDtoRest
|
|
48
46
|
* @param {string} [authorization] Bearer Token
|
|
@@ -51,23 +49,21 @@ export declare const BankTransactionApiAxiosParamCreator: (configuration?: Confi
|
|
|
51
49
|
*/
|
|
52
50
|
linkBankTransaction: (code: string, linkBankTransactionRequestDtoRest: LinkBankTransactionRequestDtoRest, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
53
51
|
/**
|
|
54
|
-
* Returns a list of bank transactions you have previously created.
|
|
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.
|
|
55
53
|
* @summary List bank transactions
|
|
56
54
|
* @param {string} [authorization] Bearer Token
|
|
57
|
-
* @param {
|
|
58
|
-
* @param {
|
|
59
|
-
* @param {
|
|
60
|
-
* @param {
|
|
61
|
-
* @param {
|
|
62
|
-
* @param {'bankAccount' | 'transaction'} [expand] Expand the response with additional entities
|
|
63
|
-
* @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>
|
|
64
60
|
* @param {*} [options] Override http request option.
|
|
65
61
|
* @throws {RequiredError}
|
|
66
62
|
*/
|
|
67
|
-
listBankTransactions: (authorization?: string,
|
|
63
|
+
listBankTransactions: (authorization?: string, filter?: string, filters?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
68
64
|
/**
|
|
69
65
|
* Unlinks an already linked bank transaction
|
|
70
|
-
* @summary Unlink
|
|
66
|
+
* @summary Unlink bank transaction
|
|
71
67
|
* @param {string} code Code of the bank transaction to unlink
|
|
72
68
|
* @param {UnlinkBankTransactionRequestDtoRest} unlinkBankTransactionRequestDtoRest
|
|
73
69
|
* @param {string} [authorization] Bearer Token
|
|
@@ -82,59 +78,57 @@ export declare const BankTransactionApiAxiosParamCreator: (configuration?: Confi
|
|
|
82
78
|
*/
|
|
83
79
|
export declare const BankTransactionApiFp: (configuration?: Configuration) => {
|
|
84
80
|
/**
|
|
85
|
-
* Retrieves the details of the
|
|
86
|
-
* @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
|
|
87
83
|
* @param {string} code
|
|
88
84
|
* @param {string} [authorization] Bearer Token
|
|
89
|
-
* @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>
|
|
90
86
|
* @param {*} [options] Override http request option.
|
|
91
87
|
* @throws {RequiredError}
|
|
92
88
|
*/
|
|
93
|
-
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>>;
|
|
94
90
|
/**
|
|
95
|
-
*
|
|
91
|
+
* This will import bank transactions from a swift MT940 file
|
|
96
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
|
|
97
94
|
* @param {string} [authorization] Bearer Token
|
|
98
|
-
* @param {any} [file]
|
|
99
95
|
* @param {*} [options] Override http request option.
|
|
100
96
|
* @throws {RequiredError}
|
|
101
97
|
*/
|
|
102
|
-
importBankTransactions(
|
|
98
|
+
importBankTransactions(file: any, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
103
99
|
/**
|
|
104
100
|
* Links a bank transaction with an invoice
|
|
105
|
-
* @summary Link
|
|
101
|
+
* @summary Link bank transaction
|
|
106
102
|
* @param {string} code Code of the bank transaction to link
|
|
107
103
|
* @param {LinkBankTransactionRequestDtoRest} linkBankTransactionRequestDtoRest
|
|
108
104
|
* @param {string} [authorization] Bearer Token
|
|
109
105
|
* @param {*} [options] Override http request option.
|
|
110
106
|
* @throws {RequiredError}
|
|
111
107
|
*/
|
|
112
|
-
linkBankTransaction(code: string, linkBankTransactionRequestDtoRest: LinkBankTransactionRequestDtoRest, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
108
|
+
linkBankTransaction(code: string, linkBankTransactionRequestDtoRest: LinkBankTransactionRequestDtoRest, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
113
109
|
/**
|
|
114
|
-
* 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.
|
|
115
111
|
* @summary List bank transactions
|
|
116
112
|
* @param {string} [authorization] Bearer Token
|
|
117
|
-
* @param {
|
|
118
|
-
* @param {
|
|
119
|
-
* @param {
|
|
120
|
-
* @param {
|
|
121
|
-
* @param {
|
|
122
|
-
* @param {'bankAccount' | 'transaction'} [expand] Expand the response with additional entities
|
|
123
|
-
* @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>
|
|
124
118
|
* @param {*} [options] Override http request option.
|
|
125
119
|
* @throws {RequiredError}
|
|
126
120
|
*/
|
|
127
|
-
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>>;
|
|
128
122
|
/**
|
|
129
123
|
* Unlinks an already linked bank transaction
|
|
130
|
-
* @summary Unlink
|
|
124
|
+
* @summary Unlink bank transaction
|
|
131
125
|
* @param {string} code Code of the bank transaction to unlink
|
|
132
126
|
* @param {UnlinkBankTransactionRequestDtoRest} unlinkBankTransactionRequestDtoRest
|
|
133
127
|
* @param {string} [authorization] Bearer Token
|
|
134
128
|
* @param {*} [options] Override http request option.
|
|
135
129
|
* @throws {RequiredError}
|
|
136
130
|
*/
|
|
137
|
-
unlinkBankTransaction(code: string, unlinkBankTransactionRequestDtoRest: UnlinkBankTransactionRequestDtoRest, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
131
|
+
unlinkBankTransaction(code: string, unlinkBankTransactionRequestDtoRest: UnlinkBankTransactionRequestDtoRest, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
138
132
|
};
|
|
139
133
|
/**
|
|
140
134
|
* BankTransactionApi - factory interface
|
|
@@ -142,59 +136,57 @@ export declare const BankTransactionApiFp: (configuration?: Configuration) => {
|
|
|
142
136
|
*/
|
|
143
137
|
export declare const BankTransactionApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
144
138
|
/**
|
|
145
|
-
* Retrieves the details of the
|
|
146
|
-
* @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
|
|
147
141
|
* @param {string} code
|
|
148
142
|
* @param {string} [authorization] Bearer Token
|
|
149
|
-
* @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>
|
|
150
144
|
* @param {*} [options] Override http request option.
|
|
151
145
|
* @throws {RequiredError}
|
|
152
146
|
*/
|
|
153
|
-
getBankTransaction(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<
|
|
147
|
+
getBankTransaction(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<void>;
|
|
154
148
|
/**
|
|
155
|
-
*
|
|
149
|
+
* This will import bank transactions from a swift MT940 file
|
|
156
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
|
|
157
152
|
* @param {string} [authorization] Bearer Token
|
|
158
|
-
* @param {any} [file]
|
|
159
153
|
* @param {*} [options] Override http request option.
|
|
160
154
|
* @throws {RequiredError}
|
|
161
155
|
*/
|
|
162
|
-
importBankTransactions(
|
|
156
|
+
importBankTransactions(file: any, authorization?: string, options?: any): AxiosPromise<void>;
|
|
163
157
|
/**
|
|
164
158
|
* Links a bank transaction with an invoice
|
|
165
|
-
* @summary Link
|
|
159
|
+
* @summary Link bank transaction
|
|
166
160
|
* @param {string} code Code of the bank transaction to link
|
|
167
161
|
* @param {LinkBankTransactionRequestDtoRest} linkBankTransactionRequestDtoRest
|
|
168
162
|
* @param {string} [authorization] Bearer Token
|
|
169
163
|
* @param {*} [options] Override http request option.
|
|
170
164
|
* @throws {RequiredError}
|
|
171
165
|
*/
|
|
172
|
-
linkBankTransaction(code: string, linkBankTransactionRequestDtoRest: LinkBankTransactionRequestDtoRest, authorization?: string, options?: any): AxiosPromise<
|
|
166
|
+
linkBankTransaction(code: string, linkBankTransactionRequestDtoRest: LinkBankTransactionRequestDtoRest, authorization?: string, options?: any): AxiosPromise<void>;
|
|
173
167
|
/**
|
|
174
|
-
* Returns a list of bank transactions you have previously created.
|
|
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.
|
|
175
169
|
* @summary List bank transactions
|
|
176
170
|
* @param {string} [authorization] Bearer Token
|
|
177
|
-
* @param {
|
|
178
|
-
* @param {
|
|
179
|
-
* @param {
|
|
180
|
-
* @param {
|
|
181
|
-
* @param {
|
|
182
|
-
* @param {'bankAccount' | 'transaction'} [expand] Expand the response with additional entities
|
|
183
|
-
* @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>
|
|
184
176
|
* @param {*} [options] Override http request option.
|
|
185
177
|
* @throws {RequiredError}
|
|
186
178
|
*/
|
|
187
|
-
listBankTransactions(authorization?: string,
|
|
179
|
+
listBankTransactions(authorization?: string, filter?: string, filters?: string, search?: string, order?: string, expand?: string, options?: any): AxiosPromise<void>;
|
|
188
180
|
/**
|
|
189
181
|
* Unlinks an already linked bank transaction
|
|
190
|
-
* @summary Unlink
|
|
182
|
+
* @summary Unlink bank transaction
|
|
191
183
|
* @param {string} code Code of the bank transaction to unlink
|
|
192
184
|
* @param {UnlinkBankTransactionRequestDtoRest} unlinkBankTransactionRequestDtoRest
|
|
193
185
|
* @param {string} [authorization] Bearer Token
|
|
194
186
|
* @param {*} [options] Override http request option.
|
|
195
187
|
* @throws {RequiredError}
|
|
196
188
|
*/
|
|
197
|
-
unlinkBankTransaction(code: string, unlinkBankTransactionRequestDtoRest: UnlinkBankTransactionRequestDtoRest, authorization?: string, options?: any): AxiosPromise<
|
|
189
|
+
unlinkBankTransaction(code: string, unlinkBankTransactionRequestDtoRest: UnlinkBankTransactionRequestDtoRest, authorization?: string, options?: any): AxiosPromise<void>;
|
|
198
190
|
};
|
|
199
191
|
/**
|
|
200
192
|
* Request parameters for getBankTransaction operation in BankTransactionApi.
|
|
@@ -215,7 +207,7 @@ export interface BankTransactionApiGetBankTransactionRequest {
|
|
|
215
207
|
*/
|
|
216
208
|
readonly authorization?: string;
|
|
217
209
|
/**
|
|
218
|
-
* 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>
|
|
219
211
|
* @type {string}
|
|
220
212
|
* @memberof BankTransactionApiGetBankTransaction
|
|
221
213
|
*/
|
|
@@ -228,17 +220,17 @@ export interface BankTransactionApiGetBankTransactionRequest {
|
|
|
228
220
|
*/
|
|
229
221
|
export interface BankTransactionApiImportBankTransactionsRequest {
|
|
230
222
|
/**
|
|
231
|
-
*
|
|
232
|
-
* @type {
|
|
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}
|
|
233
225
|
* @memberof BankTransactionApiImportBankTransactions
|
|
234
226
|
*/
|
|
235
|
-
readonly
|
|
227
|
+
readonly file: any;
|
|
236
228
|
/**
|
|
237
|
-
*
|
|
238
|
-
* @type {
|
|
229
|
+
* Bearer Token
|
|
230
|
+
* @type {string}
|
|
239
231
|
* @memberof BankTransactionApiImportBankTransactions
|
|
240
232
|
*/
|
|
241
|
-
readonly
|
|
233
|
+
readonly authorization?: string;
|
|
242
234
|
}
|
|
243
235
|
/**
|
|
244
236
|
* Request parameters for linkBankTransaction operation in BankTransactionApi.
|
|
@@ -278,47 +270,35 @@ export interface BankTransactionApiListBankTransactionsRequest {
|
|
|
278
270
|
*/
|
|
279
271
|
readonly authorization?: string;
|
|
280
272
|
/**
|
|
281
|
-
*
|
|
282
|
-
* @type {
|
|
283
|
-
* @memberof BankTransactionApiListBankTransactions
|
|
284
|
-
*/
|
|
285
|
-
readonly pageSize?: any;
|
|
286
|
-
/**
|
|
287
|
-
* 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.
|
|
288
|
-
* @type {any}
|
|
289
|
-
* @memberof BankTransactionApiListBankTransactions
|
|
290
|
-
*/
|
|
291
|
-
readonly pageToken?: any;
|
|
292
|
-
/**
|
|
293
|
-
* 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>
|
|
294
|
-
* @type {'id' | 'code' | 'bankAccountId' | 'bankAccountNumber' | 'swiftMessageReference' | 'amount' | 'currency' | 'transactionReference' | 'transactionDate' | 'entryDate' | 'isLinked'}
|
|
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}
|
|
295
275
|
* @memberof BankTransactionApiListBankTransactions
|
|
296
276
|
*/
|
|
297
|
-
readonly filter?:
|
|
277
|
+
readonly filter?: string;
|
|
298
278
|
/**
|
|
299
|
-
*
|
|
300
|
-
* @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}
|
|
301
281
|
* @memberof BankTransactionApiListBankTransactions
|
|
302
282
|
*/
|
|
303
|
-
readonly
|
|
283
|
+
readonly filters?: string;
|
|
304
284
|
/**
|
|
305
|
-
*
|
|
306
|
-
* @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}
|
|
307
287
|
* @memberof BankTransactionApiListBankTransactions
|
|
308
288
|
*/
|
|
309
|
-
readonly
|
|
289
|
+
readonly search?: string;
|
|
310
290
|
/**
|
|
311
|
-
*
|
|
312
|
-
* @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}
|
|
313
293
|
* @memberof BankTransactionApiListBankTransactions
|
|
314
294
|
*/
|
|
315
|
-
readonly
|
|
295
|
+
readonly order?: string;
|
|
316
296
|
/**
|
|
317
|
-
*
|
|
318
|
-
* @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}
|
|
319
299
|
* @memberof BankTransactionApiListBankTransactions
|
|
320
300
|
*/
|
|
321
|
-
readonly
|
|
301
|
+
readonly expand?: string;
|
|
322
302
|
}
|
|
323
303
|
/**
|
|
324
304
|
* Request parameters for unlinkBankTransaction operation in BankTransactionApi.
|
|
@@ -353,34 +333,34 @@ export interface BankTransactionApiUnlinkBankTransactionRequest {
|
|
|
353
333
|
*/
|
|
354
334
|
export declare class BankTransactionApi extends BaseAPI {
|
|
355
335
|
/**
|
|
356
|
-
* Retrieves the details of the
|
|
357
|
-
* @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
|
|
358
338
|
* @param {BankTransactionApiGetBankTransactionRequest} requestParameters Request parameters.
|
|
359
339
|
* @param {*} [options] Override http request option.
|
|
360
340
|
* @throws {RequiredError}
|
|
361
341
|
* @memberof BankTransactionApi
|
|
362
342
|
*/
|
|
363
|
-
getBankTransaction(requestParameters: BankTransactionApiGetBankTransactionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
343
|
+
getBankTransaction(requestParameters: BankTransactionApiGetBankTransactionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
364
344
|
/**
|
|
365
|
-
*
|
|
345
|
+
* This will import bank transactions from a swift MT940 file
|
|
366
346
|
* @summary Create the bank transactions
|
|
367
347
|
* @param {BankTransactionApiImportBankTransactionsRequest} requestParameters Request parameters.
|
|
368
348
|
* @param {*} [options] Override http request option.
|
|
369
349
|
* @throws {RequiredError}
|
|
370
350
|
* @memberof BankTransactionApi
|
|
371
351
|
*/
|
|
372
|
-
importBankTransactions(requestParameters
|
|
352
|
+
importBankTransactions(requestParameters: BankTransactionApiImportBankTransactionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
373
353
|
/**
|
|
374
354
|
* Links a bank transaction with an invoice
|
|
375
|
-
* @summary Link
|
|
355
|
+
* @summary Link bank transaction
|
|
376
356
|
* @param {BankTransactionApiLinkBankTransactionRequest} requestParameters Request parameters.
|
|
377
357
|
* @param {*} [options] Override http request option.
|
|
378
358
|
* @throws {RequiredError}
|
|
379
359
|
* @memberof BankTransactionApi
|
|
380
360
|
*/
|
|
381
|
-
linkBankTransaction(requestParameters: BankTransactionApiLinkBankTransactionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
361
|
+
linkBankTransaction(requestParameters: BankTransactionApiLinkBankTransactionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
382
362
|
/**
|
|
383
|
-
* Returns a list of bank transactions you have previously created.
|
|
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.
|
|
384
364
|
* @summary List bank transactions
|
|
385
365
|
* @param {BankTransactionApiListBankTransactionsRequest} requestParameters Request parameters.
|
|
386
366
|
* @param {*} [options] Override http request option.
|
|
@@ -390,11 +370,11 @@ export declare class BankTransactionApi extends BaseAPI {
|
|
|
390
370
|
listBankTransactions(requestParameters?: BankTransactionApiListBankTransactionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
391
371
|
/**
|
|
392
372
|
* Unlinks an already linked bank transaction
|
|
393
|
-
* @summary Unlink
|
|
373
|
+
* @summary Unlink bank transaction
|
|
394
374
|
* @param {BankTransactionApiUnlinkBankTransactionRequest} requestParameters Request parameters.
|
|
395
375
|
* @param {*} [options] Override http request option.
|
|
396
376
|
* @throws {RequiredError}
|
|
397
377
|
* @memberof BankTransactionApi
|
|
398
378
|
*/
|
|
399
|
-
unlinkBankTransaction(requestParameters: BankTransactionApiUnlinkBankTransactionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
379
|
+
unlinkBankTransaction(requestParameters: BankTransactionApiUnlinkBankTransactionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
400
380
|
}
|