@openfilz-sdk/typescript-ee 1.8.1 → 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 (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
@@ -22,27 +22,29 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj
22
22
  // @ts-ignore
23
23
  import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base';
24
24
  // @ts-ignore
25
- import type { CreateSignatureEnvelopeRequest } from '../models';
26
- // @ts-ignore
27
- import type { SignatureArchiveDTO } from '../models';
25
+ import type { InstantiateTemplateRequest } from '../models';
28
26
  // @ts-ignore
29
27
  import type { SignatureEnvelopeDTO } from '../models';
28
+ // @ts-ignore
29
+ import type { SignatureTemplateDTO } from '../models';
30
+ // @ts-ignore
31
+ import type { SignatureTemplateRequest } from '../models';
30
32
  /**
31
- * DigitalSignatureApi - axios parameter creator
33
+ * ESignTemplatesApi - axios parameter creator
32
34
  */
33
- export const DigitalSignatureApiAxiosParamCreator = function (configuration?: Configuration) {
35
+ export const ESignTemplatesApiAxiosParamCreator = function (configuration?: Configuration) {
34
36
  return {
35
37
  /**
36
38
  *
37
- * @summary Get the PDF/A archive + veraPDF compliance for a completed envelope
39
+ * @summary Delete a template
38
40
  * @param {string} id
39
41
  * @param {*} [options] Override http request option.
40
42
  * @throws {RequiredError}
41
43
  */
42
- archive: async (id: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
44
+ _delete: async (id: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
43
45
  // verify required parameter 'id' is not null or undefined
44
- assertParamExists('archive', 'id', id)
45
- const localVarPath = `/api/v1/signatures/{id}/archive`
46
+ assertParamExists('_delete', 'id', id)
47
+ const localVarPath = `/api/v1/signature-templates/{id}`
46
48
  .replace('{id}', encodeURIComponent(String(id)));
47
49
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
48
50
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -51,7 +53,7 @@ export const DigitalSignatureApiAxiosParamCreator = function (configuration?: Co
51
53
  baseOptions = configuration.baseOptions;
52
54
  }
53
55
 
54
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
56
+ const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
55
57
  const localVarHeaderParameter = {} as any;
56
58
  const localVarQueryParameter = {} as any;
57
59
 
@@ -59,7 +61,6 @@ export const DigitalSignatureApiAxiosParamCreator = function (configuration?: Co
59
61
  // http bearer authentication required
60
62
  await setBearerAuthToObject(localVarHeaderParameter, configuration)
61
63
 
62
- localVarHeaderParameter['Accept'] = 'application/json';
63
64
 
64
65
  setSearchParams(localVarUrlObj, localVarQueryParameter);
65
66
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
@@ -72,16 +73,15 @@ export const DigitalSignatureApiAxiosParamCreator = function (configuration?: Co
72
73
  },
73
74
  /**
74
75
  *
75
- * @summary Cancel a non-terminal envelope
76
- * @param {string} id
76
+ * @summary Create a template
77
+ * @param {SignatureTemplateRequest} signatureTemplateRequest
77
78
  * @param {*} [options] Override http request option.
78
79
  * @throws {RequiredError}
79
80
  */
80
- cancel: async (id: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
81
- // verify required parameter 'id' is not null or undefined
82
- assertParamExists('cancel', 'id', id)
83
- const localVarPath = `/api/v1/signatures/{id}/cancel`
84
- .replace('{id}', encodeURIComponent(String(id)));
81
+ create1: async (signatureTemplateRequest: SignatureTemplateRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
82
+ // verify required parameter 'signatureTemplateRequest' is not null or undefined
83
+ assertParamExists('create1', 'signatureTemplateRequest', signatureTemplateRequest)
84
+ const localVarPath = `/api/v1/signature-templates`;
85
85
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
86
86
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
87
87
  let baseOptions;
@@ -97,11 +97,13 @@ export const DigitalSignatureApiAxiosParamCreator = function (configuration?: Co
97
97
  // http bearer authentication required
98
98
  await setBearerAuthToObject(localVarHeaderParameter, configuration)
99
99
 
100
+ localVarHeaderParameter['Content-Type'] = 'application/json';
100
101
  localVarHeaderParameter['Accept'] = 'application/json';
101
102
 
102
103
  setSearchParams(localVarUrlObj, localVarQueryParameter);
103
104
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
104
105
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
106
+ localVarRequestOptions.data = serializeDataIfNeeded(signatureTemplateRequest, localVarRequestOptions, configuration)
105
107
 
106
108
  return {
107
109
  url: toPathString(localVarUrlObj),
@@ -110,15 +112,16 @@ export const DigitalSignatureApiAxiosParamCreator = function (configuration?: Co
110
112
  },
111
113
  /**
112
114
  *
113
- * @summary Create and send a signature envelope
114
- * @param {CreateSignatureEnvelopeRequest} createSignatureEnvelopeRequest
115
+ * @summary Get a template
116
+ * @param {string} id
115
117
  * @param {*} [options] Override http request option.
116
118
  * @throws {RequiredError}
117
119
  */
118
- create: async (createSignatureEnvelopeRequest: CreateSignatureEnvelopeRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
119
- // verify required parameter 'createSignatureEnvelopeRequest' is not null or undefined
120
- assertParamExists('create', 'createSignatureEnvelopeRequest', createSignatureEnvelopeRequest)
121
- const localVarPath = `/api/v1/signatures`;
120
+ get1: async (id: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
121
+ // verify required parameter 'id' is not null or undefined
122
+ assertParamExists('get1', 'id', id)
123
+ const localVarPath = `/api/v1/signature-templates/{id}`
124
+ .replace('{id}', encodeURIComponent(String(id)));
122
125
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
123
126
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
124
127
  let baseOptions;
@@ -126,7 +129,7 @@ export const DigitalSignatureApiAxiosParamCreator = function (configuration?: Co
126
129
  baseOptions = configuration.baseOptions;
127
130
  }
128
131
 
129
- const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
132
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
130
133
  const localVarHeaderParameter = {} as any;
131
134
  const localVarQueryParameter = {} as any;
132
135
 
@@ -134,13 +137,11 @@ export const DigitalSignatureApiAxiosParamCreator = function (configuration?: Co
134
137
  // http bearer authentication required
135
138
  await setBearerAuthToObject(localVarHeaderParameter, configuration)
136
139
 
137
- localVarHeaderParameter['Content-Type'] = 'application/json';
138
140
  localVarHeaderParameter['Accept'] = 'application/json';
139
141
 
140
142
  setSearchParams(localVarUrlObj, localVarQueryParameter);
141
143
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
142
144
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
143
- localVarRequestOptions.data = serializeDataIfNeeded(createSignatureEnvelopeRequest, localVarRequestOptions, configuration)
144
145
 
145
146
  return {
146
147
  url: toPathString(localVarUrlObj),
@@ -149,15 +150,18 @@ export const DigitalSignatureApiAxiosParamCreator = function (configuration?: Co
149
150
  },
150
151
  /**
151
152
  *
152
- * @summary Get a single envelope I sent
153
+ * @summary Create (and send) an envelope from a template
153
154
  * @param {string} id
155
+ * @param {InstantiateTemplateRequest} instantiateTemplateRequest
154
156
  * @param {*} [options] Override http request option.
155
157
  * @throws {RequiredError}
156
158
  */
157
- get1: async (id: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
159
+ instantiate: async (id: string, instantiateTemplateRequest: InstantiateTemplateRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
158
160
  // verify required parameter 'id' is not null or undefined
159
- assertParamExists('get1', 'id', id)
160
- const localVarPath = `/api/v1/signatures/{id}`
161
+ assertParamExists('instantiate', 'id', id)
162
+ // verify required parameter 'instantiateTemplateRequest' is not null or undefined
163
+ assertParamExists('instantiate', 'instantiateTemplateRequest', instantiateTemplateRequest)
164
+ const localVarPath = `/api/v1/signature-templates/{id}/envelopes`
161
165
  .replace('{id}', encodeURIComponent(String(id)));
162
166
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
163
167
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -166,7 +170,7 @@ export const DigitalSignatureApiAxiosParamCreator = function (configuration?: Co
166
170
  baseOptions = configuration.baseOptions;
167
171
  }
168
172
 
169
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
173
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
170
174
  const localVarHeaderParameter = {} as any;
171
175
  const localVarQueryParameter = {} as any;
172
176
 
@@ -174,11 +178,13 @@ export const DigitalSignatureApiAxiosParamCreator = function (configuration?: Co
174
178
  // http bearer authentication required
175
179
  await setBearerAuthToObject(localVarHeaderParameter, configuration)
176
180
 
181
+ localVarHeaderParameter['Content-Type'] = 'application/json';
177
182
  localVarHeaderParameter['Accept'] = 'application/json';
178
183
 
179
184
  setSearchParams(localVarUrlObj, localVarQueryParameter);
180
185
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
181
186
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
187
+ localVarRequestOptions.data = serializeDataIfNeeded(instantiateTemplateRequest, localVarRequestOptions, configuration)
182
188
 
183
189
  return {
184
190
  url: toPathString(localVarUrlObj),
@@ -187,12 +193,12 @@ export const DigitalSignatureApiAxiosParamCreator = function (configuration?: Co
187
193
  },
188
194
  /**
189
195
  *
190
- * @summary List envelopes I sent for signature
196
+ * @summary List my templates
191
197
  * @param {*} [options] Override http request option.
192
198
  * @throws {RequiredError}
193
199
  */
194
- listSent: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
195
- const localVarPath = `/api/v1/signatures`;
200
+ list: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
201
+ const localVarPath = `/api/v1/signature-templates`;
196
202
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
197
203
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
198
204
  let baseOptions;
@@ -221,12 +227,19 @@ export const DigitalSignatureApiAxiosParamCreator = function (configuration?: Co
221
227
  },
222
228
  /**
223
229
  *
224
- * @summary List documents waiting for my signature
230
+ * @summary Update a template
231
+ * @param {string} id
232
+ * @param {SignatureTemplateRequest} signatureTemplateRequest
225
233
  * @param {*} [options] Override http request option.
226
234
  * @throws {RequiredError}
227
235
  */
228
- listToSign: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
229
- const localVarPath = `/api/v1/signatures/to-sign`;
236
+ update1: async (id: string, signatureTemplateRequest: SignatureTemplateRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
237
+ // verify required parameter 'id' is not null or undefined
238
+ assertParamExists('update1', 'id', id)
239
+ // verify required parameter 'signatureTemplateRequest' is not null or undefined
240
+ assertParamExists('update1', 'signatureTemplateRequest', signatureTemplateRequest)
241
+ const localVarPath = `/api/v1/signature-templates/{id}`
242
+ .replace('{id}', encodeURIComponent(String(id)));
230
243
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
231
244
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
232
245
  let baseOptions;
@@ -234,7 +247,7 @@ export const DigitalSignatureApiAxiosParamCreator = function (configuration?: Co
234
247
  baseOptions = configuration.baseOptions;
235
248
  }
236
249
 
237
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
250
+ const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
238
251
  const localVarHeaderParameter = {} as any;
239
252
  const localVarQueryParameter = {} as any;
240
253
 
@@ -242,11 +255,13 @@ export const DigitalSignatureApiAxiosParamCreator = function (configuration?: Co
242
255
  // http bearer authentication required
243
256
  await setBearerAuthToObject(localVarHeaderParameter, configuration)
244
257
 
258
+ localVarHeaderParameter['Content-Type'] = 'application/json';
245
259
  localVarHeaderParameter['Accept'] = 'application/json';
246
260
 
247
261
  setSearchParams(localVarUrlObj, localVarQueryParameter);
248
262
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
249
263
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
264
+ localVarRequestOptions.data = serializeDataIfNeeded(signatureTemplateRequest, localVarRequestOptions, configuration)
250
265
 
251
266
  return {
252
267
  url: toPathString(localVarUrlObj),
@@ -257,223 +272,232 @@ export const DigitalSignatureApiAxiosParamCreator = function (configuration?: Co
257
272
  };
258
273
 
259
274
  /**
260
- * DigitalSignatureApi - functional programming interface
275
+ * ESignTemplatesApi - functional programming interface
261
276
  */
262
- export const DigitalSignatureApiFp = function(configuration?: Configuration) {
263
- const localVarAxiosParamCreator = DigitalSignatureApiAxiosParamCreator(configuration)
277
+ export const ESignTemplatesApiFp = function(configuration?: Configuration) {
278
+ const localVarAxiosParamCreator = ESignTemplatesApiAxiosParamCreator(configuration)
264
279
  return {
265
280
  /**
266
281
  *
267
- * @summary Get the PDF/A archive + veraPDF compliance for a completed envelope
282
+ * @summary Delete a template
268
283
  * @param {string} id
269
284
  * @param {*} [options] Override http request option.
270
285
  * @throws {RequiredError}
271
286
  */
272
- async archive(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SignatureArchiveDTO>> {
273
- const localVarAxiosArgs = await localVarAxiosParamCreator.archive(id, options);
287
+ async _delete(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
288
+ const localVarAxiosArgs = await localVarAxiosParamCreator._delete(id, options);
274
289
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
275
- const localVarOperationServerBasePath = operationServerMap['DigitalSignatureApi.archive']?.[localVarOperationServerIndex]?.url;
290
+ const localVarOperationServerBasePath = operationServerMap['ESignTemplatesApi._delete']?.[localVarOperationServerIndex]?.url;
276
291
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
277
292
  },
278
293
  /**
279
294
  *
280
- * @summary Cancel a non-terminal envelope
281
- * @param {string} id
295
+ * @summary Create a template
296
+ * @param {SignatureTemplateRequest} signatureTemplateRequest
282
297
  * @param {*} [options] Override http request option.
283
298
  * @throws {RequiredError}
284
299
  */
285
- async cancel(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SignatureEnvelopeDTO>> {
286
- const localVarAxiosArgs = await localVarAxiosParamCreator.cancel(id, options);
300
+ async create1(signatureTemplateRequest: SignatureTemplateRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SignatureTemplateDTO>> {
301
+ const localVarAxiosArgs = await localVarAxiosParamCreator.create1(signatureTemplateRequest, options);
287
302
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
288
- const localVarOperationServerBasePath = operationServerMap['DigitalSignatureApi.cancel']?.[localVarOperationServerIndex]?.url;
303
+ const localVarOperationServerBasePath = operationServerMap['ESignTemplatesApi.create1']?.[localVarOperationServerIndex]?.url;
289
304
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
290
305
  },
291
306
  /**
292
307
  *
293
- * @summary Create and send a signature envelope
294
- * @param {CreateSignatureEnvelopeRequest} createSignatureEnvelopeRequest
308
+ * @summary Get a template
309
+ * @param {string} id
295
310
  * @param {*} [options] Override http request option.
296
311
  * @throws {RequiredError}
297
312
  */
298
- async create(createSignatureEnvelopeRequest: CreateSignatureEnvelopeRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SignatureEnvelopeDTO>> {
299
- const localVarAxiosArgs = await localVarAxiosParamCreator.create(createSignatureEnvelopeRequest, options);
313
+ async get1(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SignatureTemplateDTO>> {
314
+ const localVarAxiosArgs = await localVarAxiosParamCreator.get1(id, options);
300
315
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
301
- const localVarOperationServerBasePath = operationServerMap['DigitalSignatureApi.create']?.[localVarOperationServerIndex]?.url;
316
+ const localVarOperationServerBasePath = operationServerMap['ESignTemplatesApi.get1']?.[localVarOperationServerIndex]?.url;
302
317
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
303
318
  },
304
319
  /**
305
320
  *
306
- * @summary Get a single envelope I sent
321
+ * @summary Create (and send) an envelope from a template
307
322
  * @param {string} id
323
+ * @param {InstantiateTemplateRequest} instantiateTemplateRequest
308
324
  * @param {*} [options] Override http request option.
309
325
  * @throws {RequiredError}
310
326
  */
311
- async get1(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SignatureEnvelopeDTO>> {
312
- const localVarAxiosArgs = await localVarAxiosParamCreator.get1(id, options);
327
+ async instantiate(id: string, instantiateTemplateRequest: InstantiateTemplateRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SignatureEnvelopeDTO>> {
328
+ const localVarAxiosArgs = await localVarAxiosParamCreator.instantiate(id, instantiateTemplateRequest, options);
313
329
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
314
- const localVarOperationServerBasePath = operationServerMap['DigitalSignatureApi.get1']?.[localVarOperationServerIndex]?.url;
330
+ const localVarOperationServerBasePath = operationServerMap['ESignTemplatesApi.instantiate']?.[localVarOperationServerIndex]?.url;
315
331
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
316
332
  },
317
333
  /**
318
334
  *
319
- * @summary List envelopes I sent for signature
335
+ * @summary List my templates
320
336
  * @param {*} [options] Override http request option.
321
337
  * @throws {RequiredError}
322
338
  */
323
- async listSent(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<SignatureEnvelopeDTO>>> {
324
- const localVarAxiosArgs = await localVarAxiosParamCreator.listSent(options);
339
+ async list(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<SignatureTemplateDTO>>> {
340
+ const localVarAxiosArgs = await localVarAxiosParamCreator.list(options);
325
341
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
326
- const localVarOperationServerBasePath = operationServerMap['DigitalSignatureApi.listSent']?.[localVarOperationServerIndex]?.url;
342
+ const localVarOperationServerBasePath = operationServerMap['ESignTemplatesApi.list']?.[localVarOperationServerIndex]?.url;
327
343
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
328
344
  },
329
345
  /**
330
346
  *
331
- * @summary List documents waiting for my signature
347
+ * @summary Update a template
348
+ * @param {string} id
349
+ * @param {SignatureTemplateRequest} signatureTemplateRequest
332
350
  * @param {*} [options] Override http request option.
333
351
  * @throws {RequiredError}
334
352
  */
335
- async listToSign(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<SignatureEnvelopeDTO>>> {
336
- const localVarAxiosArgs = await localVarAxiosParamCreator.listToSign(options);
353
+ async update1(id: string, signatureTemplateRequest: SignatureTemplateRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SignatureTemplateDTO>> {
354
+ const localVarAxiosArgs = await localVarAxiosParamCreator.update1(id, signatureTemplateRequest, options);
337
355
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
338
- const localVarOperationServerBasePath = operationServerMap['DigitalSignatureApi.listToSign']?.[localVarOperationServerIndex]?.url;
356
+ const localVarOperationServerBasePath = operationServerMap['ESignTemplatesApi.update1']?.[localVarOperationServerIndex]?.url;
339
357
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
340
358
  },
341
359
  }
342
360
  };
343
361
 
344
362
  /**
345
- * DigitalSignatureApi - factory interface
363
+ * ESignTemplatesApi - factory interface
346
364
  */
347
- export const DigitalSignatureApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
348
- const localVarFp = DigitalSignatureApiFp(configuration)
365
+ export const ESignTemplatesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
366
+ const localVarFp = ESignTemplatesApiFp(configuration)
349
367
  return {
350
368
  /**
351
369
  *
352
- * @summary Get the PDF/A archive + veraPDF compliance for a completed envelope
370
+ * @summary Delete a template
353
371
  * @param {string} id
354
372
  * @param {*} [options] Override http request option.
355
373
  * @throws {RequiredError}
356
374
  */
357
- archive(id: string, options?: RawAxiosRequestConfig): AxiosPromise<SignatureArchiveDTO> {
358
- return localVarFp.archive(id, options).then((request) => request(axios, basePath));
375
+ _delete(id: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
376
+ return localVarFp._delete(id, options).then((request) => request(axios, basePath));
359
377
  },
360
378
  /**
361
379
  *
362
- * @summary Cancel a non-terminal envelope
363
- * @param {string} id
380
+ * @summary Create a template
381
+ * @param {SignatureTemplateRequest} signatureTemplateRequest
364
382
  * @param {*} [options] Override http request option.
365
383
  * @throws {RequiredError}
366
384
  */
367
- cancel(id: string, options?: RawAxiosRequestConfig): AxiosPromise<SignatureEnvelopeDTO> {
368
- return localVarFp.cancel(id, options).then((request) => request(axios, basePath));
385
+ create1(signatureTemplateRequest: SignatureTemplateRequest, options?: RawAxiosRequestConfig): AxiosPromise<SignatureTemplateDTO> {
386
+ return localVarFp.create1(signatureTemplateRequest, options).then((request) => request(axios, basePath));
369
387
  },
370
388
  /**
371
389
  *
372
- * @summary Create and send a signature envelope
373
- * @param {CreateSignatureEnvelopeRequest} createSignatureEnvelopeRequest
390
+ * @summary Get a template
391
+ * @param {string} id
374
392
  * @param {*} [options] Override http request option.
375
393
  * @throws {RequiredError}
376
394
  */
377
- create(createSignatureEnvelopeRequest: CreateSignatureEnvelopeRequest, options?: RawAxiosRequestConfig): AxiosPromise<SignatureEnvelopeDTO> {
378
- return localVarFp.create(createSignatureEnvelopeRequest, options).then((request) => request(axios, basePath));
395
+ get1(id: string, options?: RawAxiosRequestConfig): AxiosPromise<SignatureTemplateDTO> {
396
+ return localVarFp.get1(id, options).then((request) => request(axios, basePath));
379
397
  },
380
398
  /**
381
399
  *
382
- * @summary Get a single envelope I sent
400
+ * @summary Create (and send) an envelope from a template
383
401
  * @param {string} id
402
+ * @param {InstantiateTemplateRequest} instantiateTemplateRequest
384
403
  * @param {*} [options] Override http request option.
385
404
  * @throws {RequiredError}
386
405
  */
387
- get1(id: string, options?: RawAxiosRequestConfig): AxiosPromise<SignatureEnvelopeDTO> {
388
- return localVarFp.get1(id, options).then((request) => request(axios, basePath));
406
+ instantiate(id: string, instantiateTemplateRequest: InstantiateTemplateRequest, options?: RawAxiosRequestConfig): AxiosPromise<SignatureEnvelopeDTO> {
407
+ return localVarFp.instantiate(id, instantiateTemplateRequest, options).then((request) => request(axios, basePath));
389
408
  },
390
409
  /**
391
410
  *
392
- * @summary List envelopes I sent for signature
411
+ * @summary List my templates
393
412
  * @param {*} [options] Override http request option.
394
413
  * @throws {RequiredError}
395
414
  */
396
- listSent(options?: RawAxiosRequestConfig): AxiosPromise<Array<SignatureEnvelopeDTO>> {
397
- return localVarFp.listSent(options).then((request) => request(axios, basePath));
415
+ list(options?: RawAxiosRequestConfig): AxiosPromise<Array<SignatureTemplateDTO>> {
416
+ return localVarFp.list(options).then((request) => request(axios, basePath));
398
417
  },
399
418
  /**
400
419
  *
401
- * @summary List documents waiting for my signature
420
+ * @summary Update a template
421
+ * @param {string} id
422
+ * @param {SignatureTemplateRequest} signatureTemplateRequest
402
423
  * @param {*} [options] Override http request option.
403
424
  * @throws {RequiredError}
404
425
  */
405
- listToSign(options?: RawAxiosRequestConfig): AxiosPromise<Array<SignatureEnvelopeDTO>> {
406
- return localVarFp.listToSign(options).then((request) => request(axios, basePath));
426
+ update1(id: string, signatureTemplateRequest: SignatureTemplateRequest, options?: RawAxiosRequestConfig): AxiosPromise<SignatureTemplateDTO> {
427
+ return localVarFp.update1(id, signatureTemplateRequest, options).then((request) => request(axios, basePath));
407
428
  },
408
429
  };
409
430
  };
410
431
 
411
432
  /**
412
- * DigitalSignatureApi - object-oriented interface
433
+ * ESignTemplatesApi - object-oriented interface
413
434
  */
414
- export class DigitalSignatureApi extends BaseAPI {
435
+ export class ESignTemplatesApi extends BaseAPI {
415
436
  /**
416
437
  *
417
- * @summary Get the PDF/A archive + veraPDF compliance for a completed envelope
438
+ * @summary Delete a template
418
439
  * @param {string} id
419
440
  * @param {*} [options] Override http request option.
420
441
  * @throws {RequiredError}
421
442
  */
422
- public archive(id: string, options?: RawAxiosRequestConfig) {
423
- return DigitalSignatureApiFp(this.configuration).archive(id, options).then((request) => request(this.axios, this.basePath));
443
+ public _delete(id: string, options?: RawAxiosRequestConfig) {
444
+ return ESignTemplatesApiFp(this.configuration)._delete(id, options).then((request) => request(this.axios, this.basePath));
424
445
  }
425
446
 
426
447
  /**
427
448
  *
428
- * @summary Cancel a non-terminal envelope
429
- * @param {string} id
449
+ * @summary Create a template
450
+ * @param {SignatureTemplateRequest} signatureTemplateRequest
430
451
  * @param {*} [options] Override http request option.
431
452
  * @throws {RequiredError}
432
453
  */
433
- public cancel(id: string, options?: RawAxiosRequestConfig) {
434
- return DigitalSignatureApiFp(this.configuration).cancel(id, options).then((request) => request(this.axios, this.basePath));
454
+ public create1(signatureTemplateRequest: SignatureTemplateRequest, options?: RawAxiosRequestConfig) {
455
+ return ESignTemplatesApiFp(this.configuration).create1(signatureTemplateRequest, options).then((request) => request(this.axios, this.basePath));
435
456
  }
436
457
 
437
458
  /**
438
459
  *
439
- * @summary Create and send a signature envelope
440
- * @param {CreateSignatureEnvelopeRequest} createSignatureEnvelopeRequest
460
+ * @summary Get a template
461
+ * @param {string} id
441
462
  * @param {*} [options] Override http request option.
442
463
  * @throws {RequiredError}
443
464
  */
444
- public create(createSignatureEnvelopeRequest: CreateSignatureEnvelopeRequest, options?: RawAxiosRequestConfig) {
445
- return DigitalSignatureApiFp(this.configuration).create(createSignatureEnvelopeRequest, options).then((request) => request(this.axios, this.basePath));
465
+ public get1(id: string, options?: RawAxiosRequestConfig) {
466
+ return ESignTemplatesApiFp(this.configuration).get1(id, options).then((request) => request(this.axios, this.basePath));
446
467
  }
447
468
 
448
469
  /**
449
470
  *
450
- * @summary Get a single envelope I sent
471
+ * @summary Create (and send) an envelope from a template
451
472
  * @param {string} id
473
+ * @param {InstantiateTemplateRequest} instantiateTemplateRequest
452
474
  * @param {*} [options] Override http request option.
453
475
  * @throws {RequiredError}
454
476
  */
455
- public get1(id: string, options?: RawAxiosRequestConfig) {
456
- return DigitalSignatureApiFp(this.configuration).get1(id, options).then((request) => request(this.axios, this.basePath));
477
+ public instantiate(id: string, instantiateTemplateRequest: InstantiateTemplateRequest, options?: RawAxiosRequestConfig) {
478
+ return ESignTemplatesApiFp(this.configuration).instantiate(id, instantiateTemplateRequest, options).then((request) => request(this.axios, this.basePath));
457
479
  }
458
480
 
459
481
  /**
460
482
  *
461
- * @summary List envelopes I sent for signature
483
+ * @summary List my templates
462
484
  * @param {*} [options] Override http request option.
463
485
  * @throws {RequiredError}
464
486
  */
465
- public listSent(options?: RawAxiosRequestConfig) {
466
- return DigitalSignatureApiFp(this.configuration).listSent(options).then((request) => request(this.axios, this.basePath));
487
+ public list(options?: RawAxiosRequestConfig) {
488
+ return ESignTemplatesApiFp(this.configuration).list(options).then((request) => request(this.axios, this.basePath));
467
489
  }
468
490
 
469
491
  /**
470
492
  *
471
- * @summary List documents waiting for my signature
493
+ * @summary Update a template
494
+ * @param {string} id
495
+ * @param {SignatureTemplateRequest} signatureTemplateRequest
472
496
  * @param {*} [options] Override http request option.
473
497
  * @throws {RequiredError}
474
498
  */
475
- public listToSign(options?: RawAxiosRequestConfig) {
476
- return DigitalSignatureApiFp(this.configuration).listToSign(options).then((request) => request(this.axios, this.basePath));
499
+ public update1(id: string, signatureTemplateRequest: SignatureTemplateRequest, options?: RawAxiosRequestConfig) {
500
+ return ESignTemplatesApiFp(this.configuration).update1(id, signatureTemplateRequest, options).then((request) => request(this.axios, this.basePath));
477
501
  }
478
502
  }
479
503
 
package/api.ts CHANGED
@@ -22,11 +22,13 @@ export * from './api/comments-api';
22
22
  export * from './api/dashboard-api';
23
23
  export * from './api/delegated-browse-grants-admin-api';
24
24
  export * from './api/delegated-browse-grants-end-user-api';
25
- export * from './api/digital-signature-api';
26
- export * from './api/digital-signature-public-api';
27
25
  export * from './api/document-controller-api';
28
26
  export * from './api/document-suggestion-controller-api';
29
27
  export * from './api/document-version-controller-api';
28
+ export * from './api/esign-api';
29
+ export * from './api/esign-enterprise-api';
30
+ export * from './api/esign-public-api';
31
+ export * from './api/esign-templates-api';
30
32
  export * from './api/favorites-api';
31
33
  export * from './api/file-controller-api';
32
34
  export * from './api/folder-controller-api';