@emilgroup/billing-sdk-node 1.4.0 → 1.4.1

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 (250) hide show
  1. package/.openapi-generator/FILES +26 -52
  2. package/README.md +2 -2
  3. package/api/correction-invoices-api.ts +183 -0
  4. package/api/estimated-invoices-api.ts +276 -0
  5. package/api/initial-invoices-api.ts +183 -0
  6. package/api/invoices-api.ts +410 -0
  7. package/api/recurring-invoices-api.ts +183 -0
  8. package/api.ts +12 -12
  9. package/base.ts +2 -2
  10. package/common.ts +4 -4
  11. package/configuration.ts +2 -2
  12. package/dist/api/correction-invoices-api.d.ts +106 -0
  13. package/dist/api/correction-invoices-api.js +234 -0
  14. package/dist/api/estimated-invoices-api.d.ts +154 -0
  15. package/dist/api/estimated-invoices-api.js +321 -0
  16. package/dist/api/initial-invoices-api.d.ts +106 -0
  17. package/dist/api/initial-invoices-api.js +234 -0
  18. package/dist/api/invoices-api.d.ts +242 -0
  19. package/dist/api/{documents-api.js → invoices-api.js} +105 -167
  20. package/dist/api/recurring-invoices-api.d.ts +106 -0
  21. package/dist/api/{notifications-api.js → recurring-invoices-api.js} +51 -45
  22. package/dist/api.d.ts +7 -7
  23. package/dist/api.js +7 -7
  24. package/dist/base.d.ts +2 -2
  25. package/dist/base.js +2 -2
  26. package/dist/common.d.ts +4 -4
  27. package/dist/common.js +2 -2
  28. package/dist/configuration.d.ts +2 -2
  29. package/dist/configuration.js +2 -2
  30. package/dist/index.d.ts +2 -2
  31. package/dist/index.js +2 -2
  32. package/dist/models/create-correction-invoices-response-class.d.ts +25 -0
  33. package/dist/models/{complete-braintree-payment-setup-request-dto.js → create-correction-invoices-response-class.js} +2 -2
  34. package/dist/models/create-custom-estimated-invoice-request-dto.d.ts +35 -0
  35. package/dist/models/{create-custom-application-request-dto.js → create-custom-estimated-invoice-request-dto.js} +4 -4
  36. package/dist/models/create-custom-estimated-invoice-response-class.d.ts +24 -0
  37. package/dist/models/{complete-payment-setup-request-dto.js → create-custom-estimated-invoice-response-class.js} +2 -2
  38. package/dist/models/create-estimated-invoice-request-dto.d.ts +8 -32
  39. package/dist/models/create-estimated-invoice-request-dto.js +2 -7
  40. package/dist/models/create-estimated-invoice-response-class.d.ts +6 -6
  41. package/dist/models/create-estimated-invoice-response-class.js +2 -2
  42. package/dist/models/create-invoice-request-dto.d.ts +77 -0
  43. package/dist/models/{premium-override-dto.js → create-invoice-request-dto.js} +12 -12
  44. package/dist/models/create-invoice-response-class.d.ts +25 -0
  45. package/dist/models/{complete-stripe-payment-setup-request-dto.js → create-invoice-response-class.js} +2 -2
  46. package/dist/models/create-invoice-status-request-dto.d.ts +35 -0
  47. package/dist/models/create-invoice-status-request-dto.js +20 -0
  48. package/dist/models/create-termination-invoice-request-dto.d.ts +48 -0
  49. package/dist/models/{complete-payment-setup-response-class.js → create-termination-invoice-request-dto.js} +2 -2
  50. package/dist/models/currency-class.d.ts +48 -0
  51. package/dist/models/currency-class.js +15 -0
  52. package/dist/models/index.d.ts +21 -47
  53. package/dist/models/index.js +21 -47
  54. package/dist/models/invoice-class.d.ts +38 -15
  55. package/dist/models/invoice-class.js +17 -2
  56. package/dist/models/invoice-item-class.d.ts +18 -9
  57. package/dist/models/invoice-item-class.js +11 -2
  58. package/dist/models/invoice-status-class.d.ts +9 -4
  59. package/dist/models/invoice-status-class.js +7 -2
  60. package/dist/models/list-invoices-response-class.d.ts +31 -0
  61. package/dist/models/list-invoices-response-class.js +15 -0
  62. package/dist/models/list-policies-billing-dates-response-class.d.ts +31 -0
  63. package/dist/models/list-policies-billing-dates-response-class.js +15 -0
  64. package/dist/models/list-request-dto.d.ts +54 -0
  65. package/dist/models/list-request-dto.js +15 -0
  66. package/dist/models/omit-type-class.d.ts +144 -0
  67. package/dist/models/omit-type-class.js +30 -0
  68. package/dist/models/policy-billing-date-class.d.ts +42 -0
  69. package/dist/models/policy-billing-date-class.js +15 -0
  70. package/dist/models/policy-dto.d.ts +122 -0
  71. package/dist/models/{lead-account-class.js → policy-dto.js} +8 -8
  72. package/dist/models/{lead-policy-object-class.d.ts → policy-object-dto.d.ts} +18 -6
  73. package/dist/models/policy-object-dto.js +15 -0
  74. package/dist/models/policy-premium-dto.d.ts +43 -0
  75. package/dist/models/policy-premium-dto.js +15 -0
  76. package/dist/models/policy-premium-item-dto.d.ts +55 -0
  77. package/dist/models/policy-premium-item-dto.js +15 -0
  78. package/dist/models/policy-version-dto.d.ts +55 -0
  79. package/dist/models/policy-version-dto.js +15 -0
  80. package/dist/models/{premium-formula-class.d.ts → premium-formula-dto.d.ts} +17 -17
  81. package/dist/models/premium-formula-dto.js +15 -0
  82. package/dist/models/{send-notification-response-class.d.ts → revert-invoice-request-dto.d.ts} +6 -6
  83. package/dist/models/revert-invoice-request-dto.js +15 -0
  84. package/dist/models/{product-factor-class.d.ts → timeslice-dto.d.ts} +23 -21
  85. package/dist/models/timeslice-dto.js +15 -0
  86. package/index.ts +2 -2
  87. package/models/create-correction-invoices-response-class.ts +31 -0
  88. package/models/create-custom-estimated-invoice-request-dto.ts +44 -0
  89. package/models/{create-custom-application-response-class.ts → create-custom-estimated-invoice-response-class.ts} +7 -7
  90. package/models/create-estimated-invoice-request-dto.ts +8 -35
  91. package/models/create-estimated-invoice-response-class.ts +6 -6
  92. package/models/create-invoice-request-dto.ts +86 -0
  93. package/models/{get-lead-response-class.ts → create-invoice-response-class.ts} +9 -9
  94. package/models/create-invoice-status-request-dto.ts +44 -0
  95. package/models/create-termination-invoice-request-dto.ts +54 -0
  96. package/models/currency-class.ts +54 -0
  97. package/models/index.ts +21 -47
  98. package/models/invoice-class.ts +42 -15
  99. package/models/invoice-item-class.ts +21 -9
  100. package/models/invoice-status-class.ts +12 -4
  101. package/models/{list-products-response-class.ts → list-invoices-response-class.ts} +10 -10
  102. package/models/list-policies-billing-dates-response-class.ts +37 -0
  103. package/models/list-request-dto.ts +60 -0
  104. package/models/omit-type-class.ts +154 -0
  105. package/models/policy-billing-date-class.ts +48 -0
  106. package/models/policy-dto.ts +131 -0
  107. package/models/{lead-policy-object-class.ts → policy-object-dto.ts} +18 -6
  108. package/models/policy-premium-dto.ts +49 -0
  109. package/models/policy-premium-item-dto.ts +61 -0
  110. package/models/policy-version-dto.ts +61 -0
  111. package/models/{premium-formula-class.ts → premium-formula-dto.ts} +17 -17
  112. package/models/{send-notification-response-class.ts → revert-invoice-request-dto.ts} +6 -6
  113. package/models/{product-factor-class.ts → timeslice-dto.ts} +23 -21
  114. package/package.json +1 -1
  115. package/api/documents-api.ts +0 -442
  116. package/api/leads-api.ts +0 -482
  117. package/api/notifications-api.ts +0 -169
  118. package/api/payments-setup-api.ts +0 -408
  119. package/api/products-api.ts +0 -891
  120. package/dist/api/documents-api.d.ts +0 -252
  121. package/dist/api/leads-api.d.ts +0 -266
  122. package/dist/api/leads-api.js +0 -506
  123. package/dist/api/notifications-api.d.ts +0 -97
  124. package/dist/api/payments-setup-api.d.ts +0 -228
  125. package/dist/api/payments-setup-api.js +0 -426
  126. package/dist/api/products-api.d.ts +0 -497
  127. package/dist/api/products-api.js +0 -827
  128. package/dist/models/complete-braintree-payment-setup-request-dto.d.ts +0 -48
  129. package/dist/models/complete-payment-setup-request-dto.d.ts +0 -32
  130. package/dist/models/complete-payment-setup-response-class.d.ts +0 -25
  131. package/dist/models/complete-stripe-payment-setup-request-dto.d.ts +0 -60
  132. package/dist/models/create-account-request-dto.d.ts +0 -132
  133. package/dist/models/create-account-request-dto.js +0 -31
  134. package/dist/models/create-bank-account-request-dto.d.ts +0 -30
  135. package/dist/models/create-bank-account-request-dto.js +0 -15
  136. package/dist/models/create-custom-application-request-dto.d.ts +0 -35
  137. package/dist/models/create-custom-application-response-class.d.ts +0 -24
  138. package/dist/models/create-custom-application-response-class.js +0 -15
  139. package/dist/models/create-document-request-dto.d.ts +0 -101
  140. package/dist/models/create-document-request-dto.js +0 -31
  141. package/dist/models/create-lead-request-dto.d.ts +0 -83
  142. package/dist/models/create-lead-request-dto.js +0 -15
  143. package/dist/models/create-lead-response-class.d.ts +0 -25
  144. package/dist/models/create-lead-response-class.js +0 -15
  145. package/dist/models/document-class.d.ts +0 -130
  146. package/dist/models/document-class.js +0 -41
  147. package/dist/models/get-custom-css-response-class.d.ts +0 -24
  148. package/dist/models/get-custom-css-response-class.js +0 -15
  149. package/dist/models/get-lead-response-class.d.ts +0 -25
  150. package/dist/models/get-lead-response-class.js +0 -15
  151. package/dist/models/get-public-psp-settings-response-class.d.ts +0 -30
  152. package/dist/models/get-public-psp-settings-response-class.js +0 -15
  153. package/dist/models/initiate-braintree-payment-setup-request-dto.d.ts +0 -30
  154. package/dist/models/initiate-braintree-payment-setup-request-dto.js +0 -15
  155. package/dist/models/initiate-braintree-payment-setup-response-class.d.ts +0 -24
  156. package/dist/models/initiate-braintree-payment-setup-response-class.js +0 -15
  157. package/dist/models/initiate-lead-response-class.d.ts +0 -24
  158. package/dist/models/initiate-lead-response-class.js +0 -15
  159. package/dist/models/initiate-payment-setup-request-dto.d.ts +0 -32
  160. package/dist/models/initiate-payment-setup-request-dto.js +0 -15
  161. package/dist/models/initiate-payment-setup-response-class.d.ts +0 -32
  162. package/dist/models/initiate-payment-setup-response-class.js +0 -15
  163. package/dist/models/initiate-stripe-payment-setup-request-dto.d.ts +0 -30
  164. package/dist/models/initiate-stripe-payment-setup-request-dto.js +0 -15
  165. package/dist/models/initiate-stripe-payment-setup-response-class.d.ts +0 -30
  166. package/dist/models/initiate-stripe-payment-setup-response-class.js +0 -15
  167. package/dist/models/insured-object-class.d.ts +0 -67
  168. package/dist/models/insured-object-class.js +0 -15
  169. package/dist/models/insured-object-type-class.d.ts +0 -48
  170. package/dist/models/insured-object-type-class.js +0 -15
  171. package/dist/models/lead-account-class.d.ts +0 -109
  172. package/dist/models/lead-bank-account-class.d.ts +0 -30
  173. package/dist/models/lead-bank-account-class.js +0 -15
  174. package/dist/models/lead-class.d.ts +0 -96
  175. package/dist/models/lead-class.js +0 -15
  176. package/dist/models/lead-policy-class.d.ts +0 -43
  177. package/dist/models/lead-policy-class.js +0 -15
  178. package/dist/models/lead-policy-object-class.js +0 -15
  179. package/dist/models/list-documents-response-class.d.ts +0 -31
  180. package/dist/models/list-documents-response-class.js +0 -15
  181. package/dist/models/list-products-response-class.d.ts +0 -31
  182. package/dist/models/list-products-response-class.js +0 -15
  183. package/dist/models/payment-method-class.d.ts +0 -60
  184. package/dist/models/payment-method-class.js +0 -15
  185. package/dist/models/policy-object-request-dto.d.ts +0 -30
  186. package/dist/models/policy-object-request-dto.js +0 -15
  187. package/dist/models/policy-premium-class.d.ts +0 -55
  188. package/dist/models/policy-premium-class.js +0 -15
  189. package/dist/models/policy-premium-item-class.d.ts +0 -73
  190. package/dist/models/policy-premium-item-class.js +0 -15
  191. package/dist/models/premium-formula-class.js +0 -15
  192. package/dist/models/premium-override-dto.d.ts +0 -54
  193. package/dist/models/premium-override-request-dto.d.ts +0 -25
  194. package/dist/models/premium-override-request-dto.js +0 -15
  195. package/dist/models/product-class.d.ts +0 -74
  196. package/dist/models/product-class.js +0 -15
  197. package/dist/models/product-factor-class.js +0 -15
  198. package/dist/models/product-field-class.d.ts +0 -132
  199. package/dist/models/product-field-class.js +0 -15
  200. package/dist/models/product-version-class.d.ts +0 -61
  201. package/dist/models/product-version-class.js +0 -22
  202. package/dist/models/send-notification-request-dto.d.ts +0 -36
  203. package/dist/models/send-notification-request-dto.js +0 -15
  204. package/dist/models/send-notification-response-class.js +0 -15
  205. package/dist/models/update-lead-request-dto.d.ts +0 -83
  206. package/dist/models/update-lead-request-dto.js +0 -15
  207. package/dist/models/update-lead-response-class.d.ts +0 -25
  208. package/dist/models/update-lead-response-class.js +0 -15
  209. package/dist/models/uploaded-document-dto.d.ts +0 -24
  210. package/dist/models/uploaded-document-dto.js +0 -15
  211. package/models/complete-braintree-payment-setup-request-dto.ts +0 -54
  212. package/models/complete-payment-setup-request-dto.ts +0 -38
  213. package/models/complete-payment-setup-response-class.ts +0 -31
  214. package/models/complete-stripe-payment-setup-request-dto.ts +0 -66
  215. package/models/create-account-request-dto.ts +0 -143
  216. package/models/create-bank-account-request-dto.ts +0 -36
  217. package/models/create-custom-application-request-dto.ts +0 -44
  218. package/models/create-document-request-dto.ts +0 -111
  219. package/models/create-lead-request-dto.ts +0 -89
  220. package/models/create-lead-response-class.ts +0 -31
  221. package/models/document-class.ts +0 -141
  222. package/models/get-custom-css-response-class.ts +0 -30
  223. package/models/get-public-psp-settings-response-class.ts +0 -36
  224. package/models/initiate-braintree-payment-setup-request-dto.ts +0 -36
  225. package/models/initiate-braintree-payment-setup-response-class.ts +0 -30
  226. package/models/initiate-lead-response-class.ts +0 -30
  227. package/models/initiate-payment-setup-request-dto.ts +0 -38
  228. package/models/initiate-payment-setup-response-class.ts +0 -38
  229. package/models/initiate-stripe-payment-setup-request-dto.ts +0 -36
  230. package/models/initiate-stripe-payment-setup-response-class.ts +0 -36
  231. package/models/insured-object-class.ts +0 -73
  232. package/models/insured-object-type-class.ts +0 -54
  233. package/models/lead-account-class.ts +0 -118
  234. package/models/lead-bank-account-class.ts +0 -36
  235. package/models/lead-class.ts +0 -102
  236. package/models/lead-policy-class.ts +0 -49
  237. package/models/list-documents-response-class.ts +0 -37
  238. package/models/payment-method-class.ts +0 -66
  239. package/models/policy-object-request-dto.ts +0 -36
  240. package/models/policy-premium-class.ts +0 -61
  241. package/models/policy-premium-item-class.ts +0 -79
  242. package/models/premium-override-dto.ts +0 -64
  243. package/models/premium-override-request-dto.ts +0 -31
  244. package/models/product-class.ts +0 -80
  245. package/models/product-field-class.ts +0 -138
  246. package/models/product-version-class.ts +0 -70
  247. package/models/send-notification-request-dto.ts +0 -42
  248. package/models/update-lead-request-dto.ts +0 -89
  249. package/models/update-lead-response-class.ts +0 -31
  250. package/models/uploaded-document-dto.ts +0 -30
@@ -1,252 +0,0 @@
1
- /**
2
- * Emil PublicAPI
3
- * The Emil Public API description
4
- *
5
- * The version of the OpenAPI document: 1.0
6
- * Contact: kontakt@emil.de
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
13
- import { Configuration } from '../configuration';
14
- import { RequestArgs, BaseAPI } from '../base';
15
- import { CreateDocumentRequestDto } from '../models';
16
- import { ListDocumentsResponseClass } from '../models';
17
- /**
18
- * DocumentsApi - axios parameter creator
19
- * @export
20
- */
21
- export declare const DocumentsApiAxiosParamCreator: (configuration?: Configuration) => {
22
- /**
23
- * This will create a temporary document.
24
- * @summary Create the temporary document
25
- * @param {CreateDocumentRequestDto} createDocumentRequestDto
26
- * @param {string} [authorization] Bearer Token
27
- * @param {*} [options] Override http request option.
28
- * @throws {RequiredError}
29
- */
30
- createTemporaryDocument: (createDocumentRequestDto: CreateDocumentRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
31
- /**
32
- * Retrieves the details of the specific document that was previously created. Supply the unique document code that was returned when you created it and Emil Api will return the corresponding document file to download.
33
- * @summary Download a document
34
- * @param {string} code
35
- * @param {string} [authorization] Bearer Token
36
- * @param {*} [options] Override http request option.
37
- * @throws {RequiredError}
38
- */
39
- downloadDocument: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
40
- /**
41
- * Returns a list of documents you have previously created. The documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
42
- * @summary List documents
43
- * @param {string} [authorization] Bearer Token
44
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
45
- * @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.
46
- * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
47
- * @param {any} [search] Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
48
- * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
49
- * @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
50
- * @param {*} [options] Override http request option.
51
- * @throws {RequiredError}
52
- */
53
- listDocuments: (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
54
- };
55
- /**
56
- * DocumentsApi - functional programming interface
57
- * @export
58
- */
59
- export declare const DocumentsApiFp: (configuration?: Configuration) => {
60
- /**
61
- * This will create a temporary document.
62
- * @summary Create the temporary document
63
- * @param {CreateDocumentRequestDto} createDocumentRequestDto
64
- * @param {string} [authorization] Bearer Token
65
- * @param {*} [options] Override http request option.
66
- * @throws {RequiredError}
67
- */
68
- createTemporaryDocument(createDocumentRequestDto: CreateDocumentRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
69
- /**
70
- * Retrieves the details of the specific document that was previously created. Supply the unique document code that was returned when you created it and Emil Api will return the corresponding document file to download.
71
- * @summary Download a document
72
- * @param {string} code
73
- * @param {string} [authorization] Bearer Token
74
- * @param {*} [options] Override http request option.
75
- * @throws {RequiredError}
76
- */
77
- downloadDocument(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
78
- /**
79
- * Returns a list of documents you have previously created. The documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
80
- * @summary List documents
81
- * @param {string} [authorization] Bearer Token
82
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
83
- * @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.
84
- * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
85
- * @param {any} [search] Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
86
- * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
87
- * @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
88
- * @param {*} [options] Override http request option.
89
- * @throws {RequiredError}
90
- */
91
- listDocuments(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListDocumentsResponseClass>>;
92
- };
93
- /**
94
- * DocumentsApi - factory interface
95
- * @export
96
- */
97
- export declare const DocumentsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
98
- /**
99
- * This will create a temporary document.
100
- * @summary Create the temporary document
101
- * @param {CreateDocumentRequestDto} createDocumentRequestDto
102
- * @param {string} [authorization] Bearer Token
103
- * @param {*} [options] Override http request option.
104
- * @throws {RequiredError}
105
- */
106
- createTemporaryDocument(createDocumentRequestDto: CreateDocumentRequestDto, authorization?: string, options?: any): AxiosPromise<void>;
107
- /**
108
- * Retrieves the details of the specific document that was previously created. Supply the unique document code that was returned when you created it and Emil Api will return the corresponding document file to download.
109
- * @summary Download a document
110
- * @param {string} code
111
- * @param {string} [authorization] Bearer Token
112
- * @param {*} [options] Override http request option.
113
- * @throws {RequiredError}
114
- */
115
- downloadDocument(code: string, authorization?: string, options?: any): AxiosPromise<void>;
116
- /**
117
- * Returns a list of documents you have previously created. The documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
118
- * @summary List documents
119
- * @param {string} [authorization] Bearer Token
120
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
121
- * @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.
122
- * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
123
- * @param {any} [search] Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
124
- * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
125
- * @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
126
- * @param {*} [options] Override http request option.
127
- * @throws {RequiredError}
128
- */
129
- listDocuments(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: any): AxiosPromise<ListDocumentsResponseClass>;
130
- };
131
- /**
132
- * Request parameters for createTemporaryDocument operation in DocumentsApi.
133
- * @export
134
- * @interface DocumentsApiCreateTemporaryDocumentRequest
135
- */
136
- export interface DocumentsApiCreateTemporaryDocumentRequest {
137
- /**
138
- *
139
- * @type {CreateDocumentRequestDto}
140
- * @memberof DocumentsApiCreateTemporaryDocument
141
- */
142
- readonly createDocumentRequestDto: CreateDocumentRequestDto;
143
- /**
144
- * Bearer Token
145
- * @type {string}
146
- * @memberof DocumentsApiCreateTemporaryDocument
147
- */
148
- readonly authorization?: string;
149
- }
150
- /**
151
- * Request parameters for downloadDocument operation in DocumentsApi.
152
- * @export
153
- * @interface DocumentsApiDownloadDocumentRequest
154
- */
155
- export interface DocumentsApiDownloadDocumentRequest {
156
- /**
157
- *
158
- * @type {string}
159
- * @memberof DocumentsApiDownloadDocument
160
- */
161
- readonly code: string;
162
- /**
163
- * Bearer Token
164
- * @type {string}
165
- * @memberof DocumentsApiDownloadDocument
166
- */
167
- readonly authorization?: string;
168
- }
169
- /**
170
- * Request parameters for listDocuments operation in DocumentsApi.
171
- * @export
172
- * @interface DocumentsApiListDocumentsRequest
173
- */
174
- export interface DocumentsApiListDocumentsRequest {
175
- /**
176
- * Bearer Token
177
- * @type {string}
178
- * @memberof DocumentsApiListDocuments
179
- */
180
- readonly authorization?: string;
181
- /**
182
- * A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
183
- * @type {any}
184
- * @memberof DocumentsApiListDocuments
185
- */
186
- readonly pageSize?: any;
187
- /**
188
- * 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.
189
- * @type {any}
190
- * @memberof DocumentsApiListDocuments
191
- */
192
- readonly pageToken?: any;
193
- /**
194
- * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
195
- * @type {any}
196
- * @memberof DocumentsApiListDocuments
197
- */
198
- readonly filter?: any;
199
- /**
200
- * Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
201
- * @type {any}
202
- * @memberof DocumentsApiListDocuments
203
- */
204
- readonly search?: any;
205
- /**
206
- * The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
207
- * @type {any}
208
- * @memberof DocumentsApiListDocuments
209
- */
210
- readonly order?: any;
211
- /**
212
- * Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
213
- * @type {any}
214
- * @memberof DocumentsApiListDocuments
215
- */
216
- readonly expand?: any;
217
- }
218
- /**
219
- * DocumentsApi - object-oriented interface
220
- * @export
221
- * @class DocumentsApi
222
- * @extends {BaseAPI}
223
- */
224
- export declare class DocumentsApi extends BaseAPI {
225
- /**
226
- * This will create a temporary document.
227
- * @summary Create the temporary document
228
- * @param {DocumentsApiCreateTemporaryDocumentRequest} requestParameters Request parameters.
229
- * @param {*} [options] Override http request option.
230
- * @throws {RequiredError}
231
- * @memberof DocumentsApi
232
- */
233
- createTemporaryDocument(requestParameters: DocumentsApiCreateTemporaryDocumentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
234
- /**
235
- * Retrieves the details of the specific document that was previously created. Supply the unique document code that was returned when you created it and Emil Api will return the corresponding document file to download.
236
- * @summary Download a document
237
- * @param {DocumentsApiDownloadDocumentRequest} requestParameters Request parameters.
238
- * @param {*} [options] Override http request option.
239
- * @throws {RequiredError}
240
- * @memberof DocumentsApi
241
- */
242
- downloadDocument(requestParameters: DocumentsApiDownloadDocumentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
243
- /**
244
- * Returns a list of documents you have previously created. The documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
245
- * @summary List documents
246
- * @param {DocumentsApiListDocumentsRequest} requestParameters Request parameters.
247
- * @param {*} [options] Override http request option.
248
- * @throws {RequiredError}
249
- * @memberof DocumentsApi
250
- */
251
- listDocuments(requestParameters?: DocumentsApiListDocumentsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListDocumentsResponseClass, any>>;
252
- }
@@ -1,266 +0,0 @@
1
- /**
2
- * Emil PublicAPI
3
- * The Emil Public API description
4
- *
5
- * The version of the OpenAPI document: 1.0
6
- * Contact: kontakt@emil.de
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
13
- import { Configuration } from '../configuration';
14
- import { RequestArgs, BaseAPI } from '../base';
15
- import { CreateLeadRequestDto } from '../models';
16
- import { CreateLeadResponseClass } from '../models';
17
- import { GetLeadResponseClass } from '../models';
18
- import { InitiateLeadResponseClass } from '../models';
19
- import { UpdateLeadRequestDto } from '../models';
20
- import { UpdateLeadResponseClass } from '../models';
21
- /**
22
- * LeadsApi - axios parameter creator
23
- * @export
24
- */
25
- export declare const LeadsApiAxiosParamCreator: (configuration?: Configuration) => {
26
- /**
27
- * This will create a lead. Lead creation is the first step of a workflow responsible for the creation of an account, policy, banking information.
28
- * @summary Create the lead
29
- * @param {CreateLeadRequestDto} createLeadRequestDto
30
- * @param {string} [authorization] Bearer Token
31
- * @param {*} [options] Override http request option.
32
- * @throws {RequiredError}
33
- */
34
- createLead: (createLeadRequestDto: CreateLeadRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
35
- /**
36
- * Retrieves the details of the lead that was previously created. Supply the unique lead code that was returned when you created it and Emil Api will return the corresponding lead information.
37
- * @summary Retrieve the lead
38
- * @param {string} code Unique identifier for the object.
39
- * @param {string} [authorization] Bearer Token
40
- * @param {*} [options] Override http request option.
41
- * @throws {RequiredError}
42
- */
43
- getLead: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
44
- /**
45
- * This will initiate a lead code.
46
- * @summary Initiate a lead code
47
- * @param {string} [authorization] Bearer Token
48
- * @param {*} [options] Override http request option.
49
- * @throws {RequiredError}
50
- */
51
- initiateLead: (authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
52
- /**
53
- * Updates the specified lead by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
54
- * @summary Update the lead
55
- * @param {string} code Unique identifier for the object.
56
- * @param {UpdateLeadRequestDto} updateLeadRequestDto
57
- * @param {string} [authorization] Bearer Token
58
- * @param {*} [options] Override http request option.
59
- * @throws {RequiredError}
60
- */
61
- updateLead: (code: string, updateLeadRequestDto: UpdateLeadRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
62
- };
63
- /**
64
- * LeadsApi - functional programming interface
65
- * @export
66
- */
67
- export declare const LeadsApiFp: (configuration?: Configuration) => {
68
- /**
69
- * This will create a lead. Lead creation is the first step of a workflow responsible for the creation of an account, policy, banking information.
70
- * @summary Create the lead
71
- * @param {CreateLeadRequestDto} createLeadRequestDto
72
- * @param {string} [authorization] Bearer Token
73
- * @param {*} [options] Override http request option.
74
- * @throws {RequiredError}
75
- */
76
- createLead(createLeadRequestDto: CreateLeadRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateLeadResponseClass>>;
77
- /**
78
- * Retrieves the details of the lead that was previously created. Supply the unique lead code that was returned when you created it and Emil Api will return the corresponding lead information.
79
- * @summary Retrieve the lead
80
- * @param {string} code Unique identifier for the object.
81
- * @param {string} [authorization] Bearer Token
82
- * @param {*} [options] Override http request option.
83
- * @throws {RequiredError}
84
- */
85
- getLead(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetLeadResponseClass>>;
86
- /**
87
- * This will initiate a lead code.
88
- * @summary Initiate a lead code
89
- * @param {string} [authorization] Bearer Token
90
- * @param {*} [options] Override http request option.
91
- * @throws {RequiredError}
92
- */
93
- initiateLead(authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InitiateLeadResponseClass>>;
94
- /**
95
- * Updates the specified lead by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
96
- * @summary Update the lead
97
- * @param {string} code Unique identifier for the object.
98
- * @param {UpdateLeadRequestDto} updateLeadRequestDto
99
- * @param {string} [authorization] Bearer Token
100
- * @param {*} [options] Override http request option.
101
- * @throws {RequiredError}
102
- */
103
- updateLead(code: string, updateLeadRequestDto: UpdateLeadRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateLeadResponseClass>>;
104
- };
105
- /**
106
- * LeadsApi - factory interface
107
- * @export
108
- */
109
- export declare const LeadsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
110
- /**
111
- * This will create a lead. Lead creation is the first step of a workflow responsible for the creation of an account, policy, banking information.
112
- * @summary Create the lead
113
- * @param {CreateLeadRequestDto} createLeadRequestDto
114
- * @param {string} [authorization] Bearer Token
115
- * @param {*} [options] Override http request option.
116
- * @throws {RequiredError}
117
- */
118
- createLead(createLeadRequestDto: CreateLeadRequestDto, authorization?: string, options?: any): AxiosPromise<CreateLeadResponseClass>;
119
- /**
120
- * Retrieves the details of the lead that was previously created. Supply the unique lead code that was returned when you created it and Emil Api will return the corresponding lead information.
121
- * @summary Retrieve the lead
122
- * @param {string} code Unique identifier for the object.
123
- * @param {string} [authorization] Bearer Token
124
- * @param {*} [options] Override http request option.
125
- * @throws {RequiredError}
126
- */
127
- getLead(code: string, authorization?: string, options?: any): AxiosPromise<GetLeadResponseClass>;
128
- /**
129
- * This will initiate a lead code.
130
- * @summary Initiate a lead code
131
- * @param {string} [authorization] Bearer Token
132
- * @param {*} [options] Override http request option.
133
- * @throws {RequiredError}
134
- */
135
- initiateLead(authorization?: string, options?: any): AxiosPromise<InitiateLeadResponseClass>;
136
- /**
137
- * Updates the specified lead by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
138
- * @summary Update the lead
139
- * @param {string} code Unique identifier for the object.
140
- * @param {UpdateLeadRequestDto} updateLeadRequestDto
141
- * @param {string} [authorization] Bearer Token
142
- * @param {*} [options] Override http request option.
143
- * @throws {RequiredError}
144
- */
145
- updateLead(code: string, updateLeadRequestDto: UpdateLeadRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateLeadResponseClass>;
146
- };
147
- /**
148
- * Request parameters for createLead operation in LeadsApi.
149
- * @export
150
- * @interface LeadsApiCreateLeadRequest
151
- */
152
- export interface LeadsApiCreateLeadRequest {
153
- /**
154
- *
155
- * @type {CreateLeadRequestDto}
156
- * @memberof LeadsApiCreateLead
157
- */
158
- readonly createLeadRequestDto: CreateLeadRequestDto;
159
- /**
160
- * Bearer Token
161
- * @type {string}
162
- * @memberof LeadsApiCreateLead
163
- */
164
- readonly authorization?: string;
165
- }
166
- /**
167
- * Request parameters for getLead operation in LeadsApi.
168
- * @export
169
- * @interface LeadsApiGetLeadRequest
170
- */
171
- export interface LeadsApiGetLeadRequest {
172
- /**
173
- * Unique identifier for the object.
174
- * @type {string}
175
- * @memberof LeadsApiGetLead
176
- */
177
- readonly code: string;
178
- /**
179
- * Bearer Token
180
- * @type {string}
181
- * @memberof LeadsApiGetLead
182
- */
183
- readonly authorization?: string;
184
- }
185
- /**
186
- * Request parameters for initiateLead operation in LeadsApi.
187
- * @export
188
- * @interface LeadsApiInitiateLeadRequest
189
- */
190
- export interface LeadsApiInitiateLeadRequest {
191
- /**
192
- * Bearer Token
193
- * @type {string}
194
- * @memberof LeadsApiInitiateLead
195
- */
196
- readonly authorization?: string;
197
- }
198
- /**
199
- * Request parameters for updateLead operation in LeadsApi.
200
- * @export
201
- * @interface LeadsApiUpdateLeadRequest
202
- */
203
- export interface LeadsApiUpdateLeadRequest {
204
- /**
205
- * Unique identifier for the object.
206
- * @type {string}
207
- * @memberof LeadsApiUpdateLead
208
- */
209
- readonly code: string;
210
- /**
211
- *
212
- * @type {UpdateLeadRequestDto}
213
- * @memberof LeadsApiUpdateLead
214
- */
215
- readonly updateLeadRequestDto: UpdateLeadRequestDto;
216
- /**
217
- * Bearer Token
218
- * @type {string}
219
- * @memberof LeadsApiUpdateLead
220
- */
221
- readonly authorization?: string;
222
- }
223
- /**
224
- * LeadsApi - object-oriented interface
225
- * @export
226
- * @class LeadsApi
227
- * @extends {BaseAPI}
228
- */
229
- export declare class LeadsApi extends BaseAPI {
230
- /**
231
- * This will create a lead. Lead creation is the first step of a workflow responsible for the creation of an account, policy, banking information.
232
- * @summary Create the lead
233
- * @param {LeadsApiCreateLeadRequest} requestParameters Request parameters.
234
- * @param {*} [options] Override http request option.
235
- * @throws {RequiredError}
236
- * @memberof LeadsApi
237
- */
238
- createLead(requestParameters: LeadsApiCreateLeadRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateLeadResponseClass, any>>;
239
- /**
240
- * Retrieves the details of the lead that was previously created. Supply the unique lead code that was returned when you created it and Emil Api will return the corresponding lead information.
241
- * @summary Retrieve the lead
242
- * @param {LeadsApiGetLeadRequest} requestParameters Request parameters.
243
- * @param {*} [options] Override http request option.
244
- * @throws {RequiredError}
245
- * @memberof LeadsApi
246
- */
247
- getLead(requestParameters: LeadsApiGetLeadRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetLeadResponseClass, any>>;
248
- /**
249
- * This will initiate a lead code.
250
- * @summary Initiate a lead code
251
- * @param {LeadsApiInitiateLeadRequest} requestParameters Request parameters.
252
- * @param {*} [options] Override http request option.
253
- * @throws {RequiredError}
254
- * @memberof LeadsApi
255
- */
256
- initiateLead(requestParameters?: LeadsApiInitiateLeadRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<InitiateLeadResponseClass, any>>;
257
- /**
258
- * Updates the specified lead by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
259
- * @summary Update the lead
260
- * @param {LeadsApiUpdateLeadRequest} requestParameters Request parameters.
261
- * @param {*} [options] Override http request option.
262
- * @throws {RequiredError}
263
- * @memberof LeadsApi
264
- */
265
- updateLead(requestParameters: LeadsApiUpdateLeadRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateLeadResponseClass, any>>;
266
- }