@openfilz-sdk/typescript-ee 1.8.0 → 1.8.2

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 (198) hide show
  1. package/.openapi-generator/FILES +45 -4
  2. package/.openapi-generator/openfilz-api-generate-typescript-sdk.sha256 +1 -1
  3. package/README.md +46 -13
  4. package/api/aisettings-api.ts +77 -0
  5. package/api/esign-api.ts +719 -0
  6. package/api/esign-enterprise-api.ts +286 -0
  7. package/api/{digital-signature-public-api.ts → esign-public-api.ts} +183 -24
  8. package/api/{digital-signature-api.ts → esign-templates-api.ts} +137 -113
  9. package/api.ts +4 -2
  10. package/dist/api/aisettings-api.d.ts +34 -0
  11. package/dist/api/aisettings-api.js +70 -0
  12. package/dist/api/esign-api.d.ts +334 -0
  13. package/dist/api/esign-api.js +693 -0
  14. package/dist/api/esign-enterprise-api.d.ts +138 -0
  15. package/dist/api/esign-enterprise-api.js +278 -0
  16. package/dist/{esm/api/digital-signature-public-api.d.ts → api/esign-public-api.d.ts} +81 -12
  17. package/dist/api/{digital-signature-public-api.js → esign-public-api.js} +178 -29
  18. package/dist/api/esign-templates-api.d.ts +234 -0
  19. package/dist/api/{digital-signature-api.js → esign-templates-api.js} +137 -115
  20. package/dist/api.d.ts +4 -2
  21. package/dist/api.js +4 -2
  22. package/dist/esm/api/aisettings-api.d.ts +34 -0
  23. package/dist/esm/api/aisettings-api.js +70 -0
  24. package/dist/esm/api/esign-api.d.ts +334 -0
  25. package/dist/esm/api/esign-api.js +686 -0
  26. package/dist/esm/api/esign-enterprise-api.d.ts +138 -0
  27. package/dist/esm/api/esign-enterprise-api.js +271 -0
  28. package/dist/{api/digital-signature-public-api.d.ts → esm/api/esign-public-api.d.ts} +81 -12
  29. package/dist/esm/api/{digital-signature-public-api.js → esign-public-api.js} +173 -24
  30. package/dist/esm/api/esign-templates-api.d.ts +234 -0
  31. package/dist/esm/api/{digital-signature-api.js → esign-templates-api.js} +132 -110
  32. package/dist/esm/api.d.ts +4 -2
  33. package/dist/esm/api.js +4 -2
  34. package/dist/esm/models/ai-models-response.d.ts +41 -0
  35. package/dist/esm/models/ai-models-response.js +23 -0
  36. package/dist/esm/models/apply-signature-request.d.ts +3 -0
  37. package/dist/esm/models/bulk-row-result.d.ts +17 -0
  38. package/dist/esm/models/bulk-row-result.js +14 -0
  39. package/dist/esm/models/bulk-row.d.ts +19 -0
  40. package/dist/esm/models/bulk-row.js +14 -0
  41. package/dist/esm/models/bulk-send-request.d.ts +19 -0
  42. package/dist/esm/models/bulk-send-request.js +14 -0
  43. package/dist/esm/models/bulk-send-response.d.ts +18 -0
  44. package/dist/esm/models/bulk-send-response.js +14 -0
  45. package/dist/esm/models/create-signature-envelope-request.d.ts +5 -0
  46. package/dist/esm/models/embed-url-response.d.ts +16 -0
  47. package/dist/esm/models/embed-url-response.js +14 -0
  48. package/dist/esm/models/enriched-audit-log.d.ts +3 -0
  49. package/dist/esm/models/enriched-audit-log.js +3 -0
  50. package/dist/esm/models/index.d.ts +18 -0
  51. package/dist/esm/models/index.js +18 -0
  52. package/dist/esm/models/instantiate-template-request.d.ts +22 -0
  53. package/dist/esm/models/instantiate-template-request.js +14 -0
  54. package/dist/esm/models/list-ai-models-request.d.ts +32 -0
  55. package/dist/esm/models/list-ai-models-request.js +19 -0
  56. package/dist/esm/models/public-signature-view.d.ts +13 -0
  57. package/dist/esm/models/public-signature-view.js +5 -0
  58. package/dist/esm/models/role-binding.d.ts +19 -0
  59. package/dist/esm/models/role-binding.js +14 -0
  60. package/dist/esm/models/search-by-audit-log-request.d.ts +3 -0
  61. package/dist/esm/models/search-by-audit-log-request.js +3 -0
  62. package/dist/esm/models/settings.d.ts +3 -0
  63. package/dist/esm/models/signature-envelope-dto.d.ts +6 -0
  64. package/dist/esm/models/signature-event-dto.d.ts +33 -0
  65. package/dist/esm/models/signature-event-dto.js +26 -0
  66. package/dist/esm/models/signature-field-dto.d.ts +44 -0
  67. package/dist/esm/models/signature-field-dto.js +27 -0
  68. package/dist/esm/models/signature-field-input.d.ts +39 -0
  69. package/dist/esm/models/signature-field-input.js +27 -0
  70. package/dist/esm/models/signature-field-value.d.ts +16 -0
  71. package/dist/esm/models/signature-field-value.js +14 -0
  72. package/dist/esm/models/signature-recipient-dto.d.ts +16 -0
  73. package/dist/esm/models/signature-recipient-dto.js +9 -0
  74. package/dist/esm/models/signature-recipient-input.d.ts +19 -1
  75. package/dist/esm/models/signature-recipient-input.js +9 -1
  76. package/dist/esm/models/signature-template-dto.d.ts +27 -0
  77. package/dist/esm/models/signature-template-dto.js +14 -0
  78. package/dist/esm/models/signature-template-field.d.ts +40 -0
  79. package/dist/esm/models/signature-template-field.js +27 -0
  80. package/dist/esm/models/signature-template-request.d.ts +23 -0
  81. package/dist/esm/models/signature-template-request.js +14 -0
  82. package/dist/esm/models/signature-template-role.d.ts +28 -0
  83. package/dist/esm/models/signature-template-role.js +22 -0
  84. package/dist/esm/models/verify-otp-request.d.ts +14 -0
  85. package/dist/esm/models/verify-otp-request.js +14 -0
  86. package/dist/models/ai-models-response.d.ts +41 -0
  87. package/dist/models/ai-models-response.js +26 -0
  88. package/dist/models/apply-signature-request.d.ts +3 -0
  89. package/dist/models/bulk-row-result.d.ts +17 -0
  90. package/dist/models/bulk-row-result.js +15 -0
  91. package/dist/models/bulk-row.d.ts +19 -0
  92. package/dist/models/bulk-row.js +15 -0
  93. package/dist/models/bulk-send-request.d.ts +19 -0
  94. package/dist/models/bulk-send-request.js +15 -0
  95. package/dist/models/bulk-send-response.d.ts +18 -0
  96. package/dist/models/bulk-send-response.js +15 -0
  97. package/dist/models/create-signature-envelope-request.d.ts +5 -0
  98. package/dist/models/embed-url-response.d.ts +16 -0
  99. package/dist/models/embed-url-response.js +15 -0
  100. package/dist/models/enriched-audit-log.d.ts +3 -0
  101. package/dist/models/enriched-audit-log.js +3 -0
  102. package/dist/models/index.d.ts +18 -0
  103. package/dist/models/index.js +18 -0
  104. package/dist/models/instantiate-template-request.d.ts +22 -0
  105. package/dist/models/instantiate-template-request.js +15 -0
  106. package/dist/models/list-ai-models-request.d.ts +32 -0
  107. package/dist/models/list-ai-models-request.js +22 -0
  108. package/dist/models/public-signature-view.d.ts +13 -0
  109. package/dist/models/public-signature-view.js +6 -1
  110. package/dist/models/role-binding.d.ts +19 -0
  111. package/dist/models/role-binding.js +15 -0
  112. package/dist/models/search-by-audit-log-request.d.ts +3 -0
  113. package/dist/models/search-by-audit-log-request.js +3 -0
  114. package/dist/models/settings.d.ts +3 -0
  115. package/dist/models/signature-envelope-dto.d.ts +6 -0
  116. package/dist/models/signature-event-dto.d.ts +33 -0
  117. package/dist/models/signature-event-dto.js +29 -0
  118. package/dist/models/signature-field-dto.d.ts +44 -0
  119. package/dist/models/signature-field-dto.js +30 -0
  120. package/dist/models/signature-field-input.d.ts +39 -0
  121. package/dist/models/signature-field-input.js +30 -0
  122. package/dist/models/signature-field-value.d.ts +16 -0
  123. package/dist/models/signature-field-value.js +15 -0
  124. package/dist/models/signature-recipient-dto.d.ts +16 -0
  125. package/dist/models/signature-recipient-dto.js +10 -1
  126. package/dist/models/signature-recipient-input.d.ts +19 -1
  127. package/dist/models/signature-recipient-input.js +10 -0
  128. package/dist/models/signature-template-dto.d.ts +27 -0
  129. package/dist/models/signature-template-dto.js +15 -0
  130. package/dist/models/signature-template-field.d.ts +40 -0
  131. package/dist/models/signature-template-field.js +30 -0
  132. package/dist/models/signature-template-request.d.ts +23 -0
  133. package/dist/models/signature-template-request.js +15 -0
  134. package/dist/models/signature-template-role.d.ts +28 -0
  135. package/dist/models/signature-template-role.js +25 -0
  136. package/dist/models/verify-otp-request.d.ts +14 -0
  137. package/dist/models/verify-otp-request.js +15 -0
  138. package/docs/AISettingsApi.md +53 -0
  139. package/docs/AiModelsResponse.md +26 -0
  140. package/docs/ApplySignatureRequest.md +4 -0
  141. package/docs/BulkRow.md +28 -0
  142. package/docs/BulkRowResult.md +26 -0
  143. package/docs/BulkSendRequest.md +28 -0
  144. package/docs/BulkSendResponse.md +26 -0
  145. package/docs/CreateSignatureEnvelopeRequest.md +10 -0
  146. package/docs/ESignApi.md +463 -0
  147. package/docs/ESignEnterpriseApi.md +164 -0
  148. package/docs/{DigitalSignaturePublicApi.md → ESignPublicApi.md} +118 -12
  149. package/docs/{DigitalSignatureApi.md → ESignTemplatesApi.md} +76 -61
  150. package/docs/EmbedUrlResponse.md +24 -0
  151. package/docs/InstantiateTemplateRequest.md +34 -0
  152. package/docs/ListAiModelsRequest.md +24 -0
  153. package/docs/PublicSignatureView.md +12 -0
  154. package/docs/RoleBinding.md +30 -0
  155. package/docs/Settings.md +6 -0
  156. package/docs/SignatureEnvelopeDTO.md +12 -0
  157. package/docs/SignatureEventDTO.md +30 -0
  158. package/docs/SignatureFieldDTO.md +46 -0
  159. package/docs/SignatureFieldInput.md +36 -0
  160. package/docs/SignatureFieldValue.md +24 -0
  161. package/docs/SignatureRecipientDTO.md +8 -0
  162. package/docs/SignatureRecipientInput.md +13 -1
  163. package/docs/SignatureTemplateDTO.md +42 -0
  164. package/docs/SignatureTemplateField.md +38 -0
  165. package/docs/SignatureTemplateRequest.md +34 -0
  166. package/docs/SignatureTemplateRole.md +26 -0
  167. package/docs/VerifyOtpRequest.md +20 -0
  168. package/models/ai-models-response.ts +51 -0
  169. package/models/apply-signature-request.ts +5 -0
  170. package/models/bulk-row-result.ts +23 -0
  171. package/models/bulk-row.ts +27 -0
  172. package/models/bulk-send-request.ts +27 -0
  173. package/models/bulk-send-response.ts +26 -0
  174. package/models/create-signature-envelope-request.ts +5 -0
  175. package/models/embed-url-response.ts +22 -0
  176. package/models/enriched-audit-log.ts +3 -0
  177. package/models/index.ts +18 -0
  178. package/models/instantiate-template-request.ts +30 -0
  179. package/models/list-ai-models-request.ts +41 -0
  180. package/models/public-signature-view.ts +16 -0
  181. package/models/role-binding.ts +25 -0
  182. package/models/search-by-audit-log-request.ts +3 -0
  183. package/models/settings.ts +3 -0
  184. package/models/signature-envelope-dto.ts +6 -0
  185. package/models/signature-event-dto.ts +42 -0
  186. package/models/signature-field-dto.ts +51 -0
  187. package/models/signature-field-input.ts +46 -0
  188. package/models/signature-field-value.ts +22 -0
  189. package/models/signature-recipient-dto.ts +20 -0
  190. package/models/signature-recipient-input.ts +25 -1
  191. package/models/signature-template-dto.ts +37 -0
  192. package/models/signature-template-field.ts +47 -0
  193. package/models/signature-template-request.ts +33 -0
  194. package/models/signature-template-role.ts +38 -0
  195. package/models/verify-otp-request.ts +20 -0
  196. package/package.json +1 -1
  197. package/dist/api/digital-signature-api.d.ts +0 -221
  198. package/dist/esm/api/digital-signature-api.d.ts +0 -221
@@ -1,5 +1,6 @@
1
1
  .gitignore
2
2
  .npmignore
3
+ .openapi-generator-ignore
3
4
  README.md
4
5
  api.ts
5
6
  api/aichat-api.ts
@@ -10,11 +11,13 @@ api/comments-api.ts
10
11
  api/dashboard-api.ts
11
12
  api/delegated-browse-grants-admin-api.ts
12
13
  api/delegated-browse-grants-end-user-api.ts
13
- api/digital-signature-api.ts
14
- api/digital-signature-public-api.ts
15
14
  api/document-controller-api.ts
16
15
  api/document-suggestion-controller-api.ts
17
16
  api/document-version-controller-api.ts
17
+ api/esign-api.ts
18
+ api/esign-enterprise-api.ts
19
+ api/esign-public-api.ts
20
+ api/esign-templates-api.ts
18
21
  api/favorites-api.ts
19
22
  api/file-controller-api.ts
20
23
  api/folder-controller-api.ts
@@ -36,12 +39,17 @@ docs/AiChatConversation.md
36
39
  docs/AiChatRequest.md
37
40
  docs/AiChatResponse.md
38
41
  docs/AiConnectionTestResult.md
42
+ docs/AiModelsResponse.md
39
43
  docs/AiSettingsResponse.md
40
44
  docs/AncestorInfo.md
41
45
  docs/ApplySignatureRequest.md
42
46
  docs/AuditLogDetails.md
43
47
  docs/AuditVerificationResult.md
44
48
  docs/BrokenLink.md
49
+ docs/BulkRow.md
50
+ docs/BulkRowResult.md
51
+ docs/BulkSendRequest.md
52
+ docs/BulkSendResponse.md
45
53
  docs/CollaborationAuditControllerApi.md
46
54
  docs/CollaborationControllerApi.md
47
55
  docs/CommentDTO.md
@@ -69,15 +77,18 @@ docs/DeleteMetadataAudit.md
69
77
  docs/DeleteMetadataRequest.md
70
78
  docs/DeleteRequest.md
71
79
  docs/DeleteShareRequest.md
72
- docs/DigitalSignatureApi.md
73
- docs/DigitalSignaturePublicApi.md
74
80
  docs/DocumentControllerApi.md
75
81
  docs/DocumentInfo.md
76
82
  docs/DocumentPosition.md
77
83
  docs/DocumentSuggestionControllerApi.md
78
84
  docs/DocumentVersionControllerApi.md
79
85
  docs/DocumentVersionInfo.md
86
+ docs/ESignApi.md
87
+ docs/ESignEnterpriseApi.md
88
+ docs/ESignPublicApi.md
89
+ docs/ESignTemplatesApi.md
80
90
  docs/ElementInfo.md
91
+ docs/EmbedUrlResponse.md
81
92
  docs/EnrichedAuditLog.md
82
93
  docs/EnrichedAuditLogDetails.md
83
94
  docs/FavoritesApi.md
@@ -88,6 +99,8 @@ docs/FolderControllerApi.md
88
99
  docs/FolderElementInfo.md
89
100
  docs/FolderResponse.md
90
101
  docs/IngestionStatusDto.md
102
+ docs/InstantiateTemplateRequest.md
103
+ docs/ListAiModelsRequest.md
91
104
  docs/MintUploadTokenRequest.md
92
105
  docs/MoveAudit.md
93
106
  docs/MoveRequest.md
@@ -99,6 +112,7 @@ docs/RenameRequest.md
99
112
  docs/ReplaceAudit.md
100
113
  docs/RestoreVersionAudit.md
101
114
  docs/RestoreVersionResponse.md
115
+ docs/RoleBinding.md
102
116
  docs/SaveAiSettingsRequest.md
103
117
  docs/ScanAgentApi.md
104
118
  docs/ScanJobStatusDto.md
@@ -117,9 +131,17 @@ docs/ShareResultItem.md
117
131
  docs/ShareResultResponse.md
118
132
  docs/SignatureArchiveDTO.md
119
133
  docs/SignatureEnvelopeDTO.md
134
+ docs/SignatureEventDTO.md
135
+ docs/SignatureFieldDTO.md
136
+ docs/SignatureFieldInput.md
120
137
  docs/SignatureFieldPlacement.md
138
+ docs/SignatureFieldValue.md
121
139
  docs/SignatureRecipientDTO.md
122
140
  docs/SignatureRecipientInput.md
141
+ docs/SignatureTemplateDTO.md
142
+ docs/SignatureTemplateField.md
143
+ docs/SignatureTemplateRequest.md
144
+ docs/SignatureTemplateRole.md
123
145
  docs/SortInput.md
124
146
  docs/StorageBreakdown.md
125
147
  docs/Suggest.md
@@ -142,6 +164,7 @@ docs/UserPreferencesRequest.md
142
164
  docs/UserPrivacyApi.md
143
165
  docs/UserPrivacyDTO.md
144
166
  docs/UserRegistrationRequest.md
167
+ docs/VerifyOtpRequest.md
145
168
  docs/WebhookProxyControllerApi.md
146
169
  git_push.sh
147
170
  index.ts
@@ -149,12 +172,17 @@ models/ai-chat-conversation.ts
149
172
  models/ai-chat-request.ts
150
173
  models/ai-chat-response.ts
151
174
  models/ai-connection-test-result.ts
175
+ models/ai-models-response.ts
152
176
  models/ai-settings-response.ts
153
177
  models/ancestor-info.ts
154
178
  models/apply-signature-request.ts
155
179
  models/audit-log-details.ts
156
180
  models/audit-verification-result.ts
157
181
  models/broken-link.ts
182
+ models/bulk-row-result.ts
183
+ models/bulk-row.ts
184
+ models/bulk-send-request.ts
185
+ models/bulk-send-response.ts
158
186
  models/comment-dto.ts
159
187
  models/consume-delegated-grant-request.ts
160
188
  models/copy-audit.ts
@@ -180,6 +208,7 @@ models/document-info.ts
180
208
  models/document-position.ts
181
209
  models/document-version-info.ts
182
210
  models/element-info.ts
211
+ models/embed-url-response.ts
183
212
  models/enriched-audit-log-details.ts
184
213
  models/enriched-audit-log.ts
185
214
  models/file-type-stats.ts
@@ -188,6 +217,8 @@ models/folder-element-info.ts
188
217
  models/folder-response.ts
189
218
  models/index.ts
190
219
  models/ingestion-status-dto.ts
220
+ models/instantiate-template-request.ts
221
+ models/list-ai-models-request.ts
191
222
  models/mint-upload-token-request.ts
192
223
  models/move-audit.ts
193
224
  models/move-request.ts
@@ -198,6 +229,7 @@ models/rename-request.ts
198
229
  models/replace-audit.ts
199
230
  models/restore-version-audit.ts
200
231
  models/restore-version-response.ts
232
+ models/role-binding.ts
201
233
  models/save-ai-settings-request.ts
202
234
  models/scan-job-status-dto.ts
203
235
  models/scan-request-dto.ts
@@ -212,9 +244,17 @@ models/share-result-item.ts
212
244
  models/share-result-response.ts
213
245
  models/signature-archive-dto.ts
214
246
  models/signature-envelope-dto.ts
247
+ models/signature-event-dto.ts
248
+ models/signature-field-dto.ts
249
+ models/signature-field-input.ts
215
250
  models/signature-field-placement.ts
251
+ models/signature-field-value.ts
216
252
  models/signature-recipient-dto.ts
217
253
  models/signature-recipient-input.ts
254
+ models/signature-template-dto.ts
255
+ models/signature-template-field.ts
256
+ models/signature-template-request.ts
257
+ models/signature-template-role.ts
218
258
  models/sort-input.ts
219
259
  models/storage-breakdown.ts
220
260
  models/suggest.ts
@@ -234,6 +274,7 @@ models/upload-token-response.ts
234
274
  models/user-preferences-request.ts
235
275
  models/user-privacy-dto.ts
236
276
  models/user-registration-request.ts
277
+ models/verify-otp-request.ts
237
278
  package.json
238
279
  tsconfig.esm.json
239
280
  tsconfig.json
@@ -1 +1 @@
1
- e7f7122532a793922a11b290c9c247fd88c81c567ff69dc5fe5a024b7a185118
1
+ 4ab2ed4c0ba88058cd1a0128113a639445da90c263d1f825c71122d767b2458f
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- ## @openfilz-sdk/typescript-ee@1.8.0
1
+ ## @openfilz-sdk/typescript-ee@1.8.2
2
2
 
3
3
  This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
4
4
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
36
36
  _published:_
37
37
 
38
38
  ```
39
- npm install @openfilz-sdk/typescript-ee@1.8.0 --save
39
+ npm install @openfilz-sdk/typescript-ee@1.8.2 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
@@ -57,6 +57,7 @@ Class | Method | HTTP request | Description
57
57
  *AIChatApi* | [**listConversations**](docs/AIChatApi.md#listconversations) | **GET** /api/v1/ai/conversations | List conversations
58
58
  *AISettingsApi* | [**deleteSettings**](docs/AISettingsApi.md#deletesettings) | **DELETE** /api/v1/settings/ai | Reset my AI settings
59
59
  *AISettingsApi* | [**getSettings1**](docs/AISettingsApi.md#getsettings1) | **GET** /api/v1/settings/ai | Get my AI settings
60
+ *AISettingsApi* | [**listModels**](docs/AISettingsApi.md#listmodels) | **POST** /api/v1/settings/ai/models | List the provider\'s chat models
60
61
  *AISettingsApi* | [**saveSettings1**](docs/AISettingsApi.md#savesettings1) | **PUT** /api/v1/settings/ai | Save my AI settings
61
62
  *AISettingsApi* | [**testConnection**](docs/AISettingsApi.md#testconnection) | **POST** /api/v1/settings/ai/test | Test AI provider connection
62
63
  *CollaborationAuditControllerApi* | [**getAuditTrail**](docs/CollaborationAuditControllerApi.md#getaudittrail) | **GET** /api/v1/audit/{id} | Get audit trail for a resource (enriched with actor azp)
@@ -91,17 +92,6 @@ Class | Method | HTTP request | Description
91
92
  *DelegatedBrowseGrantsEndUserApi* | [**disableLinkedWebhook**](docs/DelegatedBrowseGrantsEndUserApi.md#disablelinkedwebhook) | **POST** /api/v1/users/me/delegated/grants/{id}/disable-webhook | Disable the webhook created from this grant
92
93
  *DelegatedBrowseGrantsEndUserApi* | [**listIncoming**](docs/DelegatedBrowseGrantsEndUserApi.md#listincoming) | **GET** /api/v1/users/me/delegated/grants | List grants addressed to me
93
94
  *DelegatedBrowseGrantsEndUserApi* | [**revoke**](docs/DelegatedBrowseGrantsEndUserApi.md#revoke) | **POST** /api/v1/users/me/delegated/grants/{id}/revoke | Revoke an accepted grant
94
- *DigitalSignatureApi* | [**archive**](docs/DigitalSignatureApi.md#archive) | **GET** /api/v1/signatures/{id}/archive | Get the PDF/A archive + veraPDF compliance for a completed envelope
95
- *DigitalSignatureApi* | [**cancel**](docs/DigitalSignatureApi.md#cancel) | **POST** /api/v1/signatures/{id}/cancel | Cancel a non-terminal envelope
96
- *DigitalSignatureApi* | [**create**](docs/DigitalSignatureApi.md#create) | **POST** /api/v1/signatures | Create and send a signature envelope
97
- *DigitalSignatureApi* | [**get1**](docs/DigitalSignatureApi.md#get1) | **GET** /api/v1/signatures/{id} | Get a single envelope I sent
98
- *DigitalSignatureApi* | [**listSent**](docs/DigitalSignatureApi.md#listsent) | **GET** /api/v1/signatures | List envelopes I sent for signature
99
- *DigitalSignatureApi* | [**listToSign**](docs/DigitalSignatureApi.md#listtosign) | **GET** /api/v1/signatures/to-sign | List documents waiting for my signature
100
- *DigitalSignaturePublicApi* | [**decline1**](docs/DigitalSignaturePublicApi.md#decline1) | **POST** /api/v1/public/signatures/decline | Decline to sign (voids the envelope)
101
- *DigitalSignaturePublicApi* | [**document**](docs/DigitalSignaturePublicApi.md#document) | **GET** /api/v1/public/signatures/document | Stream the source PDF for signing
102
- *DigitalSignaturePublicApi* | [**markViewed**](docs/DigitalSignaturePublicApi.md#markviewed) | **POST** /api/v1/public/signatures/viewed | Record that the recipient opened the document
103
- *DigitalSignaturePublicApi* | [**sign**](docs/DigitalSignaturePublicApi.md#sign) | **POST** /api/v1/public/signatures/sign | Apply the recipient\'s signature
104
- *DigitalSignaturePublicApi* | [**view**](docs/DigitalSignaturePublicApi.md#view) | **GET** /api/v1/public/signatures | Resolve a signing token to its envelope view
105
95
  *DocumentControllerApi* | [**createBlankDocument**](docs/DocumentControllerApi.md#createblankdocument) | **POST** /api/v1/documents/create-blank | Create a blank document from template
106
96
  *DocumentControllerApi* | [**deleteDocumentMetadata**](docs/DocumentControllerApi.md#deletedocumentmetadata) | **DELETE** /api/v1/documents/{documentId}/metadata | Delete specific metadata keys
107
97
  *DocumentControllerApi* | [**downloadDocument**](docs/DocumentControllerApi.md#downloaddocument) | **GET** /api/v1/documents/{documentId}/download | Download a document
@@ -121,6 +111,31 @@ Class | Method | HTTP request | Description
121
111
  *DocumentVersionControllerApi* | [**downloadVersion**](docs/DocumentVersionControllerApi.md#downloadversion) | **GET** /api/v1/documents/{documentId}/versions/{versionId}/download | Download a specific document version
122
112
  *DocumentVersionControllerApi* | [**listVersions**](docs/DocumentVersionControllerApi.md#listversions) | **GET** /api/v1/documents/{documentId}/versions | List document versions
123
113
  *DocumentVersionControllerApi* | [**restoreVersion**](docs/DocumentVersionControllerApi.md#restoreversion) | **POST** /api/v1/documents/{documentId}/versions/{versionId}/restore | Restore a previous document version
114
+ *ESignApi* | [**cancel**](docs/ESignApi.md#cancel) | **POST** /api/v1/signatures/{id}/cancel | Cancel a non-terminal envelope
115
+ *ESignApi* | [**create**](docs/ESignApi.md#create) | **POST** /api/v1/signatures | Create an envelope (sent immediately unless send=false)
116
+ *ESignApi* | [**events**](docs/ESignApi.md#events) | **GET** /api/v1/signatures/{id}/events | Audit trail of one of my envelopes
117
+ *ESignApi* | [**get2**](docs/ESignApi.md#get2) | **GET** /api/v1/signatures/{id} | Get one of my envelopes (recipients + fields)
118
+ *ESignApi* | [**listSent**](docs/ESignApi.md#listsent) | **GET** /api/v1/signatures | List envelopes I sent for signature
119
+ *ESignApi* | [**listToSign**](docs/ESignApi.md#listtosign) | **GET** /api/v1/signatures/to-sign | List envelopes waiting for my signature
120
+ *ESignApi* | [**resend**](docs/ESignApi.md#resend) | **POST** /api/v1/signatures/{id}/recipients/{recipientId}/resend | Resend the signing link to a recipient (new token, previous one revoked)
121
+ *ESignApi* | [**send**](docs/ESignApi.md#send) | **POST** /api/v1/signatures/{id}/send | Send a DRAFT envelope
122
+ *ESignApi* | [**signedDocument**](docs/ESignApi.md#signeddocument) | **GET** /api/v1/signatures/{id}/signed-document | Download the sealed PDF of a completed envelope
123
+ *ESignEnterpriseApi* | [**archive**](docs/ESignEnterpriseApi.md#archive) | **GET** /api/v1/signatures/{id}/archive | PDF/A-2b archive + veraPDF compliance for a completed envelope
124
+ *ESignEnterpriseApi* | [**bulk**](docs/ESignEnterpriseApi.md#bulk) | **POST** /api/v1/signatures/bulk | Create (and send) one envelope per row from a template
125
+ *ESignEnterpriseApi* | [**embedUrl**](docs/ESignEnterpriseApi.md#embedurl) | **POST** /api/v1/signatures/{id}/recipients/{recipientId}/embed-url | Mint an embedded-signing URL for a recipient (rotates the token; no email is sent)
126
+ *ESignPublicApi* | [**decline1**](docs/ESignPublicApi.md#decline1) | **POST** /api/v1/public/signatures/decline | Decline to sign (voids the envelope)
127
+ *ESignPublicApi* | [**document**](docs/ESignPublicApi.md#document) | **GET** /api/v1/public/signatures/document | Stream the source PDF for signing
128
+ *ESignPublicApi* | [**markViewed**](docs/ESignPublicApi.md#markviewed) | **POST** /api/v1/public/signatures/viewed | Record that the recipient opened the document
129
+ *ESignPublicApi* | [**requestOtp**](docs/ESignPublicApi.md#requestotp) | **POST** /api/v1/public/signatures/otp/request | Send a one-time access code to the recipient (EMAIL_OTP / SMS_OTP)
130
+ *ESignPublicApi* | [**sign**](docs/ESignPublicApi.md#sign) | **POST** /api/v1/public/signatures/sign | Submit the recipient\'s fields and sign
131
+ *ESignPublicApi* | [**verifyOtp**](docs/ESignPublicApi.md#verifyotp) | **POST** /api/v1/public/signatures/otp/verify | Verify the one-time access code
132
+ *ESignPublicApi* | [**view**](docs/ESignPublicApi.md#view) | **GET** /api/v1/public/signatures | Resolve a signing token to its envelope view
133
+ *ESignTemplatesApi* | [**_delete**](docs/ESignTemplatesApi.md#_delete) | **DELETE** /api/v1/signature-templates/{id} | Delete a template
134
+ *ESignTemplatesApi* | [**create1**](docs/ESignTemplatesApi.md#create1) | **POST** /api/v1/signature-templates | Create a template
135
+ *ESignTemplatesApi* | [**get1**](docs/ESignTemplatesApi.md#get1) | **GET** /api/v1/signature-templates/{id} | Get a template
136
+ *ESignTemplatesApi* | [**instantiate**](docs/ESignTemplatesApi.md#instantiate) | **POST** /api/v1/signature-templates/{id}/envelopes | Create (and send) an envelope from a template
137
+ *ESignTemplatesApi* | [**list**](docs/ESignTemplatesApi.md#list) | **GET** /api/v1/signature-templates | List my templates
138
+ *ESignTemplatesApi* | [**update1**](docs/ESignTemplatesApi.md#update1) | **PUT** /api/v1/signature-templates/{id} | Update a template
124
139
  *FavoritesApi* | [**addFavorite**](docs/FavoritesApi.md#addfavorite) | **POST** /api/v1/favorites/{documentId} | Add document to favorites
125
140
  *FavoritesApi* | [**isFavorite**](docs/FavoritesApi.md#isfavorite) | **GET** /api/v1/favorites/{documentId}/is-favorite | Check favorite status
126
141
  *FavoritesApi* | [**removeFavorite**](docs/FavoritesApi.md#removefavorite) | **DELETE** /api/v1/favorites/{documentId} | Remove document from favorites
@@ -182,12 +197,17 @@ Class | Method | HTTP request | Description
182
197
  - [AiChatRequest](docs/AiChatRequest.md)
183
198
  - [AiChatResponse](docs/AiChatResponse.md)
184
199
  - [AiConnectionTestResult](docs/AiConnectionTestResult.md)
200
+ - [AiModelsResponse](docs/AiModelsResponse.md)
185
201
  - [AiSettingsResponse](docs/AiSettingsResponse.md)
186
202
  - [AncestorInfo](docs/AncestorInfo.md)
187
203
  - [ApplySignatureRequest](docs/ApplySignatureRequest.md)
188
204
  - [AuditLogDetails](docs/AuditLogDetails.md)
189
205
  - [AuditVerificationResult](docs/AuditVerificationResult.md)
190
206
  - [BrokenLink](docs/BrokenLink.md)
207
+ - [BulkRow](docs/BulkRow.md)
208
+ - [BulkRowResult](docs/BulkRowResult.md)
209
+ - [BulkSendRequest](docs/BulkSendRequest.md)
210
+ - [BulkSendResponse](docs/BulkSendResponse.md)
191
211
  - [CommentDTO](docs/CommentDTO.md)
192
212
  - [ConsumeDelegatedGrantRequest](docs/ConsumeDelegatedGrantRequest.md)
193
213
  - [CopyAudit](docs/CopyAudit.md)
@@ -213,6 +233,7 @@ Class | Method | HTTP request | Description
213
233
  - [DocumentPosition](docs/DocumentPosition.md)
214
234
  - [DocumentVersionInfo](docs/DocumentVersionInfo.md)
215
235
  - [ElementInfo](docs/ElementInfo.md)
236
+ - [EmbedUrlResponse](docs/EmbedUrlResponse.md)
216
237
  - [EnrichedAuditLog](docs/EnrichedAuditLog.md)
217
238
  - [EnrichedAuditLogDetails](docs/EnrichedAuditLogDetails.md)
218
239
  - [FileTypeStats](docs/FileTypeStats.md)
@@ -220,6 +241,8 @@ Class | Method | HTTP request | Description
220
241
  - [FolderElementInfo](docs/FolderElementInfo.md)
221
242
  - [FolderResponse](docs/FolderResponse.md)
222
243
  - [IngestionStatusDto](docs/IngestionStatusDto.md)
244
+ - [InstantiateTemplateRequest](docs/InstantiateTemplateRequest.md)
245
+ - [ListAiModelsRequest](docs/ListAiModelsRequest.md)
223
246
  - [MintUploadTokenRequest](docs/MintUploadTokenRequest.md)
224
247
  - [MoveAudit](docs/MoveAudit.md)
225
248
  - [MoveRequest](docs/MoveRequest.md)
@@ -230,6 +253,7 @@ Class | Method | HTTP request | Description
230
253
  - [ReplaceAudit](docs/ReplaceAudit.md)
231
254
  - [RestoreVersionAudit](docs/RestoreVersionAudit.md)
232
255
  - [RestoreVersionResponse](docs/RestoreVersionResponse.md)
256
+ - [RoleBinding](docs/RoleBinding.md)
233
257
  - [SaveAiSettingsRequest](docs/SaveAiSettingsRequest.md)
234
258
  - [ScanJobStatusDto](docs/ScanJobStatusDto.md)
235
259
  - [ScanRequestDto](docs/ScanRequestDto.md)
@@ -244,9 +268,17 @@ Class | Method | HTTP request | Description
244
268
  - [ShareResultResponse](docs/ShareResultResponse.md)
245
269
  - [SignatureArchiveDTO](docs/SignatureArchiveDTO.md)
246
270
  - [SignatureEnvelopeDTO](docs/SignatureEnvelopeDTO.md)
271
+ - [SignatureEventDTO](docs/SignatureEventDTO.md)
272
+ - [SignatureFieldDTO](docs/SignatureFieldDTO.md)
273
+ - [SignatureFieldInput](docs/SignatureFieldInput.md)
247
274
  - [SignatureFieldPlacement](docs/SignatureFieldPlacement.md)
275
+ - [SignatureFieldValue](docs/SignatureFieldValue.md)
248
276
  - [SignatureRecipientDTO](docs/SignatureRecipientDTO.md)
249
277
  - [SignatureRecipientInput](docs/SignatureRecipientInput.md)
278
+ - [SignatureTemplateDTO](docs/SignatureTemplateDTO.md)
279
+ - [SignatureTemplateField](docs/SignatureTemplateField.md)
280
+ - [SignatureTemplateRequest](docs/SignatureTemplateRequest.md)
281
+ - [SignatureTemplateRole](docs/SignatureTemplateRole.md)
250
282
  - [SortInput](docs/SortInput.md)
251
283
  - [StorageBreakdown](docs/StorageBreakdown.md)
252
284
  - [Suggest](docs/Suggest.md)
@@ -266,6 +298,7 @@ Class | Method | HTTP request | Description
266
298
  - [UserPreferencesRequest](docs/UserPreferencesRequest.md)
267
299
  - [UserPrivacyDTO](docs/UserPrivacyDTO.md)
268
300
  - [UserRegistrationRequest](docs/UserRegistrationRequest.md)
301
+ - [VerifyOtpRequest](docs/VerifyOtpRequest.md)
269
302
 
270
303
 
271
304
  <a id="documentation-for-authorization"></a>
@@ -24,8 +24,12 @@ import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError
24
24
  // @ts-ignore
25
25
  import type { AiConnectionTestResult } from '../models';
26
26
  // @ts-ignore
27
+ import type { AiModelsResponse } from '../models';
28
+ // @ts-ignore
27
29
  import type { AiSettingsResponse } from '../models';
28
30
  // @ts-ignore
31
+ import type { ListAiModelsRequest } from '../models';
32
+ // @ts-ignore
29
33
  import type { SaveAiSettingsRequest } from '../models';
30
34
  /**
31
35
  * AISettingsApi - axios parameter creator
@@ -99,6 +103,45 @@ export const AISettingsApiAxiosParamCreator = function (configuration?: Configur
99
103
  options: localVarRequestOptions,
100
104
  };
101
105
  },
106
+ /**
107
+ * Ask the provider which chat models this key can use, so the picker reflects what exists today rather than a list baked into a release. Falls back to a built-in list (source=FALLBACK) when the provider cannot be reached. POST rather than GET because the key travels in the body, never in a query string; omit apiKey to use the stored key.
108
+ * @summary List the provider\'s chat models
109
+ * @param {ListAiModelsRequest} listAiModelsRequest
110
+ * @param {*} [options] Override http request option.
111
+ * @throws {RequiredError}
112
+ */
113
+ listModels: async (listAiModelsRequest: ListAiModelsRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
114
+ // verify required parameter 'listAiModelsRequest' is not null or undefined
115
+ assertParamExists('listModels', 'listAiModelsRequest', listAiModelsRequest)
116
+ const localVarPath = `/api/v1/settings/ai/models`;
117
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
118
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
119
+ let baseOptions;
120
+ if (configuration) {
121
+ baseOptions = configuration.baseOptions;
122
+ }
123
+
124
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
125
+ const localVarHeaderParameter = {} as any;
126
+ const localVarQueryParameter = {} as any;
127
+
128
+ // authentication keycloak_auth required
129
+ // http bearer authentication required
130
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
131
+
132
+ localVarHeaderParameter['Content-Type'] = 'application/json';
133
+ localVarHeaderParameter['Accept'] = 'application/json';
134
+
135
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
136
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
137
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
138
+ localVarRequestOptions.data = serializeDataIfNeeded(listAiModelsRequest, localVarRequestOptions, configuration)
139
+
140
+ return {
141
+ url: toPathString(localVarUrlObj),
142
+ options: localVarRequestOptions,
143
+ };
144
+ },
102
145
  /**
103
146
  * Set the chat LLM to use for my conversations. Omit apiKey to keep the previously stored key.
104
147
  * @summary Save my AI settings
@@ -210,6 +253,19 @@ export const AISettingsApiFp = function(configuration?: Configuration) {
210
253
  const localVarOperationServerBasePath = operationServerMap['AISettingsApi.getSettings1']?.[localVarOperationServerIndex]?.url;
211
254
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
212
255
  },
256
+ /**
257
+ * Ask the provider which chat models this key can use, so the picker reflects what exists today rather than a list baked into a release. Falls back to a built-in list (source=FALLBACK) when the provider cannot be reached. POST rather than GET because the key travels in the body, never in a query string; omit apiKey to use the stored key.
258
+ * @summary List the provider\'s chat models
259
+ * @param {ListAiModelsRequest} listAiModelsRequest
260
+ * @param {*} [options] Override http request option.
261
+ * @throws {RequiredError}
262
+ */
263
+ async listModels(listAiModelsRequest: ListAiModelsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AiModelsResponse>> {
264
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listModels(listAiModelsRequest, options);
265
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
266
+ const localVarOperationServerBasePath = operationServerMap['AISettingsApi.listModels']?.[localVarOperationServerIndex]?.url;
267
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
268
+ },
213
269
  /**
214
270
  * Set the chat LLM to use for my conversations. Omit apiKey to keep the previously stored key.
215
271
  * @summary Save my AI settings
@@ -263,6 +319,16 @@ export const AISettingsApiFactory = function (configuration?: Configuration, bas
263
319
  getSettings1(options?: RawAxiosRequestConfig): AxiosPromise<AiSettingsResponse> {
264
320
  return localVarFp.getSettings1(options).then((request) => request(axios, basePath));
265
321
  },
322
+ /**
323
+ * Ask the provider which chat models this key can use, so the picker reflects what exists today rather than a list baked into a release. Falls back to a built-in list (source=FALLBACK) when the provider cannot be reached. POST rather than GET because the key travels in the body, never in a query string; omit apiKey to use the stored key.
324
+ * @summary List the provider\'s chat models
325
+ * @param {ListAiModelsRequest} listAiModelsRequest
326
+ * @param {*} [options] Override http request option.
327
+ * @throws {RequiredError}
328
+ */
329
+ listModels(listAiModelsRequest: ListAiModelsRequest, options?: RawAxiosRequestConfig): AxiosPromise<AiModelsResponse> {
330
+ return localVarFp.listModels(listAiModelsRequest, options).then((request) => request(axios, basePath));
331
+ },
266
332
  /**
267
333
  * Set the chat LLM to use for my conversations. Omit apiKey to keep the previously stored key.
268
334
  * @summary Save my AI settings
@@ -310,6 +376,17 @@ export class AISettingsApi extends BaseAPI {
310
376
  return AISettingsApiFp(this.configuration).getSettings1(options).then((request) => request(this.axios, this.basePath));
311
377
  }
312
378
 
379
+ /**
380
+ * Ask the provider which chat models this key can use, so the picker reflects what exists today rather than a list baked into a release. Falls back to a built-in list (source=FALLBACK) when the provider cannot be reached. POST rather than GET because the key travels in the body, never in a query string; omit apiKey to use the stored key.
381
+ * @summary List the provider\'s chat models
382
+ * @param {ListAiModelsRequest} listAiModelsRequest
383
+ * @param {*} [options] Override http request option.
384
+ * @throws {RequiredError}
385
+ */
386
+ public listModels(listAiModelsRequest: ListAiModelsRequest, options?: RawAxiosRequestConfig) {
387
+ return AISettingsApiFp(this.configuration).listModels(listAiModelsRequest, options).then((request) => request(this.axios, this.basePath));
388
+ }
389
+
313
390
  /**
314
391
  * Set the chat LLM to use for my conversations. Omit apiKey to keep the previously stored key.
315
392
  * @summary Save my AI settings