@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
|
|
@@ -13,7 +13,10 @@ import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
|
13
13
|
import { Configuration } from '../configuration';
|
|
14
14
|
import { RequestArgs, BaseAPI } from '../base';
|
|
15
15
|
import { CreateTenantBankAccountRequestDto } from '../models';
|
|
16
|
+
import { CreateTenantBankAccountResponseClass } from '../models';
|
|
16
17
|
import { GetTenantBankAccountResponseClass } from '../models';
|
|
18
|
+
import { ListTenantBankAccountResponseClass } from '../models';
|
|
19
|
+
import { UpdateTenantBankAccountResponseClass } from '../models';
|
|
17
20
|
import { UpdateTenantBankAccountRestRequestDto } from '../models';
|
|
18
21
|
/**
|
|
19
22
|
* TenantBankAccountApi - axios parameter creator
|
|
@@ -21,7 +24,8 @@ import { UpdateTenantBankAccountRestRequestDto } from '../models';
|
|
|
21
24
|
*/
|
|
22
25
|
export declare const TenantBankAccountApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
23
26
|
/**
|
|
24
|
-
*
|
|
27
|
+
* This will create a new tenant bank account
|
|
28
|
+
* @summary Create the tenant bank account
|
|
25
29
|
* @param {CreateTenantBankAccountRequestDto} createTenantBankAccountRequestDto
|
|
26
30
|
* @param {string} [authorization] Bearer Token
|
|
27
31
|
* @param {*} [options] Override http request option.
|
|
@@ -29,7 +33,8 @@ export declare const TenantBankAccountApiAxiosParamCreator: (configuration?: Con
|
|
|
29
33
|
*/
|
|
30
34
|
createTenantBankAccount: (createTenantBankAccountRequestDto: CreateTenantBankAccountRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
31
35
|
/**
|
|
32
|
-
*
|
|
36
|
+
* Deletes a tenant bank account by code
|
|
37
|
+
* @summary Delete the tenant bank account
|
|
33
38
|
* @param {string} code Unique identifier for the object.
|
|
34
39
|
* @param {string} [authorization] Bearer Token
|
|
35
40
|
* @param {*} [options] Override http request option.
|
|
@@ -37,30 +42,31 @@ export declare const TenantBankAccountApiAxiosParamCreator: (configuration?: Con
|
|
|
37
42
|
*/
|
|
38
43
|
deleteTenantBankAccount: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
39
44
|
/**
|
|
40
|
-
*
|
|
41
|
-
* @
|
|
45
|
+
* Retrieves the details of the tenant bank account that was previously created. Supply the unique tenant bank account code that was returned when you created it and Emil Api will return the corresponding tenant bank account information.
|
|
46
|
+
* @summary Retrieve the tenant bank account
|
|
47
|
+
* @param {string} code
|
|
42
48
|
* @param {string} [authorization] Bearer Token
|
|
43
|
-
* @param {string} [expand] Expand the
|
|
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: bankTransactions<i>
|
|
44
50
|
* @param {*} [options] Override http request option.
|
|
45
51
|
* @throws {RequiredError}
|
|
46
52
|
*/
|
|
47
53
|
getTenantBankAccount: (code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
48
54
|
/**
|
|
49
|
-
*
|
|
55
|
+
* Returns a list of tenant bank accounts you have previously created. The tenant bank accounts are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
56
|
+
* @summary List tenant bank accounts
|
|
50
57
|
* @param {string} [authorization] Bearer Token
|
|
51
|
-
* @param {
|
|
52
|
-
* @param {
|
|
53
|
-
* @param {
|
|
54
|
-
* @param {
|
|
55
|
-
* @param {
|
|
56
|
-
* @param {string} [expand] Expand the response with additional entities
|
|
57
|
-
* @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.
|
|
58
|
+
* @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, iban, bankName, accountName</i>
|
|
59
|
+
* @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, iban, bankName, accountName</i>
|
|
60
|
+
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: id, iban, bankName, accountName</i>
|
|
61
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt</i>
|
|
62
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: bankTransactions<i>
|
|
58
63
|
* @param {*} [options] Override http request option.
|
|
59
64
|
* @throws {RequiredError}
|
|
60
65
|
*/
|
|
61
|
-
listTenantBankAccounts: (authorization?: string,
|
|
66
|
+
listTenantBankAccounts: (authorization?: string, filter?: string, filters?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
62
67
|
/**
|
|
63
|
-
*
|
|
68
|
+
* Update a tenant bank account by code
|
|
69
|
+
* @summary Update the tenant bank account
|
|
64
70
|
* @param {string} code Unique identifier for the object.
|
|
65
71
|
* @param {UpdateTenantBankAccountRestRequestDto} updateTenantBankAccountRestRequestDto
|
|
66
72
|
* @param {string} [authorization] Bearer Token
|
|
@@ -75,53 +81,56 @@ export declare const TenantBankAccountApiAxiosParamCreator: (configuration?: Con
|
|
|
75
81
|
*/
|
|
76
82
|
export declare const TenantBankAccountApiFp: (configuration?: Configuration) => {
|
|
77
83
|
/**
|
|
78
|
-
*
|
|
84
|
+
* This will create a new tenant bank account
|
|
85
|
+
* @summary Create the tenant bank account
|
|
79
86
|
* @param {CreateTenantBankAccountRequestDto} createTenantBankAccountRequestDto
|
|
80
87
|
* @param {string} [authorization] Bearer Token
|
|
81
88
|
* @param {*} [options] Override http request option.
|
|
82
89
|
* @throws {RequiredError}
|
|
83
90
|
*/
|
|
84
|
-
createTenantBankAccount(createTenantBankAccountRequestDto: CreateTenantBankAccountRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
91
|
+
createTenantBankAccount(createTenantBankAccountRequestDto: CreateTenantBankAccountRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateTenantBankAccountResponseClass>>;
|
|
85
92
|
/**
|
|
86
|
-
*
|
|
93
|
+
* Deletes a tenant bank account by code
|
|
94
|
+
* @summary Delete the tenant bank account
|
|
87
95
|
* @param {string} code Unique identifier for the object.
|
|
88
96
|
* @param {string} [authorization] Bearer Token
|
|
89
97
|
* @param {*} [options] Override http request option.
|
|
90
98
|
* @throws {RequiredError}
|
|
91
99
|
*/
|
|
92
|
-
deleteTenantBankAccount(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
100
|
+
deleteTenantBankAccount(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
93
101
|
/**
|
|
94
|
-
*
|
|
95
|
-
* @
|
|
102
|
+
* Retrieves the details of the tenant bank account that was previously created. Supply the unique tenant bank account code that was returned when you created it and Emil Api will return the corresponding tenant bank account information.
|
|
103
|
+
* @summary Retrieve the tenant bank account
|
|
104
|
+
* @param {string} code
|
|
96
105
|
* @param {string} [authorization] Bearer Token
|
|
97
|
-
* @param {string} [expand] Expand the
|
|
106
|
+
* @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: bankTransactions<i>
|
|
98
107
|
* @param {*} [options] Override http request option.
|
|
99
108
|
* @throws {RequiredError}
|
|
100
109
|
*/
|
|
101
110
|
getTenantBankAccount(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetTenantBankAccountResponseClass>>;
|
|
102
111
|
/**
|
|
103
|
-
*
|
|
112
|
+
* Returns a list of tenant bank accounts you have previously created. The tenant bank accounts are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
113
|
+
* @summary List tenant bank accounts
|
|
104
114
|
* @param {string} [authorization] Bearer Token
|
|
105
|
-
* @param {
|
|
106
|
-
* @param {
|
|
107
|
-
* @param {
|
|
108
|
-
* @param {
|
|
109
|
-
* @param {
|
|
110
|
-
* @param {string} [expand] Expand the response with additional entities
|
|
111
|
-
* @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.
|
|
115
|
+
* @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, iban, bankName, accountName</i>
|
|
116
|
+
* @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, iban, bankName, accountName</i>
|
|
117
|
+
* @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, iban, bankName, accountName</i>
|
|
118
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt</i>
|
|
119
|
+
* @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: bankTransactions<i>
|
|
112
120
|
* @param {*} [options] Override http request option.
|
|
113
121
|
* @throws {RequiredError}
|
|
114
122
|
*/
|
|
115
|
-
listTenantBankAccounts(authorization?: string,
|
|
123
|
+
listTenantBankAccounts(authorization?: string, filter?: string, filters?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListTenantBankAccountResponseClass>>;
|
|
116
124
|
/**
|
|
117
|
-
*
|
|
125
|
+
* Update a tenant bank account by code
|
|
126
|
+
* @summary Update the tenant bank account
|
|
118
127
|
* @param {string} code Unique identifier for the object.
|
|
119
128
|
* @param {UpdateTenantBankAccountRestRequestDto} updateTenantBankAccountRestRequestDto
|
|
120
129
|
* @param {string} [authorization] Bearer Token
|
|
121
130
|
* @param {*} [options] Override http request option.
|
|
122
131
|
* @throws {RequiredError}
|
|
123
132
|
*/
|
|
124
|
-
updateTenantBankAccount(code: string, updateTenantBankAccountRestRequestDto: UpdateTenantBankAccountRestRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
133
|
+
updateTenantBankAccount(code: string, updateTenantBankAccountRestRequestDto: UpdateTenantBankAccountRestRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateTenantBankAccountResponseClass>>;
|
|
125
134
|
};
|
|
126
135
|
/**
|
|
127
136
|
* TenantBankAccountApi - factory interface
|
|
@@ -129,53 +138,56 @@ export declare const TenantBankAccountApiFp: (configuration?: Configuration) =>
|
|
|
129
138
|
*/
|
|
130
139
|
export declare const TenantBankAccountApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
131
140
|
/**
|
|
132
|
-
*
|
|
141
|
+
* This will create a new tenant bank account
|
|
142
|
+
* @summary Create the tenant bank account
|
|
133
143
|
* @param {CreateTenantBankAccountRequestDto} createTenantBankAccountRequestDto
|
|
134
144
|
* @param {string} [authorization] Bearer Token
|
|
135
145
|
* @param {*} [options] Override http request option.
|
|
136
146
|
* @throws {RequiredError}
|
|
137
147
|
*/
|
|
138
|
-
createTenantBankAccount(createTenantBankAccountRequestDto: CreateTenantBankAccountRequestDto, authorization?: string, options?: any): AxiosPromise<
|
|
148
|
+
createTenantBankAccount(createTenantBankAccountRequestDto: CreateTenantBankAccountRequestDto, authorization?: string, options?: any): AxiosPromise<CreateTenantBankAccountResponseClass>;
|
|
139
149
|
/**
|
|
140
|
-
*
|
|
150
|
+
* Deletes a tenant bank account by code
|
|
151
|
+
* @summary Delete the tenant bank account
|
|
141
152
|
* @param {string} code Unique identifier for the object.
|
|
142
153
|
* @param {string} [authorization] Bearer Token
|
|
143
154
|
* @param {*} [options] Override http request option.
|
|
144
155
|
* @throws {RequiredError}
|
|
145
156
|
*/
|
|
146
|
-
deleteTenantBankAccount(code: string, authorization?: string, options?: any): AxiosPromise<
|
|
157
|
+
deleteTenantBankAccount(code: string, authorization?: string, options?: any): AxiosPromise<object>;
|
|
147
158
|
/**
|
|
148
|
-
*
|
|
149
|
-
* @
|
|
159
|
+
* Retrieves the details of the tenant bank account that was previously created. Supply the unique tenant bank account code that was returned when you created it and Emil Api will return the corresponding tenant bank account information.
|
|
160
|
+
* @summary Retrieve the tenant bank account
|
|
161
|
+
* @param {string} code
|
|
150
162
|
* @param {string} [authorization] Bearer Token
|
|
151
|
-
* @param {string} [expand] Expand the
|
|
163
|
+
* @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: bankTransactions<i>
|
|
152
164
|
* @param {*} [options] Override http request option.
|
|
153
165
|
* @throws {RequiredError}
|
|
154
166
|
*/
|
|
155
167
|
getTenantBankAccount(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetTenantBankAccountResponseClass>;
|
|
156
168
|
/**
|
|
157
|
-
*
|
|
169
|
+
* Returns a list of tenant bank accounts you have previously created. The tenant bank accounts are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
170
|
+
* @summary List tenant bank accounts
|
|
158
171
|
* @param {string} [authorization] Bearer Token
|
|
159
|
-
* @param {
|
|
160
|
-
* @param {
|
|
161
|
-
* @param {
|
|
162
|
-
* @param {
|
|
163
|
-
* @param {
|
|
164
|
-
* @param {string} [expand] Expand the response with additional entities
|
|
165
|
-
* @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.
|
|
172
|
+
* @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, iban, bankName, accountName</i>
|
|
173
|
+
* @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, iban, bankName, accountName</i>
|
|
174
|
+
* @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, iban, bankName, accountName</i>
|
|
175
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt</i>
|
|
176
|
+
* @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: bankTransactions<i>
|
|
166
177
|
* @param {*} [options] Override http request option.
|
|
167
178
|
* @throws {RequiredError}
|
|
168
179
|
*/
|
|
169
|
-
listTenantBankAccounts(authorization?: string,
|
|
180
|
+
listTenantBankAccounts(authorization?: string, filter?: string, filters?: string, search?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListTenantBankAccountResponseClass>;
|
|
170
181
|
/**
|
|
171
|
-
*
|
|
182
|
+
* Update a tenant bank account by code
|
|
183
|
+
* @summary Update the tenant bank account
|
|
172
184
|
* @param {string} code Unique identifier for the object.
|
|
173
185
|
* @param {UpdateTenantBankAccountRestRequestDto} updateTenantBankAccountRestRequestDto
|
|
174
186
|
* @param {string} [authorization] Bearer Token
|
|
175
187
|
* @param {*} [options] Override http request option.
|
|
176
188
|
* @throws {RequiredError}
|
|
177
189
|
*/
|
|
178
|
-
updateTenantBankAccount(code: string, updateTenantBankAccountRestRequestDto: UpdateTenantBankAccountRestRequestDto, authorization?: string, options?: any): AxiosPromise<
|
|
190
|
+
updateTenantBankAccount(code: string, updateTenantBankAccountRestRequestDto: UpdateTenantBankAccountRestRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateTenantBankAccountResponseClass>;
|
|
179
191
|
};
|
|
180
192
|
/**
|
|
181
193
|
* Request parameters for createTenantBankAccount operation in TenantBankAccountApi.
|
|
@@ -222,7 +234,7 @@ export interface TenantBankAccountApiDeleteTenantBankAccountRequest {
|
|
|
222
234
|
*/
|
|
223
235
|
export interface TenantBankAccountApiGetTenantBankAccountRequest {
|
|
224
236
|
/**
|
|
225
|
-
*
|
|
237
|
+
*
|
|
226
238
|
* @type {string}
|
|
227
239
|
* @memberof TenantBankAccountApiGetTenantBankAccount
|
|
228
240
|
*/
|
|
@@ -234,7 +246,7 @@ export interface TenantBankAccountApiGetTenantBankAccountRequest {
|
|
|
234
246
|
*/
|
|
235
247
|
readonly authorization?: string;
|
|
236
248
|
/**
|
|
237
|
-
* Expand the
|
|
249
|
+
* 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: bankTransactions<i>
|
|
238
250
|
* @type {string}
|
|
239
251
|
* @memberof TenantBankAccountApiGetTenantBankAccount
|
|
240
252
|
*/
|
|
@@ -253,47 +265,35 @@ export interface TenantBankAccountApiListTenantBankAccountsRequest {
|
|
|
253
265
|
*/
|
|
254
266
|
readonly authorization?: string;
|
|
255
267
|
/**
|
|
256
|
-
*
|
|
257
|
-
* @type {
|
|
258
|
-
* @memberof TenantBankAccountApiListTenantBankAccounts
|
|
259
|
-
*/
|
|
260
|
-
readonly pageSize?: any;
|
|
261
|
-
/**
|
|
262
|
-
* 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.
|
|
263
|
-
* @type {any}
|
|
268
|
+
* 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, iban, bankName, accountName</i>
|
|
269
|
+
* @type {string}
|
|
264
270
|
* @memberof TenantBankAccountApiListTenantBankAccounts
|
|
265
271
|
*/
|
|
266
|
-
readonly
|
|
272
|
+
readonly filter?: string;
|
|
267
273
|
/**
|
|
268
|
-
*
|
|
269
|
-
* @type {
|
|
274
|
+
* 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, iban, bankName, accountName</i>
|
|
275
|
+
* @type {string}
|
|
270
276
|
* @memberof TenantBankAccountApiListTenantBankAccounts
|
|
271
277
|
*/
|
|
272
|
-
readonly
|
|
278
|
+
readonly filters?: string;
|
|
273
279
|
/**
|
|
274
|
-
* Search the
|
|
275
|
-
* @type {
|
|
280
|
+
* Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: id, iban, bankName, accountName</i>
|
|
281
|
+
* @type {string}
|
|
276
282
|
* @memberof TenantBankAccountApiListTenantBankAccounts
|
|
277
283
|
*/
|
|
278
|
-
readonly search?:
|
|
284
|
+
readonly search?: string;
|
|
279
285
|
/**
|
|
280
|
-
*
|
|
281
|
-
* @type {
|
|
286
|
+
* Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt</i>
|
|
287
|
+
* @type {string}
|
|
282
288
|
* @memberof TenantBankAccountApiListTenantBankAccounts
|
|
283
289
|
*/
|
|
284
|
-
readonly order?:
|
|
290
|
+
readonly order?: string;
|
|
285
291
|
/**
|
|
286
|
-
* Expand the
|
|
292
|
+
* 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: bankTransactions<i>
|
|
287
293
|
* @type {string}
|
|
288
294
|
* @memberof TenantBankAccountApiListTenantBankAccounts
|
|
289
295
|
*/
|
|
290
296
|
readonly expand?: string;
|
|
291
|
-
/**
|
|
292
|
-
* 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.
|
|
293
|
-
* @type {any}
|
|
294
|
-
* @memberof TenantBankAccountApiListTenantBankAccounts
|
|
295
|
-
*/
|
|
296
|
-
readonly filters?: any;
|
|
297
297
|
}
|
|
298
298
|
/**
|
|
299
299
|
* Request parameters for updateTenantBankAccount operation in TenantBankAccountApi.
|
|
@@ -328,23 +328,26 @@ export interface TenantBankAccountApiUpdateTenantBankAccountRequest {
|
|
|
328
328
|
*/
|
|
329
329
|
export declare class TenantBankAccountApi extends BaseAPI {
|
|
330
330
|
/**
|
|
331
|
-
*
|
|
331
|
+
* This will create a new tenant bank account
|
|
332
|
+
* @summary Create the tenant bank account
|
|
332
333
|
* @param {TenantBankAccountApiCreateTenantBankAccountRequest} requestParameters Request parameters.
|
|
333
334
|
* @param {*} [options] Override http request option.
|
|
334
335
|
* @throws {RequiredError}
|
|
335
336
|
* @memberof TenantBankAccountApi
|
|
336
337
|
*/
|
|
337
|
-
createTenantBankAccount(requestParameters: TenantBankAccountApiCreateTenantBankAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
338
|
+
createTenantBankAccount(requestParameters: TenantBankAccountApiCreateTenantBankAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateTenantBankAccountResponseClass, any>>;
|
|
338
339
|
/**
|
|
339
|
-
*
|
|
340
|
+
* Deletes a tenant bank account by code
|
|
341
|
+
* @summary Delete the tenant bank account
|
|
340
342
|
* @param {TenantBankAccountApiDeleteTenantBankAccountRequest} requestParameters Request parameters.
|
|
341
343
|
* @param {*} [options] Override http request option.
|
|
342
344
|
* @throws {RequiredError}
|
|
343
345
|
* @memberof TenantBankAccountApi
|
|
344
346
|
*/
|
|
345
|
-
deleteTenantBankAccount(requestParameters: TenantBankAccountApiDeleteTenantBankAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
347
|
+
deleteTenantBankAccount(requestParameters: TenantBankAccountApiDeleteTenantBankAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
346
348
|
/**
|
|
347
|
-
*
|
|
349
|
+
* Retrieves the details of the tenant bank account that was previously created. Supply the unique tenant bank account code that was returned when you created it and Emil Api will return the corresponding tenant bank account information.
|
|
350
|
+
* @summary Retrieve the tenant bank account
|
|
348
351
|
* @param {TenantBankAccountApiGetTenantBankAccountRequest} requestParameters Request parameters.
|
|
349
352
|
* @param {*} [options] Override http request option.
|
|
350
353
|
* @throws {RequiredError}
|
|
@@ -352,19 +355,21 @@ export declare class TenantBankAccountApi extends BaseAPI {
|
|
|
352
355
|
*/
|
|
353
356
|
getTenantBankAccount(requestParameters: TenantBankAccountApiGetTenantBankAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetTenantBankAccountResponseClass, any>>;
|
|
354
357
|
/**
|
|
355
|
-
*
|
|
358
|
+
* Returns a list of tenant bank accounts you have previously created. The tenant bank accounts are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
359
|
+
* @summary List tenant bank accounts
|
|
356
360
|
* @param {TenantBankAccountApiListTenantBankAccountsRequest} requestParameters Request parameters.
|
|
357
361
|
* @param {*} [options] Override http request option.
|
|
358
362
|
* @throws {RequiredError}
|
|
359
363
|
* @memberof TenantBankAccountApi
|
|
360
364
|
*/
|
|
361
|
-
listTenantBankAccounts(requestParameters?: TenantBankAccountApiListTenantBankAccountsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
365
|
+
listTenantBankAccounts(requestParameters?: TenantBankAccountApiListTenantBankAccountsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListTenantBankAccountResponseClass, any>>;
|
|
362
366
|
/**
|
|
363
|
-
*
|
|
367
|
+
* Update a tenant bank account by code
|
|
368
|
+
* @summary Update the tenant bank account
|
|
364
369
|
* @param {TenantBankAccountApiUpdateTenantBankAccountRequest} requestParameters Request parameters.
|
|
365
370
|
* @param {*} [options] Override http request option.
|
|
366
371
|
* @throws {RequiredError}
|
|
367
372
|
* @memberof TenantBankAccountApi
|
|
368
373
|
*/
|
|
369
|
-
updateTenantBankAccount(requestParameters: TenantBankAccountApiUpdateTenantBankAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
374
|
+
updateTenantBankAccount(requestParameters: TenantBankAccountApiUpdateTenantBankAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateTenantBankAccountResponseClass, any>>;
|
|
370
375
|
}
|