@emilgroup/accounting-sdk 1.15.0 → 1.16.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.
Files changed (223) hide show
  1. package/.openapi-generator/FILES +52 -15
  2. package/README.md +2 -2
  3. package/api/health-api.ts +7 -7
  4. package/api/mailbox-api.ts +251 -0
  5. package/api/messages-api.ts +1096 -0
  6. package/api/users-api.ts +492 -0
  7. package/api/vbas-api.ts +588 -0
  8. package/api/vbus-api.ts +697 -0
  9. package/api/zip-codes-api.ts +439 -0
  10. package/api.ts +14 -6
  11. package/base.ts +2 -2
  12. package/common.ts +4 -4
  13. package/configuration.ts +2 -2
  14. package/dist/api/health-api.d.ts +6 -6
  15. package/dist/api/health-api.js +7 -7
  16. package/dist/api/mailbox-api.d.ts +142 -0
  17. package/dist/api/mailbox-api.js +311 -0
  18. package/dist/api/messages-api.d.ts +632 -0
  19. package/dist/api/messages-api.js +912 -0
  20. package/dist/api/users-api.d.ts +275 -0
  21. package/dist/api/users-api.js +508 -0
  22. package/dist/api/vbas-api.d.ts +337 -0
  23. package/dist/api/{financial-accounts-api.js → vbas-api.js} +161 -156
  24. package/dist/api/vbus-api.d.ts +395 -0
  25. package/dist/api/vbus-api.js +643 -0
  26. package/dist/api/zip-codes-api.d.ts +253 -0
  27. package/dist/api/{booking-processes-api.js → zip-codes-api.js} +169 -83
  28. package/dist/api.d.ts +8 -4
  29. package/dist/api.js +8 -4
  30. package/dist/base.d.ts +2 -2
  31. package/dist/base.js +2 -2
  32. package/dist/common.d.ts +4 -4
  33. package/dist/common.js +2 -2
  34. package/dist/configuration.d.ts +2 -2
  35. package/dist/configuration.js +2 -2
  36. package/dist/index.d.ts +2 -2
  37. package/dist/index.js +2 -2
  38. package/dist/models/address-class.d.ts +48 -0
  39. package/dist/models/{get-financial-account-response-class.js → address-class.js} +2 -2
  40. package/dist/models/create-mailbox-request-dto.d.ts +36 -0
  41. package/dist/models/{create-booking-process-response-class.js → create-mailbox-request-dto.js} +2 -2
  42. package/dist/models/create-user-request-dto.d.ts +76 -0
  43. package/dist/models/{financial-account-class.js → create-user-request-dto.js} +10 -9
  44. package/dist/models/create-user-response-class.d.ts +25 -0
  45. package/dist/models/{financial-transaction-class.js → create-user-response-class.js} +2 -2
  46. package/dist/models/create-vba-request-dto.d.ts +41 -0
  47. package/dist/models/create-vba-request-dto.js +20 -0
  48. package/dist/models/create-vba-response-class.d.ts +24 -0
  49. package/dist/models/{create-financial-account-response-class.js → create-vba-response-class.js} +2 -2
  50. package/dist/models/create-vbu-request-dto.d.ts +41 -0
  51. package/dist/models/create-vbu-request-dto.js +20 -0
  52. package/dist/models/create-vbu-response-class.d.ts +24 -0
  53. package/dist/models/create-vbu-response-class.js +15 -0
  54. package/dist/models/create-vbuv-request-dto.d.ts +41 -0
  55. package/dist/models/create-vbuv-request-dto.js +20 -0
  56. package/dist/models/create-vbuv-response-class.d.ts +24 -0
  57. package/dist/models/create-vbuv-response-class.js +15 -0
  58. package/dist/models/get-request-message-response-class.d.ts +25 -0
  59. package/dist/models/get-request-message-response-class.js +15 -0
  60. package/dist/models/get-response-message-response-class.d.ts +25 -0
  61. package/dist/models/get-response-message-response-class.js +15 -0
  62. package/dist/models/get-user-response-class.d.ts +25 -0
  63. package/dist/models/get-user-response-class.js +15 -0
  64. package/dist/models/get-vba-response-class.d.ts +25 -0
  65. package/dist/models/get-vba-response-class.js +15 -0
  66. package/dist/models/get-vbu-response-class.d.ts +25 -0
  67. package/dist/models/get-vbu-response-class.js +15 -0
  68. package/dist/models/get-zip-code-response-class.d.ts +25 -0
  69. package/dist/models/get-zip-code-response-class.js +15 -0
  70. package/dist/models/index.d.ts +46 -13
  71. package/dist/models/index.js +46 -13
  72. package/dist/models/inline-response200.d.ts +2 -2
  73. package/dist/models/inline-response200.js +2 -2
  74. package/dist/models/inline-response503.d.ts +2 -2
  75. package/dist/models/inline-response503.js +2 -2
  76. package/dist/models/list-all-messages-response-class.d.ts +31 -0
  77. package/dist/models/list-all-messages-response-class.js +15 -0
  78. package/dist/models/list-requests-messages-response-class.d.ts +31 -0
  79. package/dist/models/list-requests-messages-response-class.js +15 -0
  80. package/dist/models/list-responses-messages-response-class.d.ts +31 -0
  81. package/dist/models/list-responses-messages-response-class.js +15 -0
  82. package/dist/models/list-users-response-class.d.ts +31 -0
  83. package/dist/models/list-users-response-class.js +15 -0
  84. package/dist/models/list-vbas-response-class.d.ts +31 -0
  85. package/dist/models/list-vbas-response-class.js +15 -0
  86. package/dist/models/list-vbus-response-class.d.ts +31 -0
  87. package/dist/models/list-vbus-response-class.js +15 -0
  88. package/dist/models/list-zip-codes-response-class.d.ts +31 -0
  89. package/dist/models/list-zip-codes-response-class.js +15 -0
  90. package/dist/models/message-class.d.ts +90 -0
  91. package/dist/models/message-class.js +15 -0
  92. package/dist/models/request-details-class.d.ts +48 -0
  93. package/dist/models/request-details-class.js +15 -0
  94. package/dist/models/request-message-class.d.ts +127 -0
  95. package/dist/models/request-message-class.js +15 -0
  96. package/dist/models/response-details-class.d.ts +42 -0
  97. package/dist/models/response-details-class.js +15 -0
  98. package/dist/models/response-message-class.d.ts +139 -0
  99. package/dist/models/response-message-class.js +15 -0
  100. package/dist/models/store-zip-codes-request-dto.d.ts +25 -0
  101. package/dist/models/store-zip-codes-request-dto.js +15 -0
  102. package/dist/models/store-zip-codes-response-class.d.ts +25 -0
  103. package/dist/models/store-zip-codes-response-class.js +15 -0
  104. package/dist/models/update-request-message-request-dto.d.ts +36 -0
  105. package/dist/models/update-request-message-request-dto.js +15 -0
  106. package/dist/models/update-request-message-response-class.d.ts +25 -0
  107. package/dist/models/update-request-message-response-class.js +15 -0
  108. package/dist/models/update-response-message-request-dto.d.ts +36 -0
  109. package/dist/models/update-response-message-request-dto.js +15 -0
  110. package/dist/models/update-response-message-response-class.d.ts +25 -0
  111. package/dist/models/update-response-message-response-class.js +15 -0
  112. package/dist/models/update-user-request-dto.d.ts +82 -0
  113. package/dist/models/{financial-transaction-data-dto.js → update-user-request-dto.js} +10 -6
  114. package/dist/models/update-user-response-class.d.ts +25 -0
  115. package/dist/models/update-user-response-class.js +15 -0
  116. package/dist/models/update-vba-request-dto.d.ts +30 -0
  117. package/dist/models/update-vba-request-dto.js +15 -0
  118. package/dist/models/update-vbu-request-dto.d.ts +30 -0
  119. package/dist/models/update-vbu-request-dto.js +15 -0
  120. package/dist/models/update-vbu-response-class.d.ts +25 -0
  121. package/dist/models/update-vbu-response-class.js +15 -0
  122. package/dist/models/user-class.d.ts +107 -0
  123. package/dist/models/user-class.js +20 -0
  124. package/dist/models/vba-class.d.ts +116 -0
  125. package/dist/models/vba-class.js +15 -0
  126. package/dist/models/vba-response-class.d.ts +48 -0
  127. package/dist/models/vba-response-class.js +15 -0
  128. package/dist/models/vbu-class.d.ts +115 -0
  129. package/dist/models/vbu-class.js +15 -0
  130. package/dist/models/vbu-response-class.d.ts +48 -0
  131. package/dist/models/vbu-response-class.js +15 -0
  132. package/dist/models/xlsx-zip-code-dto.d.ts +30 -0
  133. package/dist/models/xlsx-zip-code-dto.js +15 -0
  134. package/dist/models/zip-code-class.d.ts +60 -0
  135. package/dist/models/zip-code-class.js +15 -0
  136. package/index.ts +2 -2
  137. package/models/address-class.ts +54 -0
  138. package/models/create-mailbox-request-dto.ts +42 -0
  139. package/models/create-user-request-dto.ts +86 -0
  140. package/models/create-user-response-class.ts +31 -0
  141. package/models/create-vba-request-dto.ts +50 -0
  142. package/models/create-vba-response-class.ts +30 -0
  143. package/models/create-vbu-request-dto.ts +50 -0
  144. package/models/create-vbu-response-class.ts +30 -0
  145. package/models/create-vbuv-request-dto.ts +50 -0
  146. package/models/create-vbuv-response-class.ts +30 -0
  147. package/models/get-request-message-response-class.ts +31 -0
  148. package/models/get-response-message-response-class.ts +31 -0
  149. package/models/get-user-response-class.ts +31 -0
  150. package/models/get-vba-response-class.ts +31 -0
  151. package/models/get-vbu-response-class.ts +31 -0
  152. package/models/get-zip-code-response-class.ts +31 -0
  153. package/models/index.ts +46 -13
  154. package/models/inline-response200.ts +2 -2
  155. package/models/inline-response503.ts +2 -2
  156. package/models/list-all-messages-response-class.ts +37 -0
  157. package/models/list-requests-messages-response-class.ts +37 -0
  158. package/models/list-responses-messages-response-class.ts +37 -0
  159. package/models/list-users-response-class.ts +37 -0
  160. package/models/list-vbas-response-class.ts +37 -0
  161. package/models/list-vbus-response-class.ts +37 -0
  162. package/models/list-zip-codes-response-class.ts +37 -0
  163. package/models/message-class.ts +96 -0
  164. package/models/request-details-class.ts +54 -0
  165. package/models/request-message-class.ts +133 -0
  166. package/models/response-details-class.ts +48 -0
  167. package/models/response-message-class.ts +145 -0
  168. package/models/store-zip-codes-request-dto.ts +31 -0
  169. package/models/store-zip-codes-response-class.ts +31 -0
  170. package/models/update-request-message-request-dto.ts +42 -0
  171. package/models/update-request-message-response-class.ts +31 -0
  172. package/models/update-response-message-request-dto.ts +42 -0
  173. package/models/update-response-message-response-class.ts +31 -0
  174. package/models/update-user-request-dto.ts +92 -0
  175. package/models/update-user-response-class.ts +31 -0
  176. package/models/update-vba-request-dto.ts +36 -0
  177. package/models/update-vbu-request-dto.ts +36 -0
  178. package/models/update-vbu-response-class.ts +31 -0
  179. package/models/user-class.ts +116 -0
  180. package/models/vba-class.ts +122 -0
  181. package/models/vba-response-class.ts +54 -0
  182. package/models/vbu-class.ts +121 -0
  183. package/models/vbu-response-class.ts +54 -0
  184. package/models/xlsx-zip-code-dto.ts +36 -0
  185. package/models/zip-code-class.ts +66 -0
  186. package/package.json +1 -1
  187. package/api/booking-processes-api.ts +0 -353
  188. package/api/financial-accounts-api.ts +0 -573
  189. package/dist/api/booking-processes-api.d.ts +0 -207
  190. package/dist/api/financial-accounts-api.d.ts +0 -327
  191. package/dist/models/booking-entry-class.d.ts +0 -123
  192. package/dist/models/booking-entry-class.js +0 -34
  193. package/dist/models/booking-process-class.d.ts +0 -94
  194. package/dist/models/booking-process-class.js +0 -29
  195. package/dist/models/create-booking-entry-request-dto.d.ts +0 -99
  196. package/dist/models/create-booking-entry-request-dto.js +0 -34
  197. package/dist/models/create-booking-process-request-dto.d.ts +0 -64
  198. package/dist/models/create-booking-process-request-dto.js +0 -29
  199. package/dist/models/create-booking-process-response-class.d.ts +0 -25
  200. package/dist/models/create-financial-account-request-dto.d.ts +0 -62
  201. package/dist/models/create-financial-account-request-dto.js +0 -23
  202. package/dist/models/create-financial-account-response-class.d.ts +0 -25
  203. package/dist/models/financial-account-class.d.ts +0 -98
  204. package/dist/models/financial-transaction-class.d.ts +0 -108
  205. package/dist/models/financial-transaction-data-dto.d.ts +0 -71
  206. package/dist/models/get-financial-account-response-class.d.ts +0 -25
  207. package/dist/models/list-booking-process-response-class.d.ts +0 -31
  208. package/dist/models/list-booking-process-response-class.js +0 -15
  209. package/dist/models/list-financial-accounts-response-class.d.ts +0 -31
  210. package/dist/models/list-financial-accounts-response-class.js +0 -15
  211. package/models/booking-entry-class.ts +0 -133
  212. package/models/booking-process-class.ts +0 -104
  213. package/models/create-booking-entry-request-dto.ts +0 -109
  214. package/models/create-booking-process-request-dto.ts +0 -74
  215. package/models/create-booking-process-response-class.ts +0 -31
  216. package/models/create-financial-account-request-dto.ts +0 -71
  217. package/models/create-financial-account-response-class.ts +0 -31
  218. package/models/financial-account-class.ts +0 -107
  219. package/models/financial-transaction-class.ts +0 -114
  220. package/models/financial-transaction-data-dto.ts +0 -80
  221. package/models/get-financial-account-response-class.ts +0 -31
  222. package/models/list-booking-process-response-class.ts +0 -37
  223. package/models/list-financial-accounts-response-class.ts +0 -37
@@ -1,573 +0,0 @@
1
- /* tslint:disable */
2
- /* eslint-disable */
3
- /**
4
- * EMIL AccountingService
5
- * The EMIL AccountingService API description
6
- *
7
- * The version of the OpenAPI document: 1.0
8
- * Contact: kontakt@emil.de
9
- *
10
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
- * https://openapi-generator.tech
12
- * Do not edit the class manually.
13
- */
14
-
15
-
16
- import globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
17
- import { Configuration } from '../configuration';
18
- // Some imports not used depending on template conditions
19
- // @ts-ignore
20
- import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
21
- // @ts-ignore
22
- import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
23
- // @ts-ignore
24
- import { CreateFinancialAccountRequestDto } from '../models';
25
- // @ts-ignore
26
- import { CreateFinancialAccountResponseClass } from '../models';
27
- // @ts-ignore
28
- import { GetFinancialAccountResponseClass } from '../models';
29
- // @ts-ignore
30
- import { ListFinancialAccountsResponseClass } from '../models';
31
- /**
32
- * FinancialAccountsApi - axios parameter creator
33
- * @export
34
- */
35
- export const FinancialAccountsApiAxiosParamCreator = function (configuration?: Configuration) {
36
- return {
37
- /**
38
- * This will create an financial account in the database. The financial account will be created with the provided name, type, and account number. Optionally, you can provide a parent financial account ID to create a sub-account.
39
- * @summary Create the Financial Account
40
- * @param {CreateFinancialAccountRequestDto} createFinancialAccountRequestDto
41
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
42
- * @param {*} [options] Override http request option.
43
- * @throws {RequiredError}
44
- */
45
- createFinancialAccount: async (createFinancialAccountRequestDto: CreateFinancialAccountRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
46
- // verify required parameter 'createFinancialAccountRequestDto' is not null or undefined
47
- assertParamExists('createFinancialAccount', 'createFinancialAccountRequestDto', createFinancialAccountRequestDto)
48
- const localVarPath = `/accountingservice/v1/financial-accounts`;
49
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
50
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
51
- let baseOptions;
52
- let baseAccessToken;
53
- if (configuration) {
54
- baseOptions = configuration.baseOptions;
55
- baseAccessToken = configuration.accessToken;
56
- }
57
-
58
- const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
59
- const localVarHeaderParameter = {} as any;
60
- const localVarQueryParameter = {} as any;
61
-
62
- // authentication bearer required
63
- // http bearer authentication required
64
- await setBearerAuthToObject(localVarHeaderParameter, configuration)
65
-
66
- if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
67
- localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
68
- }
69
-
70
-
71
-
72
- localVarHeaderParameter['Content-Type'] = 'application/json';
73
-
74
- setSearchParams(localVarUrlObj, localVarQueryParameter);
75
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
76
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
77
- localVarRequestOptions.data = serializeDataIfNeeded(createFinancialAccountRequestDto, localVarRequestOptions, configuration)
78
-
79
- return {
80
- url: toPathString(localVarUrlObj),
81
- options: localVarRequestOptions,
82
- };
83
- },
84
- /**
85
- * Permanently deletes the Financial Account. Supply the unique code that was returned when you created the Financial Account and this will delete it.
86
- * @summary Delete the Financial Account
87
- * @param {string} code Unique identifier for the object.
88
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
89
- * @param {*} [options] Override http request option.
90
- * @throws {RequiredError}
91
- */
92
- deleteFinancialAccount: async (code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
93
- // verify required parameter 'code' is not null or undefined
94
- assertParamExists('deleteFinancialAccount', 'code', code)
95
- const localVarPath = `/accountingservice/v1/financial-accounts/{code}`
96
- .replace(`{${"code"}}`, encodeURIComponent(String(code)));
97
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
98
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
99
- let baseOptions;
100
- let baseAccessToken;
101
- if (configuration) {
102
- baseOptions = configuration.baseOptions;
103
- baseAccessToken = configuration.accessToken;
104
- }
105
-
106
- const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
107
- const localVarHeaderParameter = {} as any;
108
- const localVarQueryParameter = {} as any;
109
-
110
- // authentication bearer required
111
- // http bearer authentication required
112
- await setBearerAuthToObject(localVarHeaderParameter, configuration)
113
-
114
- if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
115
- localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
116
- }
117
-
118
-
119
-
120
- setSearchParams(localVarUrlObj, localVarQueryParameter);
121
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
122
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
123
-
124
- return {
125
- url: toPathString(localVarUrlObj),
126
- options: localVarRequestOptions,
127
- };
128
- },
129
- /**
130
- * Retrieves the details of the Financial Account that was previously created. Supply the unique Financial Account code that was returned when you created it and Emil Api will return the corresponding Financial Account information.
131
- * @summary Retrieve the Financial Account
132
- * @param {string} code Unique identifier for the object.
133
- * @param {string} expand
134
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
135
- * @param {*} [options] Override http request option.
136
- * @throws {RequiredError}
137
- */
138
- getFinancialAccount: async (code: string, expand: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
139
- // verify required parameter 'code' is not null or undefined
140
- assertParamExists('getFinancialAccount', 'code', code)
141
- // verify required parameter 'expand' is not null or undefined
142
- assertParamExists('getFinancialAccount', 'expand', expand)
143
- const localVarPath = `/accountingservice/v1/financial-accounts/{code}`
144
- .replace(`{${"code"}}`, encodeURIComponent(String(code)));
145
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
146
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
147
- let baseOptions;
148
- let baseAccessToken;
149
- if (configuration) {
150
- baseOptions = configuration.baseOptions;
151
- baseAccessToken = configuration.accessToken;
152
- }
153
-
154
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
155
- const localVarHeaderParameter = {} as any;
156
- const localVarQueryParameter = {} as any;
157
-
158
- // authentication bearer required
159
- // http bearer authentication required
160
- await setBearerAuthToObject(localVarHeaderParameter, configuration)
161
-
162
- if (expand !== undefined) {
163
- localVarQueryParameter['expand'] = expand;
164
- }
165
-
166
- if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
167
- localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
168
- }
169
-
170
-
171
-
172
- setSearchParams(localVarUrlObj, localVarQueryParameter);
173
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
174
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
175
-
176
- return {
177
- url: toPathString(localVarUrlObj),
178
- options: localVarRequestOptions,
179
- };
180
- },
181
- /**
182
- * Returns a list of Financial Accounts you have previously created. The Financial Accounts are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
183
- * @summary List Financial Accounts
184
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
185
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
186
- * @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
187
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, name, financialAccountNumber, createdAt, entityCode, type&lt;/i&gt;
188
- * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
189
- * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt, name, financialAccountNumber&lt;/i&gt;
190
- * @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.&lt;br/&gt; &lt;br/&gt;
191
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, name, financialAccountNumber, createdAt, entityCode, type&lt;/i&gt;
192
- * @param {*} [options] Override http request option.
193
- * @throws {RequiredError}
194
- */
195
- listFinancialAccounts: async (authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
196
- const localVarPath = `/accountingservice/v1/financial-accounts`;
197
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
198
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
199
- let baseOptions;
200
- let baseAccessToken;
201
- if (configuration) {
202
- baseOptions = configuration.baseOptions;
203
- baseAccessToken = configuration.accessToken;
204
- }
205
-
206
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
207
- const localVarHeaderParameter = {} as any;
208
- const localVarQueryParameter = {} as any;
209
-
210
- // authentication bearer required
211
- // http bearer authentication required
212
- await setBearerAuthToObject(localVarHeaderParameter, configuration)
213
-
214
- if (pageSize !== undefined) {
215
- localVarQueryParameter['pageSize'] = pageSize;
216
- }
217
-
218
- if (pageToken !== undefined) {
219
- localVarQueryParameter['pageToken'] = pageToken;
220
- }
221
-
222
- if (filter !== undefined) {
223
- localVarQueryParameter['filter'] = filter;
224
- }
225
-
226
- if (search !== undefined) {
227
- localVarQueryParameter['search'] = search;
228
- }
229
-
230
- if (order !== undefined) {
231
- localVarQueryParameter['order'] = order;
232
- }
233
-
234
- if (expand !== undefined) {
235
- localVarQueryParameter['expand'] = expand;
236
- }
237
-
238
- if (filters !== undefined) {
239
- localVarQueryParameter['filters'] = filters;
240
- }
241
-
242
- if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
243
- localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
244
- }
245
-
246
-
247
-
248
- setSearchParams(localVarUrlObj, localVarQueryParameter);
249
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
250
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
251
-
252
- return {
253
- url: toPathString(localVarUrlObj),
254
- options: localVarRequestOptions,
255
- };
256
- },
257
- }
258
- };
259
-
260
- /**
261
- * FinancialAccountsApi - functional programming interface
262
- * @export
263
- */
264
- export const FinancialAccountsApiFp = function(configuration?: Configuration) {
265
- const localVarAxiosParamCreator = FinancialAccountsApiAxiosParamCreator(configuration)
266
- return {
267
- /**
268
- * This will create an financial account in the database. The financial account will be created with the provided name, type, and account number. Optionally, you can provide a parent financial account ID to create a sub-account.
269
- * @summary Create the Financial Account
270
- * @param {CreateFinancialAccountRequestDto} createFinancialAccountRequestDto
271
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
272
- * @param {*} [options] Override http request option.
273
- * @throws {RequiredError}
274
- */
275
- async createFinancialAccount(createFinancialAccountRequestDto: CreateFinancialAccountRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateFinancialAccountResponseClass>> {
276
- const localVarAxiosArgs = await localVarAxiosParamCreator.createFinancialAccount(createFinancialAccountRequestDto, authorization, options);
277
- return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
278
- },
279
- /**
280
- * Permanently deletes the Financial Account. Supply the unique code that was returned when you created the Financial Account and this will delete it.
281
- * @summary Delete the Financial Account
282
- * @param {string} code Unique identifier for the object.
283
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
284
- * @param {*} [options] Override http request option.
285
- * @throws {RequiredError}
286
- */
287
- async deleteFinancialAccount(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
288
- const localVarAxiosArgs = await localVarAxiosParamCreator.deleteFinancialAccount(code, authorization, options);
289
- return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
290
- },
291
- /**
292
- * Retrieves the details of the Financial Account that was previously created. Supply the unique Financial Account code that was returned when you created it and Emil Api will return the corresponding Financial Account information.
293
- * @summary Retrieve the Financial Account
294
- * @param {string} code Unique identifier for the object.
295
- * @param {string} expand
296
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
297
- * @param {*} [options] Override http request option.
298
- * @throws {RequiredError}
299
- */
300
- async getFinancialAccount(code: string, expand: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetFinancialAccountResponseClass>> {
301
- const localVarAxiosArgs = await localVarAxiosParamCreator.getFinancialAccount(code, expand, authorization, options);
302
- return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
303
- },
304
- /**
305
- * Returns a list of Financial Accounts you have previously created. The Financial Accounts are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
306
- * @summary List Financial Accounts
307
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
308
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
309
- * @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
310
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, name, financialAccountNumber, createdAt, entityCode, type&lt;/i&gt;
311
- * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
312
- * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt, name, financialAccountNumber&lt;/i&gt;
313
- * @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.&lt;br/&gt; &lt;br/&gt;
314
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, name, financialAccountNumber, createdAt, entityCode, type&lt;/i&gt;
315
- * @param {*} [options] Override http request option.
316
- * @throws {RequiredError}
317
- */
318
- async listFinancialAccounts(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListFinancialAccountsResponseClass>> {
319
- const localVarAxiosArgs = await localVarAxiosParamCreator.listFinancialAccounts(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
320
- return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
321
- },
322
- }
323
- };
324
-
325
- /**
326
- * FinancialAccountsApi - factory interface
327
- * @export
328
- */
329
- export const FinancialAccountsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
330
- const localVarFp = FinancialAccountsApiFp(configuration)
331
- return {
332
- /**
333
- * This will create an financial account in the database. The financial account will be created with the provided name, type, and account number. Optionally, you can provide a parent financial account ID to create a sub-account.
334
- * @summary Create the Financial Account
335
- * @param {CreateFinancialAccountRequestDto} createFinancialAccountRequestDto
336
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
337
- * @param {*} [options] Override http request option.
338
- * @throws {RequiredError}
339
- */
340
- createFinancialAccount(createFinancialAccountRequestDto: CreateFinancialAccountRequestDto, authorization?: string, options?: any): AxiosPromise<CreateFinancialAccountResponseClass> {
341
- return localVarFp.createFinancialAccount(createFinancialAccountRequestDto, authorization, options).then((request) => request(axios, basePath));
342
- },
343
- /**
344
- * Permanently deletes the Financial Account. Supply the unique code that was returned when you created the Financial Account and this will delete it.
345
- * @summary Delete the Financial Account
346
- * @param {string} code Unique identifier for the object.
347
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
348
- * @param {*} [options] Override http request option.
349
- * @throws {RequiredError}
350
- */
351
- deleteFinancialAccount(code: string, authorization?: string, options?: any): AxiosPromise<void> {
352
- return localVarFp.deleteFinancialAccount(code, authorization, options).then((request) => request(axios, basePath));
353
- },
354
- /**
355
- * Retrieves the details of the Financial Account that was previously created. Supply the unique Financial Account code that was returned when you created it and Emil Api will return the corresponding Financial Account information.
356
- * @summary Retrieve the Financial Account
357
- * @param {string} code Unique identifier for the object.
358
- * @param {string} expand
359
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
360
- * @param {*} [options] Override http request option.
361
- * @throws {RequiredError}
362
- */
363
- getFinancialAccount(code: string, expand: string, authorization?: string, options?: any): AxiosPromise<GetFinancialAccountResponseClass> {
364
- return localVarFp.getFinancialAccount(code, expand, authorization, options).then((request) => request(axios, basePath));
365
- },
366
- /**
367
- * Returns a list of Financial Accounts you have previously created. The Financial Accounts are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
368
- * @summary List Financial Accounts
369
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
370
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
371
- * @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
372
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, name, financialAccountNumber, createdAt, entityCode, type&lt;/i&gt;
373
- * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
374
- * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt, name, financialAccountNumber&lt;/i&gt;
375
- * @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.&lt;br/&gt; &lt;br/&gt;
376
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, name, financialAccountNumber, createdAt, entityCode, type&lt;/i&gt;
377
- * @param {*} [options] Override http request option.
378
- * @throws {RequiredError}
379
- */
380
- listFinancialAccounts(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListFinancialAccountsResponseClass> {
381
- return localVarFp.listFinancialAccounts(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
382
- },
383
- };
384
- };
385
-
386
- /**
387
- * Request parameters for createFinancialAccount operation in FinancialAccountsApi.
388
- * @export
389
- * @interface FinancialAccountsApiCreateFinancialAccountRequest
390
- */
391
- export interface FinancialAccountsApiCreateFinancialAccountRequest {
392
- /**
393
- *
394
- * @type {CreateFinancialAccountRequestDto}
395
- * @memberof FinancialAccountsApiCreateFinancialAccount
396
- */
397
- readonly createFinancialAccountRequestDto: CreateFinancialAccountRequestDto
398
-
399
- /**
400
- * Bearer Token: provided by the login endpoint under the name accessToken.
401
- * @type {string}
402
- * @memberof FinancialAccountsApiCreateFinancialAccount
403
- */
404
- readonly authorization?: string
405
- }
406
-
407
- /**
408
- * Request parameters for deleteFinancialAccount operation in FinancialAccountsApi.
409
- * @export
410
- * @interface FinancialAccountsApiDeleteFinancialAccountRequest
411
- */
412
- export interface FinancialAccountsApiDeleteFinancialAccountRequest {
413
- /**
414
- * Unique identifier for the object.
415
- * @type {string}
416
- * @memberof FinancialAccountsApiDeleteFinancialAccount
417
- */
418
- readonly code: string
419
-
420
- /**
421
- * Bearer Token: provided by the login endpoint under the name accessToken.
422
- * @type {string}
423
- * @memberof FinancialAccountsApiDeleteFinancialAccount
424
- */
425
- readonly authorization?: string
426
- }
427
-
428
- /**
429
- * Request parameters for getFinancialAccount operation in FinancialAccountsApi.
430
- * @export
431
- * @interface FinancialAccountsApiGetFinancialAccountRequest
432
- */
433
- export interface FinancialAccountsApiGetFinancialAccountRequest {
434
- /**
435
- * Unique identifier for the object.
436
- * @type {string}
437
- * @memberof FinancialAccountsApiGetFinancialAccount
438
- */
439
- readonly code: string
440
-
441
- /**
442
- *
443
- * @type {string}
444
- * @memberof FinancialAccountsApiGetFinancialAccount
445
- */
446
- readonly expand: string
447
-
448
- /**
449
- * Bearer Token: provided by the login endpoint under the name accessToken.
450
- * @type {string}
451
- * @memberof FinancialAccountsApiGetFinancialAccount
452
- */
453
- readonly authorization?: string
454
- }
455
-
456
- /**
457
- * Request parameters for listFinancialAccounts operation in FinancialAccountsApi.
458
- * @export
459
- * @interface FinancialAccountsApiListFinancialAccountsRequest
460
- */
461
- export interface FinancialAccountsApiListFinancialAccountsRequest {
462
- /**
463
- * Bearer Token: provided by the login endpoint under the name accessToken.
464
- * @type {string}
465
- * @memberof FinancialAccountsApiListFinancialAccounts
466
- */
467
- readonly authorization?: string
468
-
469
- /**
470
- * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
471
- * @type {any}
472
- * @memberof FinancialAccountsApiListFinancialAccounts
473
- */
474
- readonly pageSize?: any
475
-
476
- /**
477
- * 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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
478
- * @type {any}
479
- * @memberof FinancialAccountsApiListFinancialAccounts
480
- */
481
- readonly pageToken?: any
482
-
483
- /**
484
- * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, name, financialAccountNumber, createdAt, entityCode, type&lt;/i&gt;
485
- * @type {string}
486
- * @memberof FinancialAccountsApiListFinancialAccounts
487
- */
488
- readonly filter?: string
489
-
490
- /**
491
- * To search the list by any field, pass search&#x3D;xxx to fetch the result.
492
- * @type {any}
493
- * @memberof FinancialAccountsApiListFinancialAccounts
494
- */
495
- readonly search?: any
496
-
497
- /**
498
- * Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt, name, financialAccountNumber&lt;/i&gt;
499
- * @type {string}
500
- * @memberof FinancialAccountsApiListFinancialAccounts
501
- */
502
- readonly order?: string
503
-
504
- /**
505
- * 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.&lt;br/&gt; &lt;br/&gt;
506
- * @type {string}
507
- * @memberof FinancialAccountsApiListFinancialAccounts
508
- */
509
- readonly expand?: string
510
-
511
- /**
512
- * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, name, financialAccountNumber, createdAt, entityCode, type&lt;/i&gt;
513
- * @type {string}
514
- * @memberof FinancialAccountsApiListFinancialAccounts
515
- */
516
- readonly filters?: string
517
- }
518
-
519
- /**
520
- * FinancialAccountsApi - object-oriented interface
521
- * @export
522
- * @class FinancialAccountsApi
523
- * @extends {BaseAPI}
524
- */
525
- export class FinancialAccountsApi extends BaseAPI {
526
- /**
527
- * This will create an financial account in the database. The financial account will be created with the provided name, type, and account number. Optionally, you can provide a parent financial account ID to create a sub-account.
528
- * @summary Create the Financial Account
529
- * @param {FinancialAccountsApiCreateFinancialAccountRequest} requestParameters Request parameters.
530
- * @param {*} [options] Override http request option.
531
- * @throws {RequiredError}
532
- * @memberof FinancialAccountsApi
533
- */
534
- public createFinancialAccount(requestParameters: FinancialAccountsApiCreateFinancialAccountRequest, options?: AxiosRequestConfig) {
535
- return FinancialAccountsApiFp(this.configuration).createFinancialAccount(requestParameters.createFinancialAccountRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
536
- }
537
-
538
- /**
539
- * Permanently deletes the Financial Account. Supply the unique code that was returned when you created the Financial Account and this will delete it.
540
- * @summary Delete the Financial Account
541
- * @param {FinancialAccountsApiDeleteFinancialAccountRequest} requestParameters Request parameters.
542
- * @param {*} [options] Override http request option.
543
- * @throws {RequiredError}
544
- * @memberof FinancialAccountsApi
545
- */
546
- public deleteFinancialAccount(requestParameters: FinancialAccountsApiDeleteFinancialAccountRequest, options?: AxiosRequestConfig) {
547
- return FinancialAccountsApiFp(this.configuration).deleteFinancialAccount(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
548
- }
549
-
550
- /**
551
- * Retrieves the details of the Financial Account that was previously created. Supply the unique Financial Account code that was returned when you created it and Emil Api will return the corresponding Financial Account information.
552
- * @summary Retrieve the Financial Account
553
- * @param {FinancialAccountsApiGetFinancialAccountRequest} requestParameters Request parameters.
554
- * @param {*} [options] Override http request option.
555
- * @throws {RequiredError}
556
- * @memberof FinancialAccountsApi
557
- */
558
- public getFinancialAccount(requestParameters: FinancialAccountsApiGetFinancialAccountRequest, options?: AxiosRequestConfig) {
559
- return FinancialAccountsApiFp(this.configuration).getFinancialAccount(requestParameters.code, requestParameters.expand, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
560
- }
561
-
562
- /**
563
- * Returns a list of Financial Accounts you have previously created. The Financial Accounts are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
564
- * @summary List Financial Accounts
565
- * @param {FinancialAccountsApiListFinancialAccountsRequest} requestParameters Request parameters.
566
- * @param {*} [options] Override http request option.
567
- * @throws {RequiredError}
568
- * @memberof FinancialAccountsApi
569
- */
570
- public listFinancialAccounts(requestParameters: FinancialAccountsApiListFinancialAccountsRequest = {}, options?: AxiosRequestConfig) {
571
- return FinancialAccountsApiFp(this.configuration).listFinancialAccounts(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
572
- }
573
- }