@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,719 @@
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 { CreateSignatureEnvelopeRequest } from '../models';
26
+ // @ts-ignore
27
+ import type { SignatureEnvelopeDTO } from '../models';
28
+ // @ts-ignore
29
+ import type { SignatureEventDTO } from '../models';
30
+ /**
31
+ * ESignApi - axios parameter creator
32
+ */
33
+ export const ESignApiAxiosParamCreator = function (configuration?: Configuration) {
34
+ return {
35
+ /**
36
+ *
37
+ * @summary Cancel a non-terminal envelope
38
+ * @param {string} id
39
+ * @param {*} [options] Override http request option.
40
+ * @throws {RequiredError}
41
+ */
42
+ cancel: async (id: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
43
+ // verify required parameter 'id' is not null or undefined
44
+ assertParamExists('cancel', 'id', id)
45
+ const localVarPath = `/api/v1/signatures/{id}/cancel`
46
+ .replace('{id}', encodeURIComponent(String(id)));
47
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
48
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
49
+ let baseOptions;
50
+ if (configuration) {
51
+ baseOptions = configuration.baseOptions;
52
+ }
53
+
54
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
55
+ const localVarHeaderParameter = {} as any;
56
+ const localVarQueryParameter = {} as any;
57
+
58
+ // authentication keycloak_auth required
59
+ // http bearer authentication required
60
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
61
+
62
+ localVarHeaderParameter['Accept'] = 'application/json';
63
+
64
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
65
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
66
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
67
+
68
+ return {
69
+ url: toPathString(localVarUrlObj),
70
+ options: localVarRequestOptions,
71
+ };
72
+ },
73
+ /**
74
+ *
75
+ * @summary Create an envelope (sent immediately unless send=false)
76
+ * @param {CreateSignatureEnvelopeRequest} createSignatureEnvelopeRequest
77
+ * @param {*} [options] Override http request option.
78
+ * @throws {RequiredError}
79
+ */
80
+ create: async (createSignatureEnvelopeRequest: CreateSignatureEnvelopeRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
81
+ // verify required parameter 'createSignatureEnvelopeRequest' is not null or undefined
82
+ assertParamExists('create', 'createSignatureEnvelopeRequest', createSignatureEnvelopeRequest)
83
+ const localVarPath = `/api/v1/signatures`;
84
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
85
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
86
+ let baseOptions;
87
+ if (configuration) {
88
+ baseOptions = configuration.baseOptions;
89
+ }
90
+
91
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
92
+ const localVarHeaderParameter = {} as any;
93
+ const localVarQueryParameter = {} as any;
94
+
95
+ // authentication keycloak_auth required
96
+ // http bearer authentication required
97
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
98
+
99
+ localVarHeaderParameter['Content-Type'] = 'application/json';
100
+ localVarHeaderParameter['Accept'] = 'application/json';
101
+
102
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
103
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
104
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
105
+ localVarRequestOptions.data = serializeDataIfNeeded(createSignatureEnvelopeRequest, localVarRequestOptions, configuration)
106
+
107
+ return {
108
+ url: toPathString(localVarUrlObj),
109
+ options: localVarRequestOptions,
110
+ };
111
+ },
112
+ /**
113
+ *
114
+ * @summary Audit trail of one of my envelopes
115
+ * @param {string} id
116
+ * @param {*} [options] Override http request option.
117
+ * @throws {RequiredError}
118
+ */
119
+ events: async (id: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
120
+ // verify required parameter 'id' is not null or undefined
121
+ assertParamExists('events', 'id', id)
122
+ const localVarPath = `/api/v1/signatures/{id}/events`
123
+ .replace('{id}', encodeURIComponent(String(id)));
124
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
125
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
126
+ let baseOptions;
127
+ if (configuration) {
128
+ baseOptions = configuration.baseOptions;
129
+ }
130
+
131
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
132
+ const localVarHeaderParameter = {} as any;
133
+ const localVarQueryParameter = {} as any;
134
+
135
+ // authentication keycloak_auth required
136
+ // http bearer authentication required
137
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
138
+
139
+ localVarHeaderParameter['Accept'] = 'application/json';
140
+
141
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
142
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
143
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
144
+
145
+ return {
146
+ url: toPathString(localVarUrlObj),
147
+ options: localVarRequestOptions,
148
+ };
149
+ },
150
+ /**
151
+ *
152
+ * @summary Get one of my envelopes (recipients + fields)
153
+ * @param {string} id
154
+ * @param {*} [options] Override http request option.
155
+ * @throws {RequiredError}
156
+ */
157
+ get2: async (id: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
158
+ // verify required parameter 'id' is not null or undefined
159
+ assertParamExists('get2', 'id', id)
160
+ const localVarPath = `/api/v1/signatures/{id}`
161
+ .replace('{id}', encodeURIComponent(String(id)));
162
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
163
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
164
+ let baseOptions;
165
+ if (configuration) {
166
+ baseOptions = configuration.baseOptions;
167
+ }
168
+
169
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
170
+ const localVarHeaderParameter = {} as any;
171
+ const localVarQueryParameter = {} as any;
172
+
173
+ // authentication keycloak_auth required
174
+ // http bearer authentication required
175
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
176
+
177
+ localVarHeaderParameter['Accept'] = 'application/json';
178
+
179
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
180
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
181
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
182
+
183
+ return {
184
+ url: toPathString(localVarUrlObj),
185
+ options: localVarRequestOptions,
186
+ };
187
+ },
188
+ /**
189
+ *
190
+ * @summary List envelopes I sent for signature
191
+ * @param {ListSentStatusEnum} [status]
192
+ * @param {*} [options] Override http request option.
193
+ * @throws {RequiredError}
194
+ */
195
+ listSent: async (status?: ListSentStatusEnum, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
196
+ const localVarPath = `/api/v1/signatures`;
197
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
198
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
199
+ let baseOptions;
200
+ if (configuration) {
201
+ baseOptions = configuration.baseOptions;
202
+ }
203
+
204
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
205
+ const localVarHeaderParameter = {} as any;
206
+ const localVarQueryParameter = {} as any;
207
+
208
+ // authentication keycloak_auth required
209
+ // http bearer authentication required
210
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
211
+
212
+ if (status !== undefined) {
213
+ localVarQueryParameter['status'] = status;
214
+ }
215
+
216
+ localVarHeaderParameter['Accept'] = 'application/json';
217
+
218
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
219
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
220
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
221
+
222
+ return {
223
+ url: toPathString(localVarUrlObj),
224
+ options: localVarRequestOptions,
225
+ };
226
+ },
227
+ /**
228
+ *
229
+ * @summary List envelopes waiting for my signature
230
+ * @param {*} [options] Override http request option.
231
+ * @throws {RequiredError}
232
+ */
233
+ listToSign: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
234
+ const localVarPath = `/api/v1/signatures/to-sign`;
235
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
236
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
237
+ let baseOptions;
238
+ if (configuration) {
239
+ baseOptions = configuration.baseOptions;
240
+ }
241
+
242
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
243
+ const localVarHeaderParameter = {} as any;
244
+ const localVarQueryParameter = {} as any;
245
+
246
+ // authentication keycloak_auth required
247
+ // http bearer authentication required
248
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
249
+
250
+ localVarHeaderParameter['Accept'] = 'application/json';
251
+
252
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
253
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
254
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
255
+
256
+ return {
257
+ url: toPathString(localVarUrlObj),
258
+ options: localVarRequestOptions,
259
+ };
260
+ },
261
+ /**
262
+ *
263
+ * @summary Resend the signing link to a recipient (new token, previous one revoked)
264
+ * @param {string} id
265
+ * @param {string} recipientId
266
+ * @param {*} [options] Override http request option.
267
+ * @throws {RequiredError}
268
+ */
269
+ resend: async (id: string, recipientId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
270
+ // verify required parameter 'id' is not null or undefined
271
+ assertParamExists('resend', 'id', id)
272
+ // verify required parameter 'recipientId' is not null or undefined
273
+ assertParamExists('resend', 'recipientId', recipientId)
274
+ const localVarPath = `/api/v1/signatures/{id}/recipients/{recipientId}/resend`
275
+ .replace('{id}', encodeURIComponent(String(id)))
276
+ .replace('{recipientId}', encodeURIComponent(String(recipientId)));
277
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
278
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
279
+ let baseOptions;
280
+ if (configuration) {
281
+ baseOptions = configuration.baseOptions;
282
+ }
283
+
284
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
285
+ const localVarHeaderParameter = {} as any;
286
+ const localVarQueryParameter = {} as any;
287
+
288
+ // authentication keycloak_auth required
289
+ // http bearer authentication required
290
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
291
+
292
+ localVarHeaderParameter['Accept'] = 'application/json';
293
+
294
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
295
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
296
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
297
+
298
+ return {
299
+ url: toPathString(localVarUrlObj),
300
+ options: localVarRequestOptions,
301
+ };
302
+ },
303
+ /**
304
+ *
305
+ * @summary Send a DRAFT envelope
306
+ * @param {string} id
307
+ * @param {*} [options] Override http request option.
308
+ * @throws {RequiredError}
309
+ */
310
+ send: async (id: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
311
+ // verify required parameter 'id' is not null or undefined
312
+ assertParamExists('send', 'id', id)
313
+ const localVarPath = `/api/v1/signatures/{id}/send`
314
+ .replace('{id}', encodeURIComponent(String(id)));
315
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
316
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
317
+ let baseOptions;
318
+ if (configuration) {
319
+ baseOptions = configuration.baseOptions;
320
+ }
321
+
322
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
323
+ const localVarHeaderParameter = {} as any;
324
+ const localVarQueryParameter = {} as any;
325
+
326
+ // authentication keycloak_auth required
327
+ // http bearer authentication required
328
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
329
+
330
+ localVarHeaderParameter['Accept'] = 'application/json';
331
+
332
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
333
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
334
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
335
+
336
+ return {
337
+ url: toPathString(localVarUrlObj),
338
+ options: localVarRequestOptions,
339
+ };
340
+ },
341
+ /**
342
+ *
343
+ * @summary Download the sealed PDF of a completed envelope
344
+ * @param {string} id
345
+ * @param {*} [options] Override http request option.
346
+ * @throws {RequiredError}
347
+ */
348
+ signedDocument: async (id: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
349
+ // verify required parameter 'id' is not null or undefined
350
+ assertParamExists('signedDocument', 'id', id)
351
+ const localVarPath = `/api/v1/signatures/{id}/signed-document`
352
+ .replace('{id}', encodeURIComponent(String(id)));
353
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
354
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
355
+ let baseOptions;
356
+ if (configuration) {
357
+ baseOptions = configuration.baseOptions;
358
+ }
359
+
360
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
361
+ const localVarHeaderParameter = {} as any;
362
+ const localVarQueryParameter = {} as any;
363
+
364
+ // authentication keycloak_auth required
365
+ // http bearer authentication required
366
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
367
+
368
+ localVarHeaderParameter['Accept'] = 'application/pdf';
369
+
370
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
371
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
372
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
373
+
374
+ return {
375
+ url: toPathString(localVarUrlObj),
376
+ options: localVarRequestOptions,
377
+ };
378
+ },
379
+ }
380
+ };
381
+
382
+ /**
383
+ * ESignApi - functional programming interface
384
+ */
385
+ export const ESignApiFp = function(configuration?: Configuration) {
386
+ const localVarAxiosParamCreator = ESignApiAxiosParamCreator(configuration)
387
+ return {
388
+ /**
389
+ *
390
+ * @summary Cancel a non-terminal envelope
391
+ * @param {string} id
392
+ * @param {*} [options] Override http request option.
393
+ * @throws {RequiredError}
394
+ */
395
+ async cancel(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SignatureEnvelopeDTO>> {
396
+ const localVarAxiosArgs = await localVarAxiosParamCreator.cancel(id, options);
397
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
398
+ const localVarOperationServerBasePath = operationServerMap['ESignApi.cancel']?.[localVarOperationServerIndex]?.url;
399
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
400
+ },
401
+ /**
402
+ *
403
+ * @summary Create an envelope (sent immediately unless send=false)
404
+ * @param {CreateSignatureEnvelopeRequest} createSignatureEnvelopeRequest
405
+ * @param {*} [options] Override http request option.
406
+ * @throws {RequiredError}
407
+ */
408
+ async create(createSignatureEnvelopeRequest: CreateSignatureEnvelopeRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SignatureEnvelopeDTO>> {
409
+ const localVarAxiosArgs = await localVarAxiosParamCreator.create(createSignatureEnvelopeRequest, options);
410
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
411
+ const localVarOperationServerBasePath = operationServerMap['ESignApi.create']?.[localVarOperationServerIndex]?.url;
412
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
413
+ },
414
+ /**
415
+ *
416
+ * @summary Audit trail of one of my envelopes
417
+ * @param {string} id
418
+ * @param {*} [options] Override http request option.
419
+ * @throws {RequiredError}
420
+ */
421
+ async events(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<SignatureEventDTO>>> {
422
+ const localVarAxiosArgs = await localVarAxiosParamCreator.events(id, options);
423
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
424
+ const localVarOperationServerBasePath = operationServerMap['ESignApi.events']?.[localVarOperationServerIndex]?.url;
425
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
426
+ },
427
+ /**
428
+ *
429
+ * @summary Get one of my envelopes (recipients + fields)
430
+ * @param {string} id
431
+ * @param {*} [options] Override http request option.
432
+ * @throws {RequiredError}
433
+ */
434
+ async get2(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SignatureEnvelopeDTO>> {
435
+ const localVarAxiosArgs = await localVarAxiosParamCreator.get2(id, options);
436
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
437
+ const localVarOperationServerBasePath = operationServerMap['ESignApi.get2']?.[localVarOperationServerIndex]?.url;
438
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
439
+ },
440
+ /**
441
+ *
442
+ * @summary List envelopes I sent for signature
443
+ * @param {ListSentStatusEnum} [status]
444
+ * @param {*} [options] Override http request option.
445
+ * @throws {RequiredError}
446
+ */
447
+ async listSent(status?: ListSentStatusEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<SignatureEnvelopeDTO>>> {
448
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listSent(status, options);
449
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
450
+ const localVarOperationServerBasePath = operationServerMap['ESignApi.listSent']?.[localVarOperationServerIndex]?.url;
451
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
452
+ },
453
+ /**
454
+ *
455
+ * @summary List envelopes waiting for my signature
456
+ * @param {*} [options] Override http request option.
457
+ * @throws {RequiredError}
458
+ */
459
+ async listToSign(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<SignatureEnvelopeDTO>>> {
460
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listToSign(options);
461
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
462
+ const localVarOperationServerBasePath = operationServerMap['ESignApi.listToSign']?.[localVarOperationServerIndex]?.url;
463
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
464
+ },
465
+ /**
466
+ *
467
+ * @summary Resend the signing link to a recipient (new token, previous one revoked)
468
+ * @param {string} id
469
+ * @param {string} recipientId
470
+ * @param {*} [options] Override http request option.
471
+ * @throws {RequiredError}
472
+ */
473
+ async resend(id: string, recipientId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SignatureEnvelopeDTO>> {
474
+ const localVarAxiosArgs = await localVarAxiosParamCreator.resend(id, recipientId, options);
475
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
476
+ const localVarOperationServerBasePath = operationServerMap['ESignApi.resend']?.[localVarOperationServerIndex]?.url;
477
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
478
+ },
479
+ /**
480
+ *
481
+ * @summary Send a DRAFT envelope
482
+ * @param {string} id
483
+ * @param {*} [options] Override http request option.
484
+ * @throws {RequiredError}
485
+ */
486
+ async send(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SignatureEnvelopeDTO>> {
487
+ const localVarAxiosArgs = await localVarAxiosParamCreator.send(id, options);
488
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
489
+ const localVarOperationServerBasePath = operationServerMap['ESignApi.send']?.[localVarOperationServerIndex]?.url;
490
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
491
+ },
492
+ /**
493
+ *
494
+ * @summary Download the sealed PDF of a completed envelope
495
+ * @param {string} id
496
+ * @param {*} [options] Override http request option.
497
+ * @throws {RequiredError}
498
+ */
499
+ async signedDocument(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>> {
500
+ const localVarAxiosArgs = await localVarAxiosParamCreator.signedDocument(id, options);
501
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
502
+ const localVarOperationServerBasePath = operationServerMap['ESignApi.signedDocument']?.[localVarOperationServerIndex]?.url;
503
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
504
+ },
505
+ }
506
+ };
507
+
508
+ /**
509
+ * ESignApi - factory interface
510
+ */
511
+ export const ESignApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
512
+ const localVarFp = ESignApiFp(configuration)
513
+ return {
514
+ /**
515
+ *
516
+ * @summary Cancel a non-terminal envelope
517
+ * @param {string} id
518
+ * @param {*} [options] Override http request option.
519
+ * @throws {RequiredError}
520
+ */
521
+ cancel(id: string, options?: RawAxiosRequestConfig): AxiosPromise<SignatureEnvelopeDTO> {
522
+ return localVarFp.cancel(id, options).then((request) => request(axios, basePath));
523
+ },
524
+ /**
525
+ *
526
+ * @summary Create an envelope (sent immediately unless send=false)
527
+ * @param {CreateSignatureEnvelopeRequest} createSignatureEnvelopeRequest
528
+ * @param {*} [options] Override http request option.
529
+ * @throws {RequiredError}
530
+ */
531
+ create(createSignatureEnvelopeRequest: CreateSignatureEnvelopeRequest, options?: RawAxiosRequestConfig): AxiosPromise<SignatureEnvelopeDTO> {
532
+ return localVarFp.create(createSignatureEnvelopeRequest, options).then((request) => request(axios, basePath));
533
+ },
534
+ /**
535
+ *
536
+ * @summary Audit trail of one of my envelopes
537
+ * @param {string} id
538
+ * @param {*} [options] Override http request option.
539
+ * @throws {RequiredError}
540
+ */
541
+ events(id: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<SignatureEventDTO>> {
542
+ return localVarFp.events(id, options).then((request) => request(axios, basePath));
543
+ },
544
+ /**
545
+ *
546
+ * @summary Get one of my envelopes (recipients + fields)
547
+ * @param {string} id
548
+ * @param {*} [options] Override http request option.
549
+ * @throws {RequiredError}
550
+ */
551
+ get2(id: string, options?: RawAxiosRequestConfig): AxiosPromise<SignatureEnvelopeDTO> {
552
+ return localVarFp.get2(id, options).then((request) => request(axios, basePath));
553
+ },
554
+ /**
555
+ *
556
+ * @summary List envelopes I sent for signature
557
+ * @param {ListSentStatusEnum} [status]
558
+ * @param {*} [options] Override http request option.
559
+ * @throws {RequiredError}
560
+ */
561
+ listSent(status?: ListSentStatusEnum, options?: RawAxiosRequestConfig): AxiosPromise<Array<SignatureEnvelopeDTO>> {
562
+ return localVarFp.listSent(status, options).then((request) => request(axios, basePath));
563
+ },
564
+ /**
565
+ *
566
+ * @summary List envelopes waiting for my signature
567
+ * @param {*} [options] Override http request option.
568
+ * @throws {RequiredError}
569
+ */
570
+ listToSign(options?: RawAxiosRequestConfig): AxiosPromise<Array<SignatureEnvelopeDTO>> {
571
+ return localVarFp.listToSign(options).then((request) => request(axios, basePath));
572
+ },
573
+ /**
574
+ *
575
+ * @summary Resend the signing link to a recipient (new token, previous one revoked)
576
+ * @param {string} id
577
+ * @param {string} recipientId
578
+ * @param {*} [options] Override http request option.
579
+ * @throws {RequiredError}
580
+ */
581
+ resend(id: string, recipientId: string, options?: RawAxiosRequestConfig): AxiosPromise<SignatureEnvelopeDTO> {
582
+ return localVarFp.resend(id, recipientId, options).then((request) => request(axios, basePath));
583
+ },
584
+ /**
585
+ *
586
+ * @summary Send a DRAFT envelope
587
+ * @param {string} id
588
+ * @param {*} [options] Override http request option.
589
+ * @throws {RequiredError}
590
+ */
591
+ send(id: string, options?: RawAxiosRequestConfig): AxiosPromise<SignatureEnvelopeDTO> {
592
+ return localVarFp.send(id, options).then((request) => request(axios, basePath));
593
+ },
594
+ /**
595
+ *
596
+ * @summary Download the sealed PDF of a completed envelope
597
+ * @param {string} id
598
+ * @param {*} [options] Override http request option.
599
+ * @throws {RequiredError}
600
+ */
601
+ signedDocument(id: string, options?: RawAxiosRequestConfig): AxiosPromise<File> {
602
+ return localVarFp.signedDocument(id, options).then((request) => request(axios, basePath));
603
+ },
604
+ };
605
+ };
606
+
607
+ /**
608
+ * ESignApi - object-oriented interface
609
+ */
610
+ export class ESignApi extends BaseAPI {
611
+ /**
612
+ *
613
+ * @summary Cancel a non-terminal envelope
614
+ * @param {string} id
615
+ * @param {*} [options] Override http request option.
616
+ * @throws {RequiredError}
617
+ */
618
+ public cancel(id: string, options?: RawAxiosRequestConfig) {
619
+ return ESignApiFp(this.configuration).cancel(id, options).then((request) => request(this.axios, this.basePath));
620
+ }
621
+
622
+ /**
623
+ *
624
+ * @summary Create an envelope (sent immediately unless send=false)
625
+ * @param {CreateSignatureEnvelopeRequest} createSignatureEnvelopeRequest
626
+ * @param {*} [options] Override http request option.
627
+ * @throws {RequiredError}
628
+ */
629
+ public create(createSignatureEnvelopeRequest: CreateSignatureEnvelopeRequest, options?: RawAxiosRequestConfig) {
630
+ return ESignApiFp(this.configuration).create(createSignatureEnvelopeRequest, options).then((request) => request(this.axios, this.basePath));
631
+ }
632
+
633
+ /**
634
+ *
635
+ * @summary Audit trail of one of my envelopes
636
+ * @param {string} id
637
+ * @param {*} [options] Override http request option.
638
+ * @throws {RequiredError}
639
+ */
640
+ public events(id: string, options?: RawAxiosRequestConfig) {
641
+ return ESignApiFp(this.configuration).events(id, options).then((request) => request(this.axios, this.basePath));
642
+ }
643
+
644
+ /**
645
+ *
646
+ * @summary Get one of my envelopes (recipients + fields)
647
+ * @param {string} id
648
+ * @param {*} [options] Override http request option.
649
+ * @throws {RequiredError}
650
+ */
651
+ public get2(id: string, options?: RawAxiosRequestConfig) {
652
+ return ESignApiFp(this.configuration).get2(id, options).then((request) => request(this.axios, this.basePath));
653
+ }
654
+
655
+ /**
656
+ *
657
+ * @summary List envelopes I sent for signature
658
+ * @param {ListSentStatusEnum} [status]
659
+ * @param {*} [options] Override http request option.
660
+ * @throws {RequiredError}
661
+ */
662
+ public listSent(status?: ListSentStatusEnum, options?: RawAxiosRequestConfig) {
663
+ return ESignApiFp(this.configuration).listSent(status, options).then((request) => request(this.axios, this.basePath));
664
+ }
665
+
666
+ /**
667
+ *
668
+ * @summary List envelopes waiting for my signature
669
+ * @param {*} [options] Override http request option.
670
+ * @throws {RequiredError}
671
+ */
672
+ public listToSign(options?: RawAxiosRequestConfig) {
673
+ return ESignApiFp(this.configuration).listToSign(options).then((request) => request(this.axios, this.basePath));
674
+ }
675
+
676
+ /**
677
+ *
678
+ * @summary Resend the signing link to a recipient (new token, previous one revoked)
679
+ * @param {string} id
680
+ * @param {string} recipientId
681
+ * @param {*} [options] Override http request option.
682
+ * @throws {RequiredError}
683
+ */
684
+ public resend(id: string, recipientId: string, options?: RawAxiosRequestConfig) {
685
+ return ESignApiFp(this.configuration).resend(id, recipientId, options).then((request) => request(this.axios, this.basePath));
686
+ }
687
+
688
+ /**
689
+ *
690
+ * @summary Send a DRAFT envelope
691
+ * @param {string} id
692
+ * @param {*} [options] Override http request option.
693
+ * @throws {RequiredError}
694
+ */
695
+ public send(id: string, options?: RawAxiosRequestConfig) {
696
+ return ESignApiFp(this.configuration).send(id, options).then((request) => request(this.axios, this.basePath));
697
+ }
698
+
699
+ /**
700
+ *
701
+ * @summary Download the sealed PDF of a completed envelope
702
+ * @param {string} id
703
+ * @param {*} [options] Override http request option.
704
+ * @throws {RequiredError}
705
+ */
706
+ public signedDocument(id: string, options?: RawAxiosRequestConfig) {
707
+ return ESignApiFp(this.configuration).signedDocument(id, options).then((request) => request(this.axios, this.basePath));
708
+ }
709
+ }
710
+
711
+ export const ListSentStatusEnum = {
712
+ Draft: 'DRAFT',
713
+ Sent: 'SENT',
714
+ Completed: 'COMPLETED',
715
+ Declined: 'DECLINED',
716
+ Cancelled: 'CANCELLED',
717
+ Expired: 'EXPIRED',
718
+ } as const;
719
+ export type ListSentStatusEnum = typeof ListSentStatusEnum[keyof typeof ListSentStatusEnum];