@openfilz-sdk/typescript-ee 1.8.1 → 1.8.3

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 (180) hide show
  1. package/.openapi-generator/FILES +40 -4
  2. package/.openapi-generator/openfilz-api-generate-typescript-sdk.sha256 +1 -1
  3. package/README.md +43 -13
  4. package/api/esign-api.ts +719 -0
  5. package/api/esign-enterprise-api.ts +286 -0
  6. package/api/{digital-signature-public-api.ts → esign-public-api.ts} +183 -24
  7. package/api/{digital-signature-api.ts → esign-templates-api.ts} +137 -113
  8. package/api.ts +4 -2
  9. package/dist/api/esign-api.d.ts +334 -0
  10. package/dist/api/esign-api.js +693 -0
  11. package/dist/api/esign-enterprise-api.d.ts +138 -0
  12. package/dist/api/esign-enterprise-api.js +278 -0
  13. package/dist/{esm/api/digital-signature-public-api.d.ts → api/esign-public-api.d.ts} +81 -12
  14. package/dist/api/{digital-signature-public-api.js → esign-public-api.js} +178 -29
  15. package/dist/api/esign-templates-api.d.ts +234 -0
  16. package/dist/api/{digital-signature-api.js → esign-templates-api.js} +137 -115
  17. package/dist/api.d.ts +4 -2
  18. package/dist/api.js +4 -2
  19. package/dist/esm/api/esign-api.d.ts +334 -0
  20. package/dist/esm/api/esign-api.js +686 -0
  21. package/dist/esm/api/esign-enterprise-api.d.ts +138 -0
  22. package/dist/esm/api/esign-enterprise-api.js +271 -0
  23. package/dist/{api/digital-signature-public-api.d.ts → esm/api/esign-public-api.d.ts} +81 -12
  24. package/dist/esm/api/{digital-signature-public-api.js → esign-public-api.js} +173 -24
  25. package/dist/esm/api/esign-templates-api.d.ts +234 -0
  26. package/dist/esm/api/{digital-signature-api.js → esign-templates-api.js} +132 -110
  27. package/dist/esm/api.d.ts +4 -2
  28. package/dist/esm/api.js +4 -2
  29. package/dist/esm/models/apply-signature-request.d.ts +3 -0
  30. package/dist/esm/models/bulk-row-result.d.ts +17 -0
  31. package/dist/esm/models/bulk-row-result.js +14 -0
  32. package/dist/esm/models/bulk-row.d.ts +19 -0
  33. package/dist/esm/models/bulk-row.js +14 -0
  34. package/dist/esm/models/bulk-send-request.d.ts +19 -0
  35. package/dist/esm/models/bulk-send-request.js +14 -0
  36. package/dist/esm/models/bulk-send-response.d.ts +18 -0
  37. package/dist/esm/models/bulk-send-response.js +14 -0
  38. package/dist/esm/models/create-signature-envelope-request.d.ts +5 -0
  39. package/dist/esm/models/embed-url-response.d.ts +16 -0
  40. package/dist/esm/models/embed-url-response.js +14 -0
  41. package/dist/esm/models/enriched-audit-log.d.ts +3 -0
  42. package/dist/esm/models/enriched-audit-log.js +3 -0
  43. package/dist/esm/models/index.d.ts +16 -0
  44. package/dist/esm/models/index.js +16 -0
  45. package/dist/esm/models/instantiate-template-request.d.ts +22 -0
  46. package/dist/esm/models/instantiate-template-request.js +14 -0
  47. package/dist/esm/models/public-signature-view.d.ts +13 -0
  48. package/dist/esm/models/public-signature-view.js +5 -0
  49. package/dist/esm/models/role-binding.d.ts +19 -0
  50. package/dist/esm/models/role-binding.js +14 -0
  51. package/dist/esm/models/search-by-audit-log-request.d.ts +3 -0
  52. package/dist/esm/models/search-by-audit-log-request.js +3 -0
  53. package/dist/esm/models/settings.d.ts +3 -0
  54. package/dist/esm/models/signature-envelope-dto.d.ts +6 -0
  55. package/dist/esm/models/signature-event-dto.d.ts +33 -0
  56. package/dist/esm/models/signature-event-dto.js +26 -0
  57. package/dist/esm/models/signature-field-dto.d.ts +44 -0
  58. package/dist/esm/models/signature-field-dto.js +27 -0
  59. package/dist/esm/models/signature-field-input.d.ts +39 -0
  60. package/dist/esm/models/signature-field-input.js +27 -0
  61. package/dist/esm/models/signature-field-value.d.ts +16 -0
  62. package/dist/esm/models/signature-field-value.js +14 -0
  63. package/dist/esm/models/signature-recipient-dto.d.ts +16 -0
  64. package/dist/esm/models/signature-recipient-dto.js +9 -0
  65. package/dist/esm/models/signature-recipient-input.d.ts +19 -1
  66. package/dist/esm/models/signature-recipient-input.js +9 -1
  67. package/dist/esm/models/signature-template-dto.d.ts +27 -0
  68. package/dist/esm/models/signature-template-dto.js +14 -0
  69. package/dist/esm/models/signature-template-field.d.ts +40 -0
  70. package/dist/esm/models/signature-template-field.js +27 -0
  71. package/dist/esm/models/signature-template-request.d.ts +23 -0
  72. package/dist/esm/models/signature-template-request.js +14 -0
  73. package/dist/esm/models/signature-template-role.d.ts +28 -0
  74. package/dist/esm/models/signature-template-role.js +22 -0
  75. package/dist/esm/models/verify-otp-request.d.ts +14 -0
  76. package/dist/esm/models/verify-otp-request.js +14 -0
  77. package/dist/models/apply-signature-request.d.ts +3 -0
  78. package/dist/models/bulk-row-result.d.ts +17 -0
  79. package/dist/models/bulk-row-result.js +15 -0
  80. package/dist/models/bulk-row.d.ts +19 -0
  81. package/dist/models/bulk-row.js +15 -0
  82. package/dist/models/bulk-send-request.d.ts +19 -0
  83. package/dist/models/bulk-send-request.js +15 -0
  84. package/dist/models/bulk-send-response.d.ts +18 -0
  85. package/dist/models/bulk-send-response.js +15 -0
  86. package/dist/models/create-signature-envelope-request.d.ts +5 -0
  87. package/dist/models/embed-url-response.d.ts +16 -0
  88. package/dist/models/embed-url-response.js +15 -0
  89. package/dist/models/enriched-audit-log.d.ts +3 -0
  90. package/dist/models/enriched-audit-log.js +3 -0
  91. package/dist/models/index.d.ts +16 -0
  92. package/dist/models/index.js +16 -0
  93. package/dist/models/instantiate-template-request.d.ts +22 -0
  94. package/dist/models/instantiate-template-request.js +15 -0
  95. package/dist/models/public-signature-view.d.ts +13 -0
  96. package/dist/models/public-signature-view.js +6 -1
  97. package/dist/models/role-binding.d.ts +19 -0
  98. package/dist/models/role-binding.js +15 -0
  99. package/dist/models/search-by-audit-log-request.d.ts +3 -0
  100. package/dist/models/search-by-audit-log-request.js +3 -0
  101. package/dist/models/settings.d.ts +3 -0
  102. package/dist/models/signature-envelope-dto.d.ts +6 -0
  103. package/dist/models/signature-event-dto.d.ts +33 -0
  104. package/dist/models/signature-event-dto.js +29 -0
  105. package/dist/models/signature-field-dto.d.ts +44 -0
  106. package/dist/models/signature-field-dto.js +30 -0
  107. package/dist/models/signature-field-input.d.ts +39 -0
  108. package/dist/models/signature-field-input.js +30 -0
  109. package/dist/models/signature-field-value.d.ts +16 -0
  110. package/dist/models/signature-field-value.js +15 -0
  111. package/dist/models/signature-recipient-dto.d.ts +16 -0
  112. package/dist/models/signature-recipient-dto.js +10 -1
  113. package/dist/models/signature-recipient-input.d.ts +19 -1
  114. package/dist/models/signature-recipient-input.js +10 -0
  115. package/dist/models/signature-template-dto.d.ts +27 -0
  116. package/dist/models/signature-template-dto.js +15 -0
  117. package/dist/models/signature-template-field.d.ts +40 -0
  118. package/dist/models/signature-template-field.js +30 -0
  119. package/dist/models/signature-template-request.d.ts +23 -0
  120. package/dist/models/signature-template-request.js +15 -0
  121. package/dist/models/signature-template-role.d.ts +28 -0
  122. package/dist/models/signature-template-role.js +25 -0
  123. package/dist/models/verify-otp-request.d.ts +14 -0
  124. package/dist/models/verify-otp-request.js +15 -0
  125. package/docs/ApplySignatureRequest.md +4 -0
  126. package/docs/BulkRow.md +28 -0
  127. package/docs/BulkRowResult.md +26 -0
  128. package/docs/BulkSendRequest.md +28 -0
  129. package/docs/BulkSendResponse.md +26 -0
  130. package/docs/CreateSignatureEnvelopeRequest.md +10 -0
  131. package/docs/ESignApi.md +463 -0
  132. package/docs/ESignEnterpriseApi.md +164 -0
  133. package/docs/{DigitalSignaturePublicApi.md → ESignPublicApi.md} +118 -12
  134. package/docs/{DigitalSignatureApi.md → ESignTemplatesApi.md} +76 -61
  135. package/docs/EmbedUrlResponse.md +24 -0
  136. package/docs/InstantiateTemplateRequest.md +34 -0
  137. package/docs/PublicSignatureView.md +12 -0
  138. package/docs/RoleBinding.md +30 -0
  139. package/docs/Settings.md +6 -0
  140. package/docs/SignatureEnvelopeDTO.md +12 -0
  141. package/docs/SignatureEventDTO.md +30 -0
  142. package/docs/SignatureFieldDTO.md +46 -0
  143. package/docs/SignatureFieldInput.md +36 -0
  144. package/docs/SignatureFieldValue.md +24 -0
  145. package/docs/SignatureRecipientDTO.md +8 -0
  146. package/docs/SignatureRecipientInput.md +13 -1
  147. package/docs/SignatureTemplateDTO.md +42 -0
  148. package/docs/SignatureTemplateField.md +38 -0
  149. package/docs/SignatureTemplateRequest.md +34 -0
  150. package/docs/SignatureTemplateRole.md +26 -0
  151. package/docs/VerifyOtpRequest.md +20 -0
  152. package/models/apply-signature-request.ts +5 -0
  153. package/models/bulk-row-result.ts +23 -0
  154. package/models/bulk-row.ts +27 -0
  155. package/models/bulk-send-request.ts +27 -0
  156. package/models/bulk-send-response.ts +26 -0
  157. package/models/create-signature-envelope-request.ts +5 -0
  158. package/models/embed-url-response.ts +22 -0
  159. package/models/enriched-audit-log.ts +3 -0
  160. package/models/index.ts +16 -0
  161. package/models/instantiate-template-request.ts +30 -0
  162. package/models/public-signature-view.ts +16 -0
  163. package/models/role-binding.ts +25 -0
  164. package/models/search-by-audit-log-request.ts +3 -0
  165. package/models/settings.ts +3 -0
  166. package/models/signature-envelope-dto.ts +6 -0
  167. package/models/signature-event-dto.ts +42 -0
  168. package/models/signature-field-dto.ts +51 -0
  169. package/models/signature-field-input.ts +46 -0
  170. package/models/signature-field-value.ts +22 -0
  171. package/models/signature-recipient-dto.ts +20 -0
  172. package/models/signature-recipient-input.ts +25 -1
  173. package/models/signature-template-dto.ts +37 -0
  174. package/models/signature-template-field.ts +47 -0
  175. package/models/signature-template-request.ts +33 -0
  176. package/models/signature-template-role.ts +38 -0
  177. package/models/verify-otp-request.ts +20 -0
  178. package/package.json +1 -1
  179. package/dist/api/digital-signature-api.d.ts +0 -221
  180. package/dist/esm/api/digital-signature-api.d.ts +0 -221
@@ -0,0 +1,286 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * openfilz-api
5
+ * API for Document Management System
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+ import type { Configuration } from '../configuration';
17
+ import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
18
+ import globalAxios from 'axios';
19
+ // Some imports not used depending on template conditions
20
+ // @ts-ignore
21
+ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction, replaceWithSerializableTypeIfNeeded } from '../common';
22
+ // @ts-ignore
23
+ import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base';
24
+ // @ts-ignore
25
+ import type { BulkSendRequest } from '../models';
26
+ // @ts-ignore
27
+ import type { BulkSendResponse } from '../models';
28
+ // @ts-ignore
29
+ import type { EmbedUrlResponse } from '../models';
30
+ // @ts-ignore
31
+ import type { SignatureArchiveDTO } from '../models';
32
+ /**
33
+ * ESignEnterpriseApi - axios parameter creator
34
+ */
35
+ export const ESignEnterpriseApiAxiosParamCreator = function (configuration?: Configuration) {
36
+ return {
37
+ /**
38
+ *
39
+ * @summary PDF/A-2b archive + veraPDF compliance for a completed envelope
40
+ * @param {string} id
41
+ * @param {*} [options] Override http request option.
42
+ * @throws {RequiredError}
43
+ */
44
+ archive: async (id: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
45
+ // verify required parameter 'id' is not null or undefined
46
+ assertParamExists('archive', 'id', id)
47
+ const localVarPath = `/api/v1/signatures/{id}/archive`
48
+ .replace('{id}', encodeURIComponent(String(id)));
49
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
50
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
51
+ let baseOptions;
52
+ if (configuration) {
53
+ baseOptions = configuration.baseOptions;
54
+ }
55
+
56
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
57
+ const localVarHeaderParameter = {} as any;
58
+ const localVarQueryParameter = {} as any;
59
+
60
+ // authentication keycloak_auth required
61
+ // http bearer authentication required
62
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
63
+
64
+ localVarHeaderParameter['Accept'] = 'application/json';
65
+
66
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
67
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
68
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
69
+
70
+ return {
71
+ url: toPathString(localVarUrlObj),
72
+ options: localVarRequestOptions,
73
+ };
74
+ },
75
+ /**
76
+ *
77
+ * @summary Create (and send) one envelope per row from a template
78
+ * @param {BulkSendRequest} bulkSendRequest
79
+ * @param {*} [options] Override http request option.
80
+ * @throws {RequiredError}
81
+ */
82
+ bulk: async (bulkSendRequest: BulkSendRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
83
+ // verify required parameter 'bulkSendRequest' is not null or undefined
84
+ assertParamExists('bulk', 'bulkSendRequest', bulkSendRequest)
85
+ const localVarPath = `/api/v1/signatures/bulk`;
86
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
87
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
88
+ let baseOptions;
89
+ if (configuration) {
90
+ baseOptions = configuration.baseOptions;
91
+ }
92
+
93
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
94
+ const localVarHeaderParameter = {} as any;
95
+ const localVarQueryParameter = {} as any;
96
+
97
+ // authentication keycloak_auth required
98
+ // http bearer authentication required
99
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
100
+
101
+ localVarHeaderParameter['Content-Type'] = 'application/json';
102
+ localVarHeaderParameter['Accept'] = 'application/json';
103
+
104
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
105
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
106
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
107
+ localVarRequestOptions.data = serializeDataIfNeeded(bulkSendRequest, localVarRequestOptions, configuration)
108
+
109
+ return {
110
+ url: toPathString(localVarUrlObj),
111
+ options: localVarRequestOptions,
112
+ };
113
+ },
114
+ /**
115
+ *
116
+ * @summary Mint an embedded-signing URL for a recipient (rotates the token; no email is sent)
117
+ * @param {string} id
118
+ * @param {string} recipientId
119
+ * @param {*} [options] Override http request option.
120
+ * @throws {RequiredError}
121
+ */
122
+ embedUrl: async (id: string, recipientId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
123
+ // verify required parameter 'id' is not null or undefined
124
+ assertParamExists('embedUrl', 'id', id)
125
+ // verify required parameter 'recipientId' is not null or undefined
126
+ assertParamExists('embedUrl', 'recipientId', recipientId)
127
+ const localVarPath = `/api/v1/signatures/{id}/recipients/{recipientId}/embed-url`
128
+ .replace('{id}', encodeURIComponent(String(id)))
129
+ .replace('{recipientId}', encodeURIComponent(String(recipientId)));
130
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
131
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
132
+ let baseOptions;
133
+ if (configuration) {
134
+ baseOptions = configuration.baseOptions;
135
+ }
136
+
137
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
138
+ const localVarHeaderParameter = {} as any;
139
+ const localVarQueryParameter = {} as any;
140
+
141
+ // authentication keycloak_auth required
142
+ // http bearer authentication required
143
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
144
+
145
+ localVarHeaderParameter['Accept'] = 'application/json';
146
+
147
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
148
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
149
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
150
+
151
+ return {
152
+ url: toPathString(localVarUrlObj),
153
+ options: localVarRequestOptions,
154
+ };
155
+ },
156
+ }
157
+ };
158
+
159
+ /**
160
+ * ESignEnterpriseApi - functional programming interface
161
+ */
162
+ export const ESignEnterpriseApiFp = function(configuration?: Configuration) {
163
+ const localVarAxiosParamCreator = ESignEnterpriseApiAxiosParamCreator(configuration)
164
+ return {
165
+ /**
166
+ *
167
+ * @summary PDF/A-2b archive + veraPDF compliance for a completed envelope
168
+ * @param {string} id
169
+ * @param {*} [options] Override http request option.
170
+ * @throws {RequiredError}
171
+ */
172
+ async archive(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SignatureArchiveDTO>> {
173
+ const localVarAxiosArgs = await localVarAxiosParamCreator.archive(id, options);
174
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
175
+ const localVarOperationServerBasePath = operationServerMap['ESignEnterpriseApi.archive']?.[localVarOperationServerIndex]?.url;
176
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
177
+ },
178
+ /**
179
+ *
180
+ * @summary Create (and send) one envelope per row from a template
181
+ * @param {BulkSendRequest} bulkSendRequest
182
+ * @param {*} [options] Override http request option.
183
+ * @throws {RequiredError}
184
+ */
185
+ async bulk(bulkSendRequest: BulkSendRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BulkSendResponse>> {
186
+ const localVarAxiosArgs = await localVarAxiosParamCreator.bulk(bulkSendRequest, options);
187
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
188
+ const localVarOperationServerBasePath = operationServerMap['ESignEnterpriseApi.bulk']?.[localVarOperationServerIndex]?.url;
189
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
190
+ },
191
+ /**
192
+ *
193
+ * @summary Mint an embedded-signing URL for a recipient (rotates the token; no email is sent)
194
+ * @param {string} id
195
+ * @param {string} recipientId
196
+ * @param {*} [options] Override http request option.
197
+ * @throws {RequiredError}
198
+ */
199
+ async embedUrl(id: string, recipientId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmbedUrlResponse>> {
200
+ const localVarAxiosArgs = await localVarAxiosParamCreator.embedUrl(id, recipientId, options);
201
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
202
+ const localVarOperationServerBasePath = operationServerMap['ESignEnterpriseApi.embedUrl']?.[localVarOperationServerIndex]?.url;
203
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
204
+ },
205
+ }
206
+ };
207
+
208
+ /**
209
+ * ESignEnterpriseApi - factory interface
210
+ */
211
+ export const ESignEnterpriseApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
212
+ const localVarFp = ESignEnterpriseApiFp(configuration)
213
+ return {
214
+ /**
215
+ *
216
+ * @summary PDF/A-2b archive + veraPDF compliance for a completed envelope
217
+ * @param {string} id
218
+ * @param {*} [options] Override http request option.
219
+ * @throws {RequiredError}
220
+ */
221
+ archive(id: string, options?: RawAxiosRequestConfig): AxiosPromise<SignatureArchiveDTO> {
222
+ return localVarFp.archive(id, options).then((request) => request(axios, basePath));
223
+ },
224
+ /**
225
+ *
226
+ * @summary Create (and send) one envelope per row from a template
227
+ * @param {BulkSendRequest} bulkSendRequest
228
+ * @param {*} [options] Override http request option.
229
+ * @throws {RequiredError}
230
+ */
231
+ bulk(bulkSendRequest: BulkSendRequest, options?: RawAxiosRequestConfig): AxiosPromise<BulkSendResponse> {
232
+ return localVarFp.bulk(bulkSendRequest, options).then((request) => request(axios, basePath));
233
+ },
234
+ /**
235
+ *
236
+ * @summary Mint an embedded-signing URL for a recipient (rotates the token; no email is sent)
237
+ * @param {string} id
238
+ * @param {string} recipientId
239
+ * @param {*} [options] Override http request option.
240
+ * @throws {RequiredError}
241
+ */
242
+ embedUrl(id: string, recipientId: string, options?: RawAxiosRequestConfig): AxiosPromise<EmbedUrlResponse> {
243
+ return localVarFp.embedUrl(id, recipientId, options).then((request) => request(axios, basePath));
244
+ },
245
+ };
246
+ };
247
+
248
+ /**
249
+ * ESignEnterpriseApi - object-oriented interface
250
+ */
251
+ export class ESignEnterpriseApi extends BaseAPI {
252
+ /**
253
+ *
254
+ * @summary PDF/A-2b archive + veraPDF compliance for a completed envelope
255
+ * @param {string} id
256
+ * @param {*} [options] Override http request option.
257
+ * @throws {RequiredError}
258
+ */
259
+ public archive(id: string, options?: RawAxiosRequestConfig) {
260
+ return ESignEnterpriseApiFp(this.configuration).archive(id, options).then((request) => request(this.axios, this.basePath));
261
+ }
262
+
263
+ /**
264
+ *
265
+ * @summary Create (and send) one envelope per row from a template
266
+ * @param {BulkSendRequest} bulkSendRequest
267
+ * @param {*} [options] Override http request option.
268
+ * @throws {RequiredError}
269
+ */
270
+ public bulk(bulkSendRequest: BulkSendRequest, options?: RawAxiosRequestConfig) {
271
+ return ESignEnterpriseApiFp(this.configuration).bulk(bulkSendRequest, options).then((request) => request(this.axios, this.basePath));
272
+ }
273
+
274
+ /**
275
+ *
276
+ * @summary Mint an embedded-signing URL for a recipient (rotates the token; no email is sent)
277
+ * @param {string} id
278
+ * @param {string} recipientId
279
+ * @param {*} [options] Override http request option.
280
+ * @throws {RequiredError}
281
+ */
282
+ public embedUrl(id: string, recipientId: string, options?: RawAxiosRequestConfig) {
283
+ return ESignEnterpriseApiFp(this.configuration).embedUrl(id, recipientId, options).then((request) => request(this.axios, this.basePath));
284
+ }
285
+ }
286
+
@@ -27,10 +27,12 @@ import type { ApplySignatureRequest } from '../models';
27
27
  import type { DeclineSignatureRequest } from '../models';
28
28
  // @ts-ignore
29
29
  import type { PublicSignatureView } from '../models';
30
+ // @ts-ignore
31
+ import type { VerifyOtpRequest } from '../models';
30
32
  /**
31
- * DigitalSignaturePublicApi - axios parameter creator
33
+ * ESignPublicApi - axios parameter creator
32
34
  */
33
- export const DigitalSignaturePublicApiAxiosParamCreator = function (configuration?: Configuration) {
35
+ export const ESignPublicApiAxiosParamCreator = function (configuration?: Configuration) {
34
36
  return {
35
37
  /**
36
38
  *
@@ -164,7 +166,47 @@ export const DigitalSignaturePublicApiAxiosParamCreator = function (configuratio
164
166
  },
165
167
  /**
166
168
  *
167
- * @summary Apply the recipient\'s signature
169
+ * @summary Send a one-time access code to the recipient (EMAIL_OTP / SMS_OTP)
170
+ * @param {string} token
171
+ * @param {*} [options] Override http request option.
172
+ * @throws {RequiredError}
173
+ */
174
+ requestOtp: async (token: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
175
+ // verify required parameter 'token' is not null or undefined
176
+ assertParamExists('requestOtp', 'token', token)
177
+ const localVarPath = `/api/v1/public/signatures/otp/request`;
178
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
179
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
180
+ let baseOptions;
181
+ if (configuration) {
182
+ baseOptions = configuration.baseOptions;
183
+ }
184
+
185
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
186
+ const localVarHeaderParameter = {} as any;
187
+ const localVarQueryParameter = {} as any;
188
+
189
+ // authentication keycloak_auth required
190
+ // http bearer authentication required
191
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
192
+
193
+ if (token !== undefined) {
194
+ localVarQueryParameter['token'] = token;
195
+ }
196
+
197
+
198
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
199
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
200
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
201
+
202
+ return {
203
+ url: toPathString(localVarUrlObj),
204
+ options: localVarRequestOptions,
205
+ };
206
+ },
207
+ /**
208
+ *
209
+ * @summary Submit the recipient\'s fields and sign
168
210
  * @param {string} token
169
211
  * @param {ApplySignatureRequest} applySignatureRequest
170
212
  * @param {string} [userAgent]
@@ -212,6 +254,52 @@ export const DigitalSignaturePublicApiAxiosParamCreator = function (configuratio
212
254
  options: localVarRequestOptions,
213
255
  };
214
256
  },
257
+ /**
258
+ *
259
+ * @summary Verify the one-time access code
260
+ * @param {string} token
261
+ * @param {VerifyOtpRequest} verifyOtpRequest
262
+ * @param {*} [options] Override http request option.
263
+ * @throws {RequiredError}
264
+ */
265
+ verifyOtp: async (token: string, verifyOtpRequest: VerifyOtpRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
266
+ // verify required parameter 'token' is not null or undefined
267
+ assertParamExists('verifyOtp', 'token', token)
268
+ // verify required parameter 'verifyOtpRequest' is not null or undefined
269
+ assertParamExists('verifyOtp', 'verifyOtpRequest', verifyOtpRequest)
270
+ const localVarPath = `/api/v1/public/signatures/otp/verify`;
271
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
272
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
273
+ let baseOptions;
274
+ if (configuration) {
275
+ baseOptions = configuration.baseOptions;
276
+ }
277
+
278
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
279
+ const localVarHeaderParameter = {} as any;
280
+ const localVarQueryParameter = {} as any;
281
+
282
+ // authentication keycloak_auth required
283
+ // http bearer authentication required
284
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
285
+
286
+ if (token !== undefined) {
287
+ localVarQueryParameter['token'] = token;
288
+ }
289
+
290
+ localVarHeaderParameter['Content-Type'] = 'application/json';
291
+ localVarHeaderParameter['Accept'] = 'application/json';
292
+
293
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
294
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
295
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
296
+ localVarRequestOptions.data = serializeDataIfNeeded(verifyOtpRequest, localVarRequestOptions, configuration)
297
+
298
+ return {
299
+ url: toPathString(localVarUrlObj),
300
+ options: localVarRequestOptions,
301
+ };
302
+ },
215
303
  /**
216
304
  *
217
305
  * @summary Resolve a signing token to its envelope view
@@ -257,10 +345,10 @@ export const DigitalSignaturePublicApiAxiosParamCreator = function (configuratio
257
345
  };
258
346
 
259
347
  /**
260
- * DigitalSignaturePublicApi - functional programming interface
348
+ * ESignPublicApi - functional programming interface
261
349
  */
262
- export const DigitalSignaturePublicApiFp = function(configuration?: Configuration) {
263
- const localVarAxiosParamCreator = DigitalSignaturePublicApiAxiosParamCreator(configuration)
350
+ export const ESignPublicApiFp = function(configuration?: Configuration) {
351
+ const localVarAxiosParamCreator = ESignPublicApiAxiosParamCreator(configuration)
264
352
  return {
265
353
  /**
266
354
  *
@@ -273,7 +361,7 @@ export const DigitalSignaturePublicApiFp = function(configuration?: Configuratio
273
361
  async decline1(token: string, declineSignatureRequest?: DeclineSignatureRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PublicSignatureView>> {
274
362
  const localVarAxiosArgs = await localVarAxiosParamCreator.decline1(token, declineSignatureRequest, options);
275
363
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
276
- const localVarOperationServerBasePath = operationServerMap['DigitalSignaturePublicApi.decline1']?.[localVarOperationServerIndex]?.url;
364
+ const localVarOperationServerBasePath = operationServerMap['ESignPublicApi.decline1']?.[localVarOperationServerIndex]?.url;
277
365
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
278
366
  },
279
367
  /**
@@ -286,7 +374,7 @@ export const DigitalSignaturePublicApiFp = function(configuration?: Configuratio
286
374
  async document(token: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>> {
287
375
  const localVarAxiosArgs = await localVarAxiosParamCreator.document(token, options);
288
376
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
289
- const localVarOperationServerBasePath = operationServerMap['DigitalSignaturePublicApi.document']?.[localVarOperationServerIndex]?.url;
377
+ const localVarOperationServerBasePath = operationServerMap['ESignPublicApi.document']?.[localVarOperationServerIndex]?.url;
290
378
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
291
379
  },
292
380
  /**
@@ -300,12 +388,25 @@ export const DigitalSignaturePublicApiFp = function(configuration?: Configuratio
300
388
  async markViewed(token: string, userAgent?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PublicSignatureView>> {
301
389
  const localVarAxiosArgs = await localVarAxiosParamCreator.markViewed(token, userAgent, options);
302
390
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
303
- const localVarOperationServerBasePath = operationServerMap['DigitalSignaturePublicApi.markViewed']?.[localVarOperationServerIndex]?.url;
391
+ const localVarOperationServerBasePath = operationServerMap['ESignPublicApi.markViewed']?.[localVarOperationServerIndex]?.url;
304
392
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
305
393
  },
306
394
  /**
307
395
  *
308
- * @summary Apply the recipient\'s signature
396
+ * @summary Send a one-time access code to the recipient (EMAIL_OTP / SMS_OTP)
397
+ * @param {string} token
398
+ * @param {*} [options] Override http request option.
399
+ * @throws {RequiredError}
400
+ */
401
+ async requestOtp(token: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
402
+ const localVarAxiosArgs = await localVarAxiosParamCreator.requestOtp(token, options);
403
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
404
+ const localVarOperationServerBasePath = operationServerMap['ESignPublicApi.requestOtp']?.[localVarOperationServerIndex]?.url;
405
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
406
+ },
407
+ /**
408
+ *
409
+ * @summary Submit the recipient\'s fields and sign
309
410
  * @param {string} token
310
411
  * @param {ApplySignatureRequest} applySignatureRequest
311
412
  * @param {string} [userAgent]
@@ -315,7 +416,21 @@ export const DigitalSignaturePublicApiFp = function(configuration?: Configuratio
315
416
  async sign(token: string, applySignatureRequest: ApplySignatureRequest, userAgent?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PublicSignatureView>> {
316
417
  const localVarAxiosArgs = await localVarAxiosParamCreator.sign(token, applySignatureRequest, userAgent, options);
317
418
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
318
- const localVarOperationServerBasePath = operationServerMap['DigitalSignaturePublicApi.sign']?.[localVarOperationServerIndex]?.url;
419
+ const localVarOperationServerBasePath = operationServerMap['ESignPublicApi.sign']?.[localVarOperationServerIndex]?.url;
420
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
421
+ },
422
+ /**
423
+ *
424
+ * @summary Verify the one-time access code
425
+ * @param {string} token
426
+ * @param {VerifyOtpRequest} verifyOtpRequest
427
+ * @param {*} [options] Override http request option.
428
+ * @throws {RequiredError}
429
+ */
430
+ async verifyOtp(token: string, verifyOtpRequest: VerifyOtpRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PublicSignatureView>> {
431
+ const localVarAxiosArgs = await localVarAxiosParamCreator.verifyOtp(token, verifyOtpRequest, options);
432
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
433
+ const localVarOperationServerBasePath = operationServerMap['ESignPublicApi.verifyOtp']?.[localVarOperationServerIndex]?.url;
319
434
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
320
435
  },
321
436
  /**
@@ -328,17 +443,17 @@ export const DigitalSignaturePublicApiFp = function(configuration?: Configuratio
328
443
  async view(token: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PublicSignatureView>> {
329
444
  const localVarAxiosArgs = await localVarAxiosParamCreator.view(token, options);
330
445
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
331
- const localVarOperationServerBasePath = operationServerMap['DigitalSignaturePublicApi.view']?.[localVarOperationServerIndex]?.url;
446
+ const localVarOperationServerBasePath = operationServerMap['ESignPublicApi.view']?.[localVarOperationServerIndex]?.url;
332
447
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
333
448
  },
334
449
  }
335
450
  };
336
451
 
337
452
  /**
338
- * DigitalSignaturePublicApi - factory interface
453
+ * ESignPublicApi - factory interface
339
454
  */
340
- export const DigitalSignaturePublicApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
341
- const localVarFp = DigitalSignaturePublicApiFp(configuration)
455
+ export const ESignPublicApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
456
+ const localVarFp = ESignPublicApiFp(configuration)
342
457
  return {
343
458
  /**
344
459
  *
@@ -374,7 +489,17 @@ export const DigitalSignaturePublicApiFactory = function (configuration?: Config
374
489
  },
375
490
  /**
376
491
  *
377
- * @summary Apply the recipient\'s signature
492
+ * @summary Send a one-time access code to the recipient (EMAIL_OTP / SMS_OTP)
493
+ * @param {string} token
494
+ * @param {*} [options] Override http request option.
495
+ * @throws {RequiredError}
496
+ */
497
+ requestOtp(token: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
498
+ return localVarFp.requestOtp(token, options).then((request) => request(axios, basePath));
499
+ },
500
+ /**
501
+ *
502
+ * @summary Submit the recipient\'s fields and sign
378
503
  * @param {string} token
379
504
  * @param {ApplySignatureRequest} applySignatureRequest
380
505
  * @param {string} [userAgent]
@@ -384,6 +509,17 @@ export const DigitalSignaturePublicApiFactory = function (configuration?: Config
384
509
  sign(token: string, applySignatureRequest: ApplySignatureRequest, userAgent?: string, options?: RawAxiosRequestConfig): AxiosPromise<PublicSignatureView> {
385
510
  return localVarFp.sign(token, applySignatureRequest, userAgent, options).then((request) => request(axios, basePath));
386
511
  },
512
+ /**
513
+ *
514
+ * @summary Verify the one-time access code
515
+ * @param {string} token
516
+ * @param {VerifyOtpRequest} verifyOtpRequest
517
+ * @param {*} [options] Override http request option.
518
+ * @throws {RequiredError}
519
+ */
520
+ verifyOtp(token: string, verifyOtpRequest: VerifyOtpRequest, options?: RawAxiosRequestConfig): AxiosPromise<PublicSignatureView> {
521
+ return localVarFp.verifyOtp(token, verifyOtpRequest, options).then((request) => request(axios, basePath));
522
+ },
387
523
  /**
388
524
  *
389
525
  * @summary Resolve a signing token to its envelope view
@@ -398,9 +534,9 @@ export const DigitalSignaturePublicApiFactory = function (configuration?: Config
398
534
  };
399
535
 
400
536
  /**
401
- * DigitalSignaturePublicApi - object-oriented interface
537
+ * ESignPublicApi - object-oriented interface
402
538
  */
403
- export class DigitalSignaturePublicApi extends BaseAPI {
539
+ export class ESignPublicApi extends BaseAPI {
404
540
  /**
405
541
  *
406
542
  * @summary Decline to sign (voids the envelope)
@@ -410,7 +546,7 @@ export class DigitalSignaturePublicApi extends BaseAPI {
410
546
  * @throws {RequiredError}
411
547
  */
412
548
  public decline1(token: string, declineSignatureRequest?: DeclineSignatureRequest, options?: RawAxiosRequestConfig) {
413
- return DigitalSignaturePublicApiFp(this.configuration).decline1(token, declineSignatureRequest, options).then((request) => request(this.axios, this.basePath));
549
+ return ESignPublicApiFp(this.configuration).decline1(token, declineSignatureRequest, options).then((request) => request(this.axios, this.basePath));
414
550
  }
415
551
 
416
552
  /**
@@ -421,7 +557,7 @@ export class DigitalSignaturePublicApi extends BaseAPI {
421
557
  * @throws {RequiredError}
422
558
  */
423
559
  public document(token: string, options?: RawAxiosRequestConfig) {
424
- return DigitalSignaturePublicApiFp(this.configuration).document(token, options).then((request) => request(this.axios, this.basePath));
560
+ return ESignPublicApiFp(this.configuration).document(token, options).then((request) => request(this.axios, this.basePath));
425
561
  }
426
562
 
427
563
  /**
@@ -433,12 +569,23 @@ export class DigitalSignaturePublicApi extends BaseAPI {
433
569
  * @throws {RequiredError}
434
570
  */
435
571
  public markViewed(token: string, userAgent?: string, options?: RawAxiosRequestConfig) {
436
- return DigitalSignaturePublicApiFp(this.configuration).markViewed(token, userAgent, options).then((request) => request(this.axios, this.basePath));
572
+ return ESignPublicApiFp(this.configuration).markViewed(token, userAgent, options).then((request) => request(this.axios, this.basePath));
573
+ }
574
+
575
+ /**
576
+ *
577
+ * @summary Send a one-time access code to the recipient (EMAIL_OTP / SMS_OTP)
578
+ * @param {string} token
579
+ * @param {*} [options] Override http request option.
580
+ * @throws {RequiredError}
581
+ */
582
+ public requestOtp(token: string, options?: RawAxiosRequestConfig) {
583
+ return ESignPublicApiFp(this.configuration).requestOtp(token, options).then((request) => request(this.axios, this.basePath));
437
584
  }
438
585
 
439
586
  /**
440
587
  *
441
- * @summary Apply the recipient\'s signature
588
+ * @summary Submit the recipient\'s fields and sign
442
589
  * @param {string} token
443
590
  * @param {ApplySignatureRequest} applySignatureRequest
444
591
  * @param {string} [userAgent]
@@ -446,7 +593,19 @@ export class DigitalSignaturePublicApi extends BaseAPI {
446
593
  * @throws {RequiredError}
447
594
  */
448
595
  public sign(token: string, applySignatureRequest: ApplySignatureRequest, userAgent?: string, options?: RawAxiosRequestConfig) {
449
- return DigitalSignaturePublicApiFp(this.configuration).sign(token, applySignatureRequest, userAgent, options).then((request) => request(this.axios, this.basePath));
596
+ return ESignPublicApiFp(this.configuration).sign(token, applySignatureRequest, userAgent, options).then((request) => request(this.axios, this.basePath));
597
+ }
598
+
599
+ /**
600
+ *
601
+ * @summary Verify the one-time access code
602
+ * @param {string} token
603
+ * @param {VerifyOtpRequest} verifyOtpRequest
604
+ * @param {*} [options] Override http request option.
605
+ * @throws {RequiredError}
606
+ */
607
+ public verifyOtp(token: string, verifyOtpRequest: VerifyOtpRequest, options?: RawAxiosRequestConfig) {
608
+ return ESignPublicApiFp(this.configuration).verifyOtp(token, verifyOtpRequest, options).then((request) => request(this.axios, this.basePath));
450
609
  }
451
610
 
452
611
  /**
@@ -457,7 +616,7 @@ export class DigitalSignaturePublicApi extends BaseAPI {
457
616
  * @throws {RequiredError}
458
617
  */
459
618
  public view(token: string, options?: RawAxiosRequestConfig) {
460
- return DigitalSignaturePublicApiFp(this.configuration).view(token, options).then((request) => request(this.axios, this.basePath));
619
+ return ESignPublicApiFp(this.configuration).view(token, options).then((request) => request(this.axios, this.basePath));
461
620
  }
462
621
  }
463
622