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