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