@emilgroup/public-api-sdk 1.25.0 → 1.26.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 (222) hide show
  1. package/.openapi-generator/FILES +9 -0
  2. package/README.md +2 -2
  3. package/api/booking-funnels-api.ts +161 -0
  4. package/api/documents-api.ts +36 -22
  5. package/api/leads-api.ts +4 -4
  6. package/api/named-ranges-api.ts +250 -0
  7. package/api/products-api.ts +65 -38
  8. package/api.ts +4 -0
  9. package/base.ts +1 -0
  10. package/dist/api/address-completions-validations-api.d.ts +215 -0
  11. package/dist/api/address-completions-validations-api.js +369 -0
  12. package/dist/api/booking-funnels-api.d.ts +96 -0
  13. package/dist/api/booking-funnels-api.js +223 -0
  14. package/dist/api/default-api.d.ts +66 -0
  15. package/dist/api/default-api.js +196 -0
  16. package/dist/api/documents-api.d.ts +548 -0
  17. package/dist/api/documents-api.js +857 -0
  18. package/dist/api/leads-api.d.ts +441 -0
  19. package/dist/api/leads-api.js +787 -0
  20. package/dist/api/named-ranges-api.d.ts +150 -0
  21. package/dist/api/named-ranges-api.js +263 -0
  22. package/dist/api/notifications-api.d.ts +211 -0
  23. package/dist/api/notifications-api.js +410 -0
  24. package/dist/api/payments-setup-api.d.ts +228 -0
  25. package/dist/api/payments-setup-api.js +422 -0
  26. package/dist/api/products-api.d.ts +581 -0
  27. package/dist/api/products-api.js +933 -0
  28. package/dist/api.d.ts +20 -0
  29. package/dist/api.js +38 -0
  30. package/dist/base.d.ts +74 -0
  31. package/dist/base.js +299 -0
  32. package/dist/common.d.ts +91 -0
  33. package/dist/common.js +276 -0
  34. package/dist/configuration.d.ts +83 -0
  35. package/dist/configuration.js +44 -0
  36. package/dist/index.d.ts +15 -0
  37. package/dist/index.js +36 -0
  38. package/dist/models/address-completion-item-class.d.ts +49 -0
  39. package/dist/models/address-completion-item-class.js +15 -0
  40. package/dist/models/address-completion-response-class.d.ts +25 -0
  41. package/dist/models/address-completion-response-class.js +15 -0
  42. package/dist/models/address-field-score-class.d.ts +48 -0
  43. package/dist/models/address-field-score-class.js +15 -0
  44. package/dist/models/booking-funnel-class.d.ts +90 -0
  45. package/dist/models/booking-funnel-class.js +15 -0
  46. package/dist/models/calculate-product-fields-request-dto.d.ts +31 -0
  47. package/dist/models/calculate-product-fields-request-dto.js +15 -0
  48. package/dist/models/calculate-product-fields-response-class.d.ts +25 -0
  49. package/dist/models/calculate-product-fields-response-class.js +15 -0
  50. package/dist/models/complete-braintree-payment-setup-request-dto.d.ts +48 -0
  51. package/dist/models/complete-braintree-payment-setup-request-dto.js +15 -0
  52. package/dist/models/complete-email-verification-dto.d.ts +30 -0
  53. package/dist/models/complete-email-verification-dto.js +15 -0
  54. package/dist/models/complete-email-verification-response-class.d.ts +24 -0
  55. package/dist/models/complete-email-verification-response-class.js +15 -0
  56. package/dist/models/complete-payment-setup-request-dto.d.ts +32 -0
  57. package/dist/models/complete-payment-setup-request-dto.js +15 -0
  58. package/dist/models/complete-payment-setup-response-class.d.ts +25 -0
  59. package/dist/models/complete-payment-setup-response-class.js +15 -0
  60. package/dist/models/complete-stripe-payment-setup-request-dto.d.ts +60 -0
  61. package/dist/models/complete-stripe-payment-setup-request-dto.js +15 -0
  62. package/dist/models/create-account-request-dto.d.ts +132 -0
  63. package/dist/models/create-account-request-dto.js +31 -0
  64. package/dist/models/create-bank-account-request-dto.d.ts +30 -0
  65. package/dist/models/create-bank-account-request-dto.js +15 -0
  66. package/dist/models/create-custom-application-request-dto.d.ts +35 -0
  67. package/dist/models/create-custom-application-request-dto.js +20 -0
  68. package/dist/models/create-custom-application-response-class.d.ts +24 -0
  69. package/dist/models/create-custom-application-response-class.js +15 -0
  70. package/dist/models/create-document-request-dto.d.ts +132 -0
  71. package/dist/models/create-document-request-dto.js +43 -0
  72. package/dist/models/create-estimated-invoice-request-dto.d.ts +55 -0
  73. package/dist/models/create-estimated-invoice-request-dto.js +20 -0
  74. package/dist/models/create-estimated-invoice-response-class.d.ts +38 -0
  75. package/dist/models/create-estimated-invoice-response-class.js +15 -0
  76. package/dist/models/create-lead-async-response-class.d.ts +24 -0
  77. package/dist/models/create-lead-async-response-class.js +15 -0
  78. package/dist/models/create-lead-request-dto.d.ts +120 -0
  79. package/dist/models/create-lead-request-dto.js +15 -0
  80. package/dist/models/create-lead-response-class.d.ts +25 -0
  81. package/dist/models/create-lead-response-class.js +15 -0
  82. package/dist/models/create-payment-method-request-dto.d.ts +36 -0
  83. package/dist/models/create-payment-method-request-dto.js +20 -0
  84. package/dist/models/create-presigned-post-request-dto.d.ts +128 -0
  85. package/dist/models/create-presigned-post-request-dto.js +52 -0
  86. package/dist/models/create-presigned-post-response-class.d.ts +30 -0
  87. package/dist/models/create-presigned-post-response-class.js +15 -0
  88. package/dist/models/document-class.d.ts +144 -0
  89. package/dist/models/document-class.js +49 -0
  90. package/dist/models/filter-named-range-response-class.d.ts +42 -0
  91. package/dist/models/filter-named-range-response-class.js +15 -0
  92. package/dist/models/get-booking-funnel-response-class.d.ts +25 -0
  93. package/dist/models/get-booking-funnel-response-class.js +15 -0
  94. package/dist/models/get-custom-css-response-class.d.ts +24 -0
  95. package/dist/models/get-custom-css-response-class.js +15 -0
  96. package/dist/models/get-lead-response-class.d.ts +25 -0
  97. package/dist/models/get-lead-response-class.js +15 -0
  98. package/dist/models/get-product-document-download-url-response-class.d.ts +24 -0
  99. package/dist/models/get-product-document-download-url-response-class.js +15 -0
  100. package/dist/models/get-public-psp-settings-response-class.d.ts +30 -0
  101. package/dist/models/get-public-psp-settings-response-class.js +15 -0
  102. package/dist/models/index.d.ts +79 -0
  103. package/dist/models/index.js +95 -0
  104. package/dist/models/initiate-braintree-payment-setup-request-dto.d.ts +30 -0
  105. package/dist/models/initiate-braintree-payment-setup-request-dto.js +15 -0
  106. package/dist/models/initiate-braintree-payment-setup-response-class.d.ts +24 -0
  107. package/dist/models/initiate-braintree-payment-setup-response-class.js +15 -0
  108. package/dist/models/initiate-email-verification-dto.d.ts +30 -0
  109. package/dist/models/initiate-email-verification-dto.js +15 -0
  110. package/dist/models/initiate-email-verification-response-class.d.ts +24 -0
  111. package/dist/models/initiate-email-verification-response-class.js +15 -0
  112. package/dist/models/initiate-lead-response-class.d.ts +24 -0
  113. package/dist/models/initiate-lead-response-class.js +15 -0
  114. package/dist/models/initiate-payment-setup-request-dto.d.ts +32 -0
  115. package/dist/models/initiate-payment-setup-request-dto.js +15 -0
  116. package/dist/models/initiate-payment-setup-response-class.d.ts +32 -0
  117. package/dist/models/initiate-payment-setup-response-class.js +15 -0
  118. package/dist/models/initiate-stripe-payment-setup-request-dto.d.ts +30 -0
  119. package/dist/models/initiate-stripe-payment-setup-request-dto.js +15 -0
  120. package/dist/models/initiate-stripe-payment-setup-response-class.d.ts +30 -0
  121. package/dist/models/initiate-stripe-payment-setup-response-class.js +15 -0
  122. package/dist/models/inline-response200.d.ts +54 -0
  123. package/dist/models/inline-response200.js +15 -0
  124. package/dist/models/inline-response503.d.ts +54 -0
  125. package/dist/models/inline-response503.js +15 -0
  126. package/dist/models/insured-object-class.d.ts +85 -0
  127. package/dist/models/insured-object-class.js +15 -0
  128. package/dist/models/insured-object-type-class.d.ts +48 -0
  129. package/dist/models/insured-object-type-class.js +15 -0
  130. package/dist/models/invoice-class.d.ts +134 -0
  131. package/dist/models/invoice-class.js +15 -0
  132. package/dist/models/invoice-item-class.d.ts +120 -0
  133. package/dist/models/invoice-item-class.js +15 -0
  134. package/dist/models/invoice-status-class.d.ts +42 -0
  135. package/dist/models/invoice-status-class.js +15 -0
  136. package/dist/models/lead-account-class.d.ts +109 -0
  137. package/dist/models/lead-account-class.js +22 -0
  138. package/dist/models/lead-bank-account-class.d.ts +30 -0
  139. package/dist/models/lead-bank-account-class.js +15 -0
  140. package/dist/models/lead-class.d.ts +116 -0
  141. package/dist/models/lead-class.js +15 -0
  142. package/dist/models/lead-policy-class.d.ts +43 -0
  143. package/dist/models/lead-policy-class.js +15 -0
  144. package/dist/models/lead-policy-object-class.d.ts +36 -0
  145. package/dist/models/lead-policy-object-class.js +15 -0
  146. package/dist/models/list-documents-response-class.d.ts +31 -0
  147. package/dist/models/list-documents-response-class.js +15 -0
  148. package/dist/models/list-product-documents-response-class.d.ts +31 -0
  149. package/dist/models/list-product-documents-response-class.js +15 -0
  150. package/dist/models/list-products-response-class.d.ts +31 -0
  151. package/dist/models/list-products-response-class.js +15 -0
  152. package/dist/models/partner-class.d.ts +60 -0
  153. package/dist/models/partner-class.js +15 -0
  154. package/dist/models/partner-link-class.d.ts +86 -0
  155. package/dist/models/partner-link-class.js +15 -0
  156. package/dist/models/partner-role-class.d.ts +54 -0
  157. package/dist/models/partner-role-class.js +15 -0
  158. package/dist/models/payment-method-class.d.ts +60 -0
  159. package/dist/models/payment-method-class.js +15 -0
  160. package/dist/models/policy-object-request-dto.d.ts +42 -0
  161. package/dist/models/policy-object-request-dto.js +15 -0
  162. package/dist/models/policy-object-response-class.d.ts +36 -0
  163. package/dist/models/policy-object-response-class.js +15 -0
  164. package/dist/models/premium-override-dto.d.ts +55 -0
  165. package/dist/models/premium-override-dto.js +27 -0
  166. package/dist/models/premium-override-request-dto.d.ts +25 -0
  167. package/dist/models/premium-override-request-dto.js +15 -0
  168. package/dist/models/product-class.d.ts +80 -0
  169. package/dist/models/product-class.js +15 -0
  170. package/dist/models/product-document-class.d.ts +123 -0
  171. package/dist/models/product-document-class.js +36 -0
  172. package/dist/models/product-factor-for-version-class.d.ts +61 -0
  173. package/dist/models/product-factor-for-version-class.js +15 -0
  174. package/dist/models/product-factor-value-for-version-class.d.ts +42 -0
  175. package/dist/models/product-factor-value-for-version-class.js +15 -0
  176. package/dist/models/product-field-class.d.ts +132 -0
  177. package/dist/models/product-field-class.js +15 -0
  178. package/dist/models/product-version-class.d.ts +61 -0
  179. package/dist/models/product-version-class.js +22 -0
  180. package/dist/models/send-notification-request-dto.d.ts +36 -0
  181. package/dist/models/send-notification-request-dto.js +15 -0
  182. package/dist/models/send-notification-response-class.d.ts +24 -0
  183. package/dist/models/send-notification-response-class.js +15 -0
  184. package/dist/models/sepa-dto.d.ts +30 -0
  185. package/dist/models/sepa-dto.js +15 -0
  186. package/dist/models/structured-address-class.d.ts +54 -0
  187. package/dist/models/structured-address-class.js +15 -0
  188. package/dist/models/suggested-address-details-class.d.ts +90 -0
  189. package/dist/models/suggested-address-details-class.js +15 -0
  190. package/dist/models/update-lead-request-dto.d.ts +95 -0
  191. package/dist/models/update-lead-request-dto.js +15 -0
  192. package/dist/models/update-lead-response-class.d.ts +25 -0
  193. package/dist/models/update-lead-response-class.js +15 -0
  194. package/dist/models/uploaded-document-dto.d.ts +24 -0
  195. package/dist/models/uploaded-document-dto.js +15 -0
  196. package/dist/models/validate-address-response-class.d.ts +50 -0
  197. package/dist/models/validate-address-response-class.js +15 -0
  198. package/models/address-field-score-class.ts +10 -10
  199. package/models/booking-funnel-class.ts +96 -0
  200. package/models/create-account-request-dto.ts +1 -1
  201. package/models/create-document-request-dto.ts +2 -2
  202. package/models/create-lead-request-dto.ts +13 -1
  203. package/models/create-presigned-post-request-dto.ts +2 -2
  204. package/models/document-class.ts +1 -1
  205. package/models/filter-named-range-response-class.ts +48 -0
  206. package/models/get-booking-funnel-response-class.ts +31 -0
  207. package/models/index.ts +7 -0
  208. package/models/initiate-email-verification-dto.ts +1 -1
  209. package/models/insured-object-type-class.ts +1 -1
  210. package/models/lead-account-class.ts +1 -1
  211. package/models/lead-class.ts +7 -0
  212. package/models/lead-policy-object-class.ts +2 -2
  213. package/models/partner-class.ts +66 -0
  214. package/models/partner-link-class.ts +92 -0
  215. package/models/partner-role-class.ts +60 -0
  216. package/models/product-class.ts +1 -1
  217. package/models/product-document-class.ts +14 -2
  218. package/models/product-factor-for-version-class.ts +4 -3
  219. package/models/product-factor-value-for-version-class.ts +48 -0
  220. package/models/send-notification-request-dto.ts +1 -1
  221. package/models/update-lead-request-dto.ts +1 -1
  222. package/package.json +1 -1
@@ -0,0 +1,548 @@
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 { CreatePresignedPostRequestDto } from '../models';
17
+ import { CreatePresignedPostResponseClass } from '../models';
18
+ import { GetProductDocumentDownloadUrlResponseClass } from '../models';
19
+ import { ListDocumentsResponseClass } from '../models';
20
+ import { ListProductDocumentsResponseClass } from '../models';
21
+ /**
22
+ * DocumentsApi - axios parameter creator
23
+ * @export
24
+ */
25
+ export declare const DocumentsApiAxiosParamCreator: (configuration?: Configuration) => {
26
+ /**
27
+ * This will create a temporary document.
28
+ * @summary Create the temporary document
29
+ * @param {CreateDocumentRequestDto} createDocumentRequestDto
30
+ * @param {string} [authorization] Bearer Token
31
+ * @param {*} [options] Override http request option.
32
+ * @throws {RequiredError}
33
+ */
34
+ createTemporaryDocument: (createDocumentRequestDto: CreateDocumentRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
35
+ /**
36
+ * This will delete a document for a lead by lead code and document code.Documents which were created within last 24 hours can be deleted.
37
+ * @summary Delete a document
38
+ * @param {string} leadCode
39
+ * @param {string} code
40
+ * @param {string} [authorization] Bearer Token
41
+ * @param {*} [options] Override http request option.
42
+ * @throws {RequiredError}
43
+ */
44
+ deleteDocuments: (leadCode: string, code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
45
+ /**
46
+ * 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.
47
+ * @summary Download a document
48
+ * @param {string} code
49
+ * @param {string} [authorization] Bearer Token
50
+ * @param {*} [options] Override http request option.
51
+ * @throws {RequiredError}
52
+ */
53
+ downloadDocument: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
54
+ /**
55
+ *
56
+ * @summary Get pre-signed url for downloading product document
57
+ * @param {string} productCode
58
+ * @param {string} code
59
+ * @param {string} [authorization] Bearer Token
60
+ * @param {*} [options] Override http request option.
61
+ * @throws {RequiredError}
62
+ */
63
+ downloadProductDocumentUrl: (productCode: string, code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
64
+ /**
65
+ * 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.
66
+ * @summary List documents
67
+ * @param {string} filter Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
68
+ * @param {string} [authorization] Bearer Token
69
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
70
+ * @param {string} [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.
71
+ * @param {string} [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.
72
+ * @param {string} [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.
73
+ * @param {*} [options] Override http request option.
74
+ * @throws {RequiredError}
75
+ */
76
+ listDocuments: (filter: string, authorization?: string, pageSize?: number, pageToken?: string, order?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
77
+ /**
78
+ * Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
79
+ * @summary List product documents
80
+ * @param {string} productCode
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 50. 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] To search the list by any field, pass search&#x3D;xxx 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 {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.
89
+ * @param {*} [options] Override http request option.
90
+ * @throws {RequiredError}
91
+ */
92
+ listProductDocuments: (productCode: string, authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
93
+ /**
94
+ * This will create a URL that allows user upload its documents in Database.The URL can expire between 5 minutes and 7 days.
95
+ * @summary Upload documents using pre-signed URL
96
+ * @param {CreatePresignedPostRequestDto} createPresignedPostRequestDto
97
+ * @param {string} [authorization] Bearer Token
98
+ * @param {*} [options] Override http request option.
99
+ * @throws {RequiredError}
100
+ */
101
+ preSignedPost: (createPresignedPostRequestDto: CreatePresignedPostRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
102
+ };
103
+ /**
104
+ * DocumentsApi - functional programming interface
105
+ * @export
106
+ */
107
+ export declare const DocumentsApiFp: (configuration?: Configuration) => {
108
+ /**
109
+ * This will create a temporary document.
110
+ * @summary Create the temporary document
111
+ * @param {CreateDocumentRequestDto} createDocumentRequestDto
112
+ * @param {string} [authorization] Bearer Token
113
+ * @param {*} [options] Override http request option.
114
+ * @throws {RequiredError}
115
+ */
116
+ createTemporaryDocument(createDocumentRequestDto: CreateDocumentRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
117
+ /**
118
+ * This will delete a document for a lead by lead code and document code.Documents which were created within last 24 hours can be deleted.
119
+ * @summary Delete a document
120
+ * @param {string} leadCode
121
+ * @param {string} code
122
+ * @param {string} [authorization] Bearer Token
123
+ * @param {*} [options] Override http request option.
124
+ * @throws {RequiredError}
125
+ */
126
+ deleteDocuments(leadCode: string, code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
127
+ /**
128
+ * 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.
129
+ * @summary Download a document
130
+ * @param {string} code
131
+ * @param {string} [authorization] Bearer Token
132
+ * @param {*} [options] Override http request option.
133
+ * @throws {RequiredError}
134
+ */
135
+ downloadDocument(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
136
+ /**
137
+ *
138
+ * @summary Get pre-signed url for downloading product document
139
+ * @param {string} productCode
140
+ * @param {string} code
141
+ * @param {string} [authorization] Bearer Token
142
+ * @param {*} [options] Override http request option.
143
+ * @throws {RequiredError}
144
+ */
145
+ downloadProductDocumentUrl(productCode: string, code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetProductDocumentDownloadUrlResponseClass>>;
146
+ /**
147
+ * 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.
148
+ * @summary List documents
149
+ * @param {string} filter Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
150
+ * @param {string} [authorization] Bearer Token
151
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
152
+ * @param {string} [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.
153
+ * @param {string} [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.
154
+ * @param {string} [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.
155
+ * @param {*} [options] Override http request option.
156
+ * @throws {RequiredError}
157
+ */
158
+ listDocuments(filter: string, authorization?: string, pageSize?: number, pageToken?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListDocumentsResponseClass>>;
159
+ /**
160
+ * Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
161
+ * @summary List product documents
162
+ * @param {string} productCode
163
+ * @param {string} [authorization] Bearer Token
164
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
165
+ * @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.
166
+ * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
167
+ * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
168
+ * @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.
169
+ * @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.
170
+ * @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
171
+ * @param {*} [options] Override http request option.
172
+ * @throws {RequiredError}
173
+ */
174
+ listProductDocuments(productCode: string, authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListProductDocumentsResponseClass>>;
175
+ /**
176
+ * This will create a URL that allows user upload its documents in Database.The URL can expire between 5 minutes and 7 days.
177
+ * @summary Upload documents using pre-signed URL
178
+ * @param {CreatePresignedPostRequestDto} createPresignedPostRequestDto
179
+ * @param {string} [authorization] Bearer Token
180
+ * @param {*} [options] Override http request option.
181
+ * @throws {RequiredError}
182
+ */
183
+ preSignedPost(createPresignedPostRequestDto: CreatePresignedPostRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePresignedPostResponseClass>>;
184
+ };
185
+ /**
186
+ * DocumentsApi - factory interface
187
+ * @export
188
+ */
189
+ export declare const DocumentsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
190
+ /**
191
+ * This will create a temporary document.
192
+ * @summary Create the temporary document
193
+ * @param {CreateDocumentRequestDto} createDocumentRequestDto
194
+ * @param {string} [authorization] Bearer Token
195
+ * @param {*} [options] Override http request option.
196
+ * @throws {RequiredError}
197
+ */
198
+ createTemporaryDocument(createDocumentRequestDto: CreateDocumentRequestDto, authorization?: string, options?: any): AxiosPromise<void>;
199
+ /**
200
+ * This will delete a document for a lead by lead code and document code.Documents which were created within last 24 hours can be deleted.
201
+ * @summary Delete a document
202
+ * @param {string} leadCode
203
+ * @param {string} code
204
+ * @param {string} [authorization] Bearer Token
205
+ * @param {*} [options] Override http request option.
206
+ * @throws {RequiredError}
207
+ */
208
+ deleteDocuments(leadCode: string, code: string, authorization?: string, options?: any): AxiosPromise<void>;
209
+ /**
210
+ * 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.
211
+ * @summary Download a document
212
+ * @param {string} code
213
+ * @param {string} [authorization] Bearer Token
214
+ * @param {*} [options] Override http request option.
215
+ * @throws {RequiredError}
216
+ */
217
+ downloadDocument(code: string, authorization?: string, options?: any): AxiosPromise<void>;
218
+ /**
219
+ *
220
+ * @summary Get pre-signed url for downloading product document
221
+ * @param {string} productCode
222
+ * @param {string} code
223
+ * @param {string} [authorization] Bearer Token
224
+ * @param {*} [options] Override http request option.
225
+ * @throws {RequiredError}
226
+ */
227
+ downloadProductDocumentUrl(productCode: string, code: string, authorization?: string, options?: any): AxiosPromise<GetProductDocumentDownloadUrlResponseClass>;
228
+ /**
229
+ * 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.
230
+ * @summary List documents
231
+ * @param {string} filter Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
232
+ * @param {string} [authorization] Bearer Token
233
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
234
+ * @param {string} [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.
235
+ * @param {string} [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.
236
+ * @param {string} [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.
237
+ * @param {*} [options] Override http request option.
238
+ * @throws {RequiredError}
239
+ */
240
+ listDocuments(filter: string, authorization?: string, pageSize?: number, pageToken?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListDocumentsResponseClass>;
241
+ /**
242
+ * Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
243
+ * @summary List product documents
244
+ * @param {string} productCode
245
+ * @param {string} [authorization] Bearer Token
246
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
247
+ * @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.
248
+ * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
249
+ * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
250
+ * @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.
251
+ * @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.
252
+ * @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.
253
+ * @param {*} [options] Override http request option.
254
+ * @throws {RequiredError}
255
+ */
256
+ listProductDocuments(productCode: string, authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: any): AxiosPromise<ListProductDocumentsResponseClass>;
257
+ /**
258
+ * This will create a URL that allows user upload its documents in Database.The URL can expire between 5 minutes and 7 days.
259
+ * @summary Upload documents using pre-signed URL
260
+ * @param {CreatePresignedPostRequestDto} createPresignedPostRequestDto
261
+ * @param {string} [authorization] Bearer Token
262
+ * @param {*} [options] Override http request option.
263
+ * @throws {RequiredError}
264
+ */
265
+ preSignedPost(createPresignedPostRequestDto: CreatePresignedPostRequestDto, authorization?: string, options?: any): AxiosPromise<CreatePresignedPostResponseClass>;
266
+ };
267
+ /**
268
+ * Request parameters for createTemporaryDocument operation in DocumentsApi.
269
+ * @export
270
+ * @interface DocumentsApiCreateTemporaryDocumentRequest
271
+ */
272
+ export interface DocumentsApiCreateTemporaryDocumentRequest {
273
+ /**
274
+ *
275
+ * @type {CreateDocumentRequestDto}
276
+ * @memberof DocumentsApiCreateTemporaryDocument
277
+ */
278
+ readonly createDocumentRequestDto: CreateDocumentRequestDto;
279
+ /**
280
+ * Bearer Token
281
+ * @type {string}
282
+ * @memberof DocumentsApiCreateTemporaryDocument
283
+ */
284
+ readonly authorization?: string;
285
+ }
286
+ /**
287
+ * Request parameters for deleteDocuments operation in DocumentsApi.
288
+ * @export
289
+ * @interface DocumentsApiDeleteDocumentsRequest
290
+ */
291
+ export interface DocumentsApiDeleteDocumentsRequest {
292
+ /**
293
+ *
294
+ * @type {string}
295
+ * @memberof DocumentsApiDeleteDocuments
296
+ */
297
+ readonly leadCode: string;
298
+ /**
299
+ *
300
+ * @type {string}
301
+ * @memberof DocumentsApiDeleteDocuments
302
+ */
303
+ readonly code: string;
304
+ /**
305
+ * Bearer Token
306
+ * @type {string}
307
+ * @memberof DocumentsApiDeleteDocuments
308
+ */
309
+ readonly authorization?: string;
310
+ }
311
+ /**
312
+ * Request parameters for downloadDocument operation in DocumentsApi.
313
+ * @export
314
+ * @interface DocumentsApiDownloadDocumentRequest
315
+ */
316
+ export interface DocumentsApiDownloadDocumentRequest {
317
+ /**
318
+ *
319
+ * @type {string}
320
+ * @memberof DocumentsApiDownloadDocument
321
+ */
322
+ readonly code: string;
323
+ /**
324
+ * Bearer Token
325
+ * @type {string}
326
+ * @memberof DocumentsApiDownloadDocument
327
+ */
328
+ readonly authorization?: string;
329
+ }
330
+ /**
331
+ * Request parameters for downloadProductDocumentUrl operation in DocumentsApi.
332
+ * @export
333
+ * @interface DocumentsApiDownloadProductDocumentUrlRequest
334
+ */
335
+ export interface DocumentsApiDownloadProductDocumentUrlRequest {
336
+ /**
337
+ *
338
+ * @type {string}
339
+ * @memberof DocumentsApiDownloadProductDocumentUrl
340
+ */
341
+ readonly productCode: string;
342
+ /**
343
+ *
344
+ * @type {string}
345
+ * @memberof DocumentsApiDownloadProductDocumentUrl
346
+ */
347
+ readonly code: string;
348
+ /**
349
+ * Bearer Token
350
+ * @type {string}
351
+ * @memberof DocumentsApiDownloadProductDocumentUrl
352
+ */
353
+ readonly authorization?: string;
354
+ }
355
+ /**
356
+ * Request parameters for listDocuments operation in DocumentsApi.
357
+ * @export
358
+ * @interface DocumentsApiListDocumentsRequest
359
+ */
360
+ export interface DocumentsApiListDocumentsRequest {
361
+ /**
362
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
363
+ * @type {string}
364
+ * @memberof DocumentsApiListDocuments
365
+ */
366
+ readonly filter: string;
367
+ /**
368
+ * Bearer Token
369
+ * @type {string}
370
+ * @memberof DocumentsApiListDocuments
371
+ */
372
+ readonly authorization?: string;
373
+ /**
374
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
375
+ * @type {number}
376
+ * @memberof DocumentsApiListDocuments
377
+ */
378
+ readonly pageSize?: number;
379
+ /**
380
+ * 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.
381
+ * @type {string}
382
+ * @memberof DocumentsApiListDocuments
383
+ */
384
+ readonly pageToken?: string;
385
+ /**
386
+ * 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.
387
+ * @type {string}
388
+ * @memberof DocumentsApiListDocuments
389
+ */
390
+ readonly order?: string;
391
+ /**
392
+ * 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.
393
+ * @type {string}
394
+ * @memberof DocumentsApiListDocuments
395
+ */
396
+ readonly expand?: string;
397
+ }
398
+ /**
399
+ * Request parameters for listProductDocuments operation in DocumentsApi.
400
+ * @export
401
+ * @interface DocumentsApiListProductDocumentsRequest
402
+ */
403
+ export interface DocumentsApiListProductDocumentsRequest {
404
+ /**
405
+ *
406
+ * @type {string}
407
+ * @memberof DocumentsApiListProductDocuments
408
+ */
409
+ readonly productCode: string;
410
+ /**
411
+ * Bearer Token
412
+ * @type {string}
413
+ * @memberof DocumentsApiListProductDocuments
414
+ */
415
+ readonly authorization?: string;
416
+ /**
417
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
418
+ * @type {any}
419
+ * @memberof DocumentsApiListProductDocuments
420
+ */
421
+ readonly pageSize?: any;
422
+ /**
423
+ * 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.
424
+ * @type {any}
425
+ * @memberof DocumentsApiListProductDocuments
426
+ */
427
+ readonly pageToken?: any;
428
+ /**
429
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
430
+ * @type {any}
431
+ * @memberof DocumentsApiListProductDocuments
432
+ */
433
+ readonly filter?: any;
434
+ /**
435
+ * To search the list by any field, pass search&#x3D;xxx to fetch the result.
436
+ * @type {any}
437
+ * @memberof DocumentsApiListProductDocuments
438
+ */
439
+ readonly search?: any;
440
+ /**
441
+ * 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.
442
+ * @type {any}
443
+ * @memberof DocumentsApiListProductDocuments
444
+ */
445
+ readonly order?: any;
446
+ /**
447
+ * 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.
448
+ * @type {any}
449
+ * @memberof DocumentsApiListProductDocuments
450
+ */
451
+ readonly expand?: any;
452
+ /**
453
+ * 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.
454
+ * @type {any}
455
+ * @memberof DocumentsApiListProductDocuments
456
+ */
457
+ readonly filters?: any;
458
+ }
459
+ /**
460
+ * Request parameters for preSignedPost operation in DocumentsApi.
461
+ * @export
462
+ * @interface DocumentsApiPreSignedPostRequest
463
+ */
464
+ export interface DocumentsApiPreSignedPostRequest {
465
+ /**
466
+ *
467
+ * @type {CreatePresignedPostRequestDto}
468
+ * @memberof DocumentsApiPreSignedPost
469
+ */
470
+ readonly createPresignedPostRequestDto: CreatePresignedPostRequestDto;
471
+ /**
472
+ * Bearer Token
473
+ * @type {string}
474
+ * @memberof DocumentsApiPreSignedPost
475
+ */
476
+ readonly authorization?: string;
477
+ }
478
+ /**
479
+ * DocumentsApi - object-oriented interface
480
+ * @export
481
+ * @class DocumentsApi
482
+ * @extends {BaseAPI}
483
+ */
484
+ export declare class DocumentsApi extends BaseAPI {
485
+ /**
486
+ * This will create a temporary document.
487
+ * @summary Create the temporary document
488
+ * @param {DocumentsApiCreateTemporaryDocumentRequest} requestParameters Request parameters.
489
+ * @param {*} [options] Override http request option.
490
+ * @throws {RequiredError}
491
+ * @memberof DocumentsApi
492
+ */
493
+ createTemporaryDocument(requestParameters: DocumentsApiCreateTemporaryDocumentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
494
+ /**
495
+ * This will delete a document for a lead by lead code and document code.Documents which were created within last 24 hours can be deleted.
496
+ * @summary Delete a document
497
+ * @param {DocumentsApiDeleteDocumentsRequest} requestParameters Request parameters.
498
+ * @param {*} [options] Override http request option.
499
+ * @throws {RequiredError}
500
+ * @memberof DocumentsApi
501
+ */
502
+ deleteDocuments(requestParameters: DocumentsApiDeleteDocumentsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
503
+ /**
504
+ * 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.
505
+ * @summary Download a document
506
+ * @param {DocumentsApiDownloadDocumentRequest} requestParameters Request parameters.
507
+ * @param {*} [options] Override http request option.
508
+ * @throws {RequiredError}
509
+ * @memberof DocumentsApi
510
+ */
511
+ downloadDocument(requestParameters: DocumentsApiDownloadDocumentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
512
+ /**
513
+ *
514
+ * @summary Get pre-signed url for downloading product document
515
+ * @param {DocumentsApiDownloadProductDocumentUrlRequest} requestParameters Request parameters.
516
+ * @param {*} [options] Override http request option.
517
+ * @throws {RequiredError}
518
+ * @memberof DocumentsApi
519
+ */
520
+ downloadProductDocumentUrl(requestParameters: DocumentsApiDownloadProductDocumentUrlRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetProductDocumentDownloadUrlResponseClass, any>>;
521
+ /**
522
+ * 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.
523
+ * @summary List documents
524
+ * @param {DocumentsApiListDocumentsRequest} requestParameters Request parameters.
525
+ * @param {*} [options] Override http request option.
526
+ * @throws {RequiredError}
527
+ * @memberof DocumentsApi
528
+ */
529
+ listDocuments(requestParameters: DocumentsApiListDocumentsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListDocumentsResponseClass, any>>;
530
+ /**
531
+ * Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
532
+ * @summary List product documents
533
+ * @param {DocumentsApiListProductDocumentsRequest} requestParameters Request parameters.
534
+ * @param {*} [options] Override http request option.
535
+ * @throws {RequiredError}
536
+ * @memberof DocumentsApi
537
+ */
538
+ listProductDocuments(requestParameters: DocumentsApiListProductDocumentsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListProductDocumentsResponseClass, any>>;
539
+ /**
540
+ * This will create a URL that allows user upload its documents in Database.The URL can expire between 5 minutes and 7 days.
541
+ * @summary Upload documents using pre-signed URL
542
+ * @param {DocumentsApiPreSignedPostRequest} requestParameters Request parameters.
543
+ * @param {*} [options] Override http request option.
544
+ * @throws {RequiredError}
545
+ * @memberof DocumentsApi
546
+ */
547
+ preSignedPost(requestParameters: DocumentsApiPreSignedPostRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePresignedPostResponseClass, any>>;
548
+ }