@openfilz-sdk/typescript-ee 1.4.3 → 1.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +20 -0
- package/.openapi-generator/openfilz-api-generate-typescript-sdk.sha256 +1 -1
- package/README.md +20 -2
- package/api/digital-signature-api.ts +405 -0
- package/api/digital-signature-public-api.ts +463 -0
- package/api.ts +2 -0
- package/dist/api/digital-signature-api.d.ts +188 -0
- package/dist/api/digital-signature-api.js +395 -0
- package/dist/api/digital-signature-public-api.d.ts +213 -0
- package/dist/api/digital-signature-public-api.js +446 -0
- package/dist/api.d.ts +2 -0
- package/dist/api.js +2 -0
- package/dist/esm/api/digital-signature-api.d.ts +188 -0
- package/dist/esm/api/digital-signature-api.js +388 -0
- package/dist/esm/api/digital-signature-public-api.d.ts +213 -0
- package/dist/esm/api/digital-signature-public-api.js +439 -0
- package/dist/esm/api.d.ts +2 -0
- package/dist/esm/api.js +2 -0
- package/dist/esm/models/apply-signature-request.d.ts +15 -0
- package/dist/esm/models/apply-signature-request.js +14 -0
- package/dist/esm/models/create-signature-envelope-request.d.ts +19 -0
- package/dist/esm/models/create-signature-envelope-request.js +14 -0
- package/dist/esm/models/decline-signature-request.d.ts +14 -0
- package/dist/esm/models/decline-signature-request.js +14 -0
- package/dist/esm/models/enriched-audit-log.d.ts +7 -0
- package/dist/esm/models/enriched-audit-log.js +8 -1
- package/dist/esm/models/index.d.ts +8 -0
- package/dist/esm/models/index.js +8 -0
- package/dist/esm/models/mint-upload-token-request.d.ts +1 -0
- package/dist/esm/models/notification-dto.d.ts +3 -0
- package/dist/esm/models/notification-dto.js +4 -1
- package/dist/esm/models/public-signature-view.d.ts +44 -0
- package/dist/esm/models/public-signature-view.js +27 -0
- package/dist/esm/models/search-by-audit-log-request.d.ts +7 -0
- package/dist/esm/models/search-by-audit-log-request.js +8 -1
- package/dist/esm/models/signature-envelope-dto.d.ts +34 -0
- package/dist/esm/models/signature-envelope-dto.js +21 -0
- package/dist/esm/models/signature-field-placement.d.ts +18 -0
- package/dist/esm/models/signature-field-placement.js +14 -0
- package/dist/esm/models/signature-recipient-dto.d.ts +29 -0
- package/dist/esm/models/signature-recipient-dto.js +19 -0
- package/dist/esm/models/signature-recipient-input.d.ts +18 -0
- package/dist/esm/models/signature-recipient-input.js +14 -0
- package/dist/models/apply-signature-request.d.ts +15 -0
- package/dist/models/apply-signature-request.js +15 -0
- package/dist/models/create-signature-envelope-request.d.ts +19 -0
- package/dist/models/create-signature-envelope-request.js +15 -0
- package/dist/models/decline-signature-request.d.ts +14 -0
- package/dist/models/decline-signature-request.js +15 -0
- package/dist/models/enriched-audit-log.d.ts +7 -0
- package/dist/models/enriched-audit-log.js +8 -1
- package/dist/models/index.d.ts +8 -0
- package/dist/models/index.js +8 -0
- package/dist/models/mint-upload-token-request.d.ts +1 -0
- package/dist/models/notification-dto.d.ts +3 -0
- package/dist/models/notification-dto.js +4 -1
- package/dist/models/public-signature-view.d.ts +44 -0
- package/dist/models/public-signature-view.js +30 -0
- package/dist/models/search-by-audit-log-request.d.ts +7 -0
- package/dist/models/search-by-audit-log-request.js +8 -1
- package/dist/models/signature-envelope-dto.d.ts +34 -0
- package/dist/models/signature-envelope-dto.js +24 -0
- package/dist/models/signature-field-placement.d.ts +18 -0
- package/dist/models/signature-field-placement.js +15 -0
- package/dist/models/signature-recipient-dto.d.ts +29 -0
- package/dist/models/signature-recipient-dto.js +22 -0
- package/dist/models/signature-recipient-input.d.ts +18 -0
- package/dist/models/signature-recipient-input.js +15 -0
- package/docs/ApplySignatureRequest.md +22 -0
- package/docs/CreateSignatureEnvelopeRequest.md +28 -0
- package/docs/DeclineSignatureRequest.md +20 -0
- package/docs/DigitalSignatureApi.md +249 -0
- package/docs/DigitalSignaturePublicApi.md +276 -0
- package/docs/MintUploadTokenRequest.md +2 -0
- package/docs/PublicSignatureView.md +48 -0
- package/docs/SignatureEnvelopeDTO.md +40 -0
- package/docs/SignatureFieldPlacement.md +28 -0
- package/docs/SignatureRecipientDTO.md +36 -0
- package/docs/SignatureRecipientInput.md +26 -0
- package/models/apply-signature-request.ts +21 -0
- package/models/create-signature-envelope-request.ts +27 -0
- package/models/decline-signature-request.ts +20 -0
- package/models/enriched-audit-log.ts +8 -1
- package/models/index.ts +8 -0
- package/models/mint-upload-token-request.ts +1 -0
- package/models/notification-dto.ts +4 -1
- package/models/public-signature-view.ts +54 -0
- package/models/search-by-audit-log-request.ts +8 -1
- package/models/signature-envelope-dto.ts +45 -0
- package/models/signature-field-placement.ts +24 -0
- package/models/signature-recipient-dto.ts +38 -0
- package/models/signature-recipient-input.ts +26 -0
- package/package.json +1 -1
|
@@ -0,0 +1,463 @@
|
|
|
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 { ApplySignatureRequest } from '../models';
|
|
26
|
+
// @ts-ignore
|
|
27
|
+
import type { DeclineSignatureRequest } from '../models';
|
|
28
|
+
// @ts-ignore
|
|
29
|
+
import type { PublicSignatureView } from '../models';
|
|
30
|
+
/**
|
|
31
|
+
* DigitalSignaturePublicApi - axios parameter creator
|
|
32
|
+
*/
|
|
33
|
+
export const DigitalSignaturePublicApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
34
|
+
return {
|
|
35
|
+
/**
|
|
36
|
+
*
|
|
37
|
+
* @summary Decline to sign (voids the envelope)
|
|
38
|
+
* @param {string} token
|
|
39
|
+
* @param {DeclineSignatureRequest} [declineSignatureRequest]
|
|
40
|
+
* @param {*} [options] Override http request option.
|
|
41
|
+
* @throws {RequiredError}
|
|
42
|
+
*/
|
|
43
|
+
decline1: async (token: string, declineSignatureRequest?: DeclineSignatureRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
44
|
+
// verify required parameter 'token' is not null or undefined
|
|
45
|
+
assertParamExists('decline1', 'token', token)
|
|
46
|
+
const localVarPath = `/api/v1/public/signatures/decline`;
|
|
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
|
+
if (token !== undefined) {
|
|
63
|
+
localVarQueryParameter['token'] = token;
|
|
64
|
+
}
|
|
65
|
+
|
|
66
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
67
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
68
|
+
|
|
69
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
70
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
71
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
72
|
+
localVarRequestOptions.data = serializeDataIfNeeded(declineSignatureRequest, localVarRequestOptions, configuration)
|
|
73
|
+
|
|
74
|
+
return {
|
|
75
|
+
url: toPathString(localVarUrlObj),
|
|
76
|
+
options: localVarRequestOptions,
|
|
77
|
+
};
|
|
78
|
+
},
|
|
79
|
+
/**
|
|
80
|
+
*
|
|
81
|
+
* @summary Stream the source PDF for signing
|
|
82
|
+
* @param {string} token
|
|
83
|
+
* @param {*} [options] Override http request option.
|
|
84
|
+
* @throws {RequiredError}
|
|
85
|
+
*/
|
|
86
|
+
document: async (token: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
87
|
+
// verify required parameter 'token' is not null or undefined
|
|
88
|
+
assertParamExists('document', 'token', token)
|
|
89
|
+
const localVarPath = `/api/v1/public/signatures/document`;
|
|
90
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
91
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
92
|
+
let baseOptions;
|
|
93
|
+
if (configuration) {
|
|
94
|
+
baseOptions = configuration.baseOptions;
|
|
95
|
+
}
|
|
96
|
+
|
|
97
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
98
|
+
const localVarHeaderParameter = {} as any;
|
|
99
|
+
const localVarQueryParameter = {} as any;
|
|
100
|
+
|
|
101
|
+
// authentication keycloak_auth required
|
|
102
|
+
// http bearer authentication required
|
|
103
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
104
|
+
|
|
105
|
+
if (token !== undefined) {
|
|
106
|
+
localVarQueryParameter['token'] = token;
|
|
107
|
+
}
|
|
108
|
+
|
|
109
|
+
localVarHeaderParameter['Accept'] = 'application/pdf';
|
|
110
|
+
|
|
111
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
112
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
113
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
114
|
+
|
|
115
|
+
return {
|
|
116
|
+
url: toPathString(localVarUrlObj),
|
|
117
|
+
options: localVarRequestOptions,
|
|
118
|
+
};
|
|
119
|
+
},
|
|
120
|
+
/**
|
|
121
|
+
*
|
|
122
|
+
* @summary Record that the recipient opened the document
|
|
123
|
+
* @param {string} token
|
|
124
|
+
* @param {string} [userAgent]
|
|
125
|
+
* @param {*} [options] Override http request option.
|
|
126
|
+
* @throws {RequiredError}
|
|
127
|
+
*/
|
|
128
|
+
markViewed: async (token: string, userAgent?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
129
|
+
// verify required parameter 'token' is not null or undefined
|
|
130
|
+
assertParamExists('markViewed', 'token', token)
|
|
131
|
+
const localVarPath = `/api/v1/public/signatures/viewed`;
|
|
132
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
133
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
134
|
+
let baseOptions;
|
|
135
|
+
if (configuration) {
|
|
136
|
+
baseOptions = configuration.baseOptions;
|
|
137
|
+
}
|
|
138
|
+
|
|
139
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
140
|
+
const localVarHeaderParameter = {} as any;
|
|
141
|
+
const localVarQueryParameter = {} as any;
|
|
142
|
+
|
|
143
|
+
// authentication keycloak_auth required
|
|
144
|
+
// http bearer authentication required
|
|
145
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
146
|
+
|
|
147
|
+
if (token !== undefined) {
|
|
148
|
+
localVarQueryParameter['token'] = token;
|
|
149
|
+
}
|
|
150
|
+
|
|
151
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
152
|
+
|
|
153
|
+
if (userAgent != null) {
|
|
154
|
+
localVarHeaderParameter['User-Agent'] = String(userAgent);
|
|
155
|
+
}
|
|
156
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
157
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
158
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
159
|
+
|
|
160
|
+
return {
|
|
161
|
+
url: toPathString(localVarUrlObj),
|
|
162
|
+
options: localVarRequestOptions,
|
|
163
|
+
};
|
|
164
|
+
},
|
|
165
|
+
/**
|
|
166
|
+
*
|
|
167
|
+
* @summary Apply the recipient\'s signature
|
|
168
|
+
* @param {string} token
|
|
169
|
+
* @param {ApplySignatureRequest} applySignatureRequest
|
|
170
|
+
* @param {string} [userAgent]
|
|
171
|
+
* @param {*} [options] Override http request option.
|
|
172
|
+
* @throws {RequiredError}
|
|
173
|
+
*/
|
|
174
|
+
sign: async (token: string, applySignatureRequest: ApplySignatureRequest, userAgent?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
175
|
+
// verify required parameter 'token' is not null or undefined
|
|
176
|
+
assertParamExists('sign', 'token', token)
|
|
177
|
+
// verify required parameter 'applySignatureRequest' is not null or undefined
|
|
178
|
+
assertParamExists('sign', 'applySignatureRequest', applySignatureRequest)
|
|
179
|
+
const localVarPath = `/api/v1/public/signatures/sign`;
|
|
180
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
181
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
182
|
+
let baseOptions;
|
|
183
|
+
if (configuration) {
|
|
184
|
+
baseOptions = configuration.baseOptions;
|
|
185
|
+
}
|
|
186
|
+
|
|
187
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
188
|
+
const localVarHeaderParameter = {} as any;
|
|
189
|
+
const localVarQueryParameter = {} as any;
|
|
190
|
+
|
|
191
|
+
// authentication keycloak_auth required
|
|
192
|
+
// http bearer authentication required
|
|
193
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
194
|
+
|
|
195
|
+
if (token !== undefined) {
|
|
196
|
+
localVarQueryParameter['token'] = token;
|
|
197
|
+
}
|
|
198
|
+
|
|
199
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
200
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
201
|
+
|
|
202
|
+
if (userAgent != null) {
|
|
203
|
+
localVarHeaderParameter['User-Agent'] = String(userAgent);
|
|
204
|
+
}
|
|
205
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
206
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
207
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
208
|
+
localVarRequestOptions.data = serializeDataIfNeeded(applySignatureRequest, localVarRequestOptions, configuration)
|
|
209
|
+
|
|
210
|
+
return {
|
|
211
|
+
url: toPathString(localVarUrlObj),
|
|
212
|
+
options: localVarRequestOptions,
|
|
213
|
+
};
|
|
214
|
+
},
|
|
215
|
+
/**
|
|
216
|
+
*
|
|
217
|
+
* @summary Resolve a signing token to its envelope view
|
|
218
|
+
* @param {string} token
|
|
219
|
+
* @param {*} [options] Override http request option.
|
|
220
|
+
* @throws {RequiredError}
|
|
221
|
+
*/
|
|
222
|
+
view: async (token: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
223
|
+
// verify required parameter 'token' is not null or undefined
|
|
224
|
+
assertParamExists('view', 'token', token)
|
|
225
|
+
const localVarPath = `/api/v1/public/signatures`;
|
|
226
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
227
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
228
|
+
let baseOptions;
|
|
229
|
+
if (configuration) {
|
|
230
|
+
baseOptions = configuration.baseOptions;
|
|
231
|
+
}
|
|
232
|
+
|
|
233
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
234
|
+
const localVarHeaderParameter = {} as any;
|
|
235
|
+
const localVarQueryParameter = {} as any;
|
|
236
|
+
|
|
237
|
+
// authentication keycloak_auth required
|
|
238
|
+
// http bearer authentication required
|
|
239
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
240
|
+
|
|
241
|
+
if (token !== undefined) {
|
|
242
|
+
localVarQueryParameter['token'] = token;
|
|
243
|
+
}
|
|
244
|
+
|
|
245
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
246
|
+
|
|
247
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
248
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
249
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
250
|
+
|
|
251
|
+
return {
|
|
252
|
+
url: toPathString(localVarUrlObj),
|
|
253
|
+
options: localVarRequestOptions,
|
|
254
|
+
};
|
|
255
|
+
},
|
|
256
|
+
}
|
|
257
|
+
};
|
|
258
|
+
|
|
259
|
+
/**
|
|
260
|
+
* DigitalSignaturePublicApi - functional programming interface
|
|
261
|
+
*/
|
|
262
|
+
export const DigitalSignaturePublicApiFp = function(configuration?: Configuration) {
|
|
263
|
+
const localVarAxiosParamCreator = DigitalSignaturePublicApiAxiosParamCreator(configuration)
|
|
264
|
+
return {
|
|
265
|
+
/**
|
|
266
|
+
*
|
|
267
|
+
* @summary Decline to sign (voids the envelope)
|
|
268
|
+
* @param {string} token
|
|
269
|
+
* @param {DeclineSignatureRequest} [declineSignatureRequest]
|
|
270
|
+
* @param {*} [options] Override http request option.
|
|
271
|
+
* @throws {RequiredError}
|
|
272
|
+
*/
|
|
273
|
+
async decline1(token: string, declineSignatureRequest?: DeclineSignatureRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PublicSignatureView>> {
|
|
274
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.decline1(token, declineSignatureRequest, options);
|
|
275
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
276
|
+
const localVarOperationServerBasePath = operationServerMap['DigitalSignaturePublicApi.decline1']?.[localVarOperationServerIndex]?.url;
|
|
277
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
278
|
+
},
|
|
279
|
+
/**
|
|
280
|
+
*
|
|
281
|
+
* @summary Stream the source PDF for signing
|
|
282
|
+
* @param {string} token
|
|
283
|
+
* @param {*} [options] Override http request option.
|
|
284
|
+
* @throws {RequiredError}
|
|
285
|
+
*/
|
|
286
|
+
async document(token: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>> {
|
|
287
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.document(token, options);
|
|
288
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
289
|
+
const localVarOperationServerBasePath = operationServerMap['DigitalSignaturePublicApi.document']?.[localVarOperationServerIndex]?.url;
|
|
290
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
291
|
+
},
|
|
292
|
+
/**
|
|
293
|
+
*
|
|
294
|
+
* @summary Record that the recipient opened the document
|
|
295
|
+
* @param {string} token
|
|
296
|
+
* @param {string} [userAgent]
|
|
297
|
+
* @param {*} [options] Override http request option.
|
|
298
|
+
* @throws {RequiredError}
|
|
299
|
+
*/
|
|
300
|
+
async markViewed(token: string, userAgent?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PublicSignatureView>> {
|
|
301
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.markViewed(token, userAgent, options);
|
|
302
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
303
|
+
const localVarOperationServerBasePath = operationServerMap['DigitalSignaturePublicApi.markViewed']?.[localVarOperationServerIndex]?.url;
|
|
304
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
305
|
+
},
|
|
306
|
+
/**
|
|
307
|
+
*
|
|
308
|
+
* @summary Apply the recipient\'s signature
|
|
309
|
+
* @param {string} token
|
|
310
|
+
* @param {ApplySignatureRequest} applySignatureRequest
|
|
311
|
+
* @param {string} [userAgent]
|
|
312
|
+
* @param {*} [options] Override http request option.
|
|
313
|
+
* @throws {RequiredError}
|
|
314
|
+
*/
|
|
315
|
+
async sign(token: string, applySignatureRequest: ApplySignatureRequest, userAgent?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PublicSignatureView>> {
|
|
316
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.sign(token, applySignatureRequest, userAgent, options);
|
|
317
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
318
|
+
const localVarOperationServerBasePath = operationServerMap['DigitalSignaturePublicApi.sign']?.[localVarOperationServerIndex]?.url;
|
|
319
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
320
|
+
},
|
|
321
|
+
/**
|
|
322
|
+
*
|
|
323
|
+
* @summary Resolve a signing token to its envelope view
|
|
324
|
+
* @param {string} token
|
|
325
|
+
* @param {*} [options] Override http request option.
|
|
326
|
+
* @throws {RequiredError}
|
|
327
|
+
*/
|
|
328
|
+
async view(token: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PublicSignatureView>> {
|
|
329
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.view(token, options);
|
|
330
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
331
|
+
const localVarOperationServerBasePath = operationServerMap['DigitalSignaturePublicApi.view']?.[localVarOperationServerIndex]?.url;
|
|
332
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
333
|
+
},
|
|
334
|
+
}
|
|
335
|
+
};
|
|
336
|
+
|
|
337
|
+
/**
|
|
338
|
+
* DigitalSignaturePublicApi - factory interface
|
|
339
|
+
*/
|
|
340
|
+
export const DigitalSignaturePublicApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
341
|
+
const localVarFp = DigitalSignaturePublicApiFp(configuration)
|
|
342
|
+
return {
|
|
343
|
+
/**
|
|
344
|
+
*
|
|
345
|
+
* @summary Decline to sign (voids the envelope)
|
|
346
|
+
* @param {string} token
|
|
347
|
+
* @param {DeclineSignatureRequest} [declineSignatureRequest]
|
|
348
|
+
* @param {*} [options] Override http request option.
|
|
349
|
+
* @throws {RequiredError}
|
|
350
|
+
*/
|
|
351
|
+
decline1(token: string, declineSignatureRequest?: DeclineSignatureRequest, options?: RawAxiosRequestConfig): AxiosPromise<PublicSignatureView> {
|
|
352
|
+
return localVarFp.decline1(token, declineSignatureRequest, options).then((request) => request(axios, basePath));
|
|
353
|
+
},
|
|
354
|
+
/**
|
|
355
|
+
*
|
|
356
|
+
* @summary Stream the source PDF for signing
|
|
357
|
+
* @param {string} token
|
|
358
|
+
* @param {*} [options] Override http request option.
|
|
359
|
+
* @throws {RequiredError}
|
|
360
|
+
*/
|
|
361
|
+
document(token: string, options?: RawAxiosRequestConfig): AxiosPromise<File> {
|
|
362
|
+
return localVarFp.document(token, options).then((request) => request(axios, basePath));
|
|
363
|
+
},
|
|
364
|
+
/**
|
|
365
|
+
*
|
|
366
|
+
* @summary Record that the recipient opened the document
|
|
367
|
+
* @param {string} token
|
|
368
|
+
* @param {string} [userAgent]
|
|
369
|
+
* @param {*} [options] Override http request option.
|
|
370
|
+
* @throws {RequiredError}
|
|
371
|
+
*/
|
|
372
|
+
markViewed(token: string, userAgent?: string, options?: RawAxiosRequestConfig): AxiosPromise<PublicSignatureView> {
|
|
373
|
+
return localVarFp.markViewed(token, userAgent, options).then((request) => request(axios, basePath));
|
|
374
|
+
},
|
|
375
|
+
/**
|
|
376
|
+
*
|
|
377
|
+
* @summary Apply the recipient\'s signature
|
|
378
|
+
* @param {string} token
|
|
379
|
+
* @param {ApplySignatureRequest} applySignatureRequest
|
|
380
|
+
* @param {string} [userAgent]
|
|
381
|
+
* @param {*} [options] Override http request option.
|
|
382
|
+
* @throws {RequiredError}
|
|
383
|
+
*/
|
|
384
|
+
sign(token: string, applySignatureRequest: ApplySignatureRequest, userAgent?: string, options?: RawAxiosRequestConfig): AxiosPromise<PublicSignatureView> {
|
|
385
|
+
return localVarFp.sign(token, applySignatureRequest, userAgent, options).then((request) => request(axios, basePath));
|
|
386
|
+
},
|
|
387
|
+
/**
|
|
388
|
+
*
|
|
389
|
+
* @summary Resolve a signing token to its envelope view
|
|
390
|
+
* @param {string} token
|
|
391
|
+
* @param {*} [options] Override http request option.
|
|
392
|
+
* @throws {RequiredError}
|
|
393
|
+
*/
|
|
394
|
+
view(token: string, options?: RawAxiosRequestConfig): AxiosPromise<PublicSignatureView> {
|
|
395
|
+
return localVarFp.view(token, options).then((request) => request(axios, basePath));
|
|
396
|
+
},
|
|
397
|
+
};
|
|
398
|
+
};
|
|
399
|
+
|
|
400
|
+
/**
|
|
401
|
+
* DigitalSignaturePublicApi - object-oriented interface
|
|
402
|
+
*/
|
|
403
|
+
export class DigitalSignaturePublicApi extends BaseAPI {
|
|
404
|
+
/**
|
|
405
|
+
*
|
|
406
|
+
* @summary Decline to sign (voids the envelope)
|
|
407
|
+
* @param {string} token
|
|
408
|
+
* @param {DeclineSignatureRequest} [declineSignatureRequest]
|
|
409
|
+
* @param {*} [options] Override http request option.
|
|
410
|
+
* @throws {RequiredError}
|
|
411
|
+
*/
|
|
412
|
+
public decline1(token: string, declineSignatureRequest?: DeclineSignatureRequest, options?: RawAxiosRequestConfig) {
|
|
413
|
+
return DigitalSignaturePublicApiFp(this.configuration).decline1(token, declineSignatureRequest, options).then((request) => request(this.axios, this.basePath));
|
|
414
|
+
}
|
|
415
|
+
|
|
416
|
+
/**
|
|
417
|
+
*
|
|
418
|
+
* @summary Stream the source PDF for signing
|
|
419
|
+
* @param {string} token
|
|
420
|
+
* @param {*} [options] Override http request option.
|
|
421
|
+
* @throws {RequiredError}
|
|
422
|
+
*/
|
|
423
|
+
public document(token: string, options?: RawAxiosRequestConfig) {
|
|
424
|
+
return DigitalSignaturePublicApiFp(this.configuration).document(token, options).then((request) => request(this.axios, this.basePath));
|
|
425
|
+
}
|
|
426
|
+
|
|
427
|
+
/**
|
|
428
|
+
*
|
|
429
|
+
* @summary Record that the recipient opened the document
|
|
430
|
+
* @param {string} token
|
|
431
|
+
* @param {string} [userAgent]
|
|
432
|
+
* @param {*} [options] Override http request option.
|
|
433
|
+
* @throws {RequiredError}
|
|
434
|
+
*/
|
|
435
|
+
public markViewed(token: string, userAgent?: string, options?: RawAxiosRequestConfig) {
|
|
436
|
+
return DigitalSignaturePublicApiFp(this.configuration).markViewed(token, userAgent, options).then((request) => request(this.axios, this.basePath));
|
|
437
|
+
}
|
|
438
|
+
|
|
439
|
+
/**
|
|
440
|
+
*
|
|
441
|
+
* @summary Apply the recipient\'s signature
|
|
442
|
+
* @param {string} token
|
|
443
|
+
* @param {ApplySignatureRequest} applySignatureRequest
|
|
444
|
+
* @param {string} [userAgent]
|
|
445
|
+
* @param {*} [options] Override http request option.
|
|
446
|
+
* @throws {RequiredError}
|
|
447
|
+
*/
|
|
448
|
+
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));
|
|
450
|
+
}
|
|
451
|
+
|
|
452
|
+
/**
|
|
453
|
+
*
|
|
454
|
+
* @summary Resolve a signing token to its envelope view
|
|
455
|
+
* @param {string} token
|
|
456
|
+
* @param {*} [options] Override http request option.
|
|
457
|
+
* @throws {RequiredError}
|
|
458
|
+
*/
|
|
459
|
+
public view(token: string, options?: RawAxiosRequestConfig) {
|
|
460
|
+
return DigitalSignaturePublicApiFp(this.configuration).view(token, options).then((request) => request(this.axios, this.basePath));
|
|
461
|
+
}
|
|
462
|
+
}
|
|
463
|
+
|
package/api.ts
CHANGED
|
@@ -20,6 +20,8 @@ export * from './api/comments-api';
|
|
|
20
20
|
export * from './api/dashboard-api';
|
|
21
21
|
export * from './api/delegated-browse-grants-admin-api';
|
|
22
22
|
export * from './api/delegated-browse-grants-end-user-api';
|
|
23
|
+
export * from './api/digital-signature-api';
|
|
24
|
+
export * from './api/digital-signature-public-api';
|
|
23
25
|
export * from './api/document-controller-api';
|
|
24
26
|
export * from './api/document-suggestion-controller-api';
|
|
25
27
|
export * from './api/favorites-api';
|
|
@@ -0,0 +1,188 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* openfilz-api
|
|
3
|
+
* API for Document Management System
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { Configuration } from '../configuration';
|
|
13
|
+
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
14
|
+
import { type RequestArgs, BaseAPI } from '../base';
|
|
15
|
+
import type { CreateSignatureEnvelopeRequest } from '../models';
|
|
16
|
+
import type { SignatureEnvelopeDTO } from '../models';
|
|
17
|
+
/**
|
|
18
|
+
* DigitalSignatureApi - axios parameter creator
|
|
19
|
+
*/
|
|
20
|
+
export declare const DigitalSignatureApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
21
|
+
/**
|
|
22
|
+
*
|
|
23
|
+
* @summary Cancel a non-terminal envelope
|
|
24
|
+
* @param {string} id
|
|
25
|
+
* @param {*} [options] Override http request option.
|
|
26
|
+
* @throws {RequiredError}
|
|
27
|
+
*/
|
|
28
|
+
cancel: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
29
|
+
/**
|
|
30
|
+
*
|
|
31
|
+
* @summary Create and send a signature envelope
|
|
32
|
+
* @param {CreateSignatureEnvelopeRequest} createSignatureEnvelopeRequest
|
|
33
|
+
* @param {*} [options] Override http request option.
|
|
34
|
+
* @throws {RequiredError}
|
|
35
|
+
*/
|
|
36
|
+
create: (createSignatureEnvelopeRequest: CreateSignatureEnvelopeRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
37
|
+
/**
|
|
38
|
+
*
|
|
39
|
+
* @summary Get a single envelope I sent
|
|
40
|
+
* @param {string} id
|
|
41
|
+
* @param {*} [options] Override http request option.
|
|
42
|
+
* @throws {RequiredError}
|
|
43
|
+
*/
|
|
44
|
+
get1: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
45
|
+
/**
|
|
46
|
+
*
|
|
47
|
+
* @summary List envelopes I sent for signature
|
|
48
|
+
* @param {*} [options] Override http request option.
|
|
49
|
+
* @throws {RequiredError}
|
|
50
|
+
*/
|
|
51
|
+
listSent: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
52
|
+
/**
|
|
53
|
+
*
|
|
54
|
+
* @summary List documents waiting for my signature
|
|
55
|
+
* @param {*} [options] Override http request option.
|
|
56
|
+
* @throws {RequiredError}
|
|
57
|
+
*/
|
|
58
|
+
listToSign: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
59
|
+
};
|
|
60
|
+
/**
|
|
61
|
+
* DigitalSignatureApi - functional programming interface
|
|
62
|
+
*/
|
|
63
|
+
export declare const DigitalSignatureApiFp: (configuration?: Configuration) => {
|
|
64
|
+
/**
|
|
65
|
+
*
|
|
66
|
+
* @summary Cancel a non-terminal envelope
|
|
67
|
+
* @param {string} id
|
|
68
|
+
* @param {*} [options] Override http request option.
|
|
69
|
+
* @throws {RequiredError}
|
|
70
|
+
*/
|
|
71
|
+
cancel(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SignatureEnvelopeDTO>>;
|
|
72
|
+
/**
|
|
73
|
+
*
|
|
74
|
+
* @summary Create and send a signature envelope
|
|
75
|
+
* @param {CreateSignatureEnvelopeRequest} createSignatureEnvelopeRequest
|
|
76
|
+
* @param {*} [options] Override http request option.
|
|
77
|
+
* @throws {RequiredError}
|
|
78
|
+
*/
|
|
79
|
+
create(createSignatureEnvelopeRequest: CreateSignatureEnvelopeRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SignatureEnvelopeDTO>>;
|
|
80
|
+
/**
|
|
81
|
+
*
|
|
82
|
+
* @summary Get a single envelope I sent
|
|
83
|
+
* @param {string} id
|
|
84
|
+
* @param {*} [options] Override http request option.
|
|
85
|
+
* @throws {RequiredError}
|
|
86
|
+
*/
|
|
87
|
+
get1(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SignatureEnvelopeDTO>>;
|
|
88
|
+
/**
|
|
89
|
+
*
|
|
90
|
+
* @summary List envelopes I sent for signature
|
|
91
|
+
* @param {*} [options] Override http request option.
|
|
92
|
+
* @throws {RequiredError}
|
|
93
|
+
*/
|
|
94
|
+
listSent(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<SignatureEnvelopeDTO>>>;
|
|
95
|
+
/**
|
|
96
|
+
*
|
|
97
|
+
* @summary List documents waiting for my signature
|
|
98
|
+
* @param {*} [options] Override http request option.
|
|
99
|
+
* @throws {RequiredError}
|
|
100
|
+
*/
|
|
101
|
+
listToSign(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<SignatureEnvelopeDTO>>>;
|
|
102
|
+
};
|
|
103
|
+
/**
|
|
104
|
+
* DigitalSignatureApi - factory interface
|
|
105
|
+
*/
|
|
106
|
+
export declare const DigitalSignatureApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
107
|
+
/**
|
|
108
|
+
*
|
|
109
|
+
* @summary Cancel a non-terminal envelope
|
|
110
|
+
* @param {string} id
|
|
111
|
+
* @param {*} [options] Override http request option.
|
|
112
|
+
* @throws {RequiredError}
|
|
113
|
+
*/
|
|
114
|
+
cancel(id: string, options?: RawAxiosRequestConfig): AxiosPromise<SignatureEnvelopeDTO>;
|
|
115
|
+
/**
|
|
116
|
+
*
|
|
117
|
+
* @summary Create and send a signature envelope
|
|
118
|
+
* @param {CreateSignatureEnvelopeRequest} createSignatureEnvelopeRequest
|
|
119
|
+
* @param {*} [options] Override http request option.
|
|
120
|
+
* @throws {RequiredError}
|
|
121
|
+
*/
|
|
122
|
+
create(createSignatureEnvelopeRequest: CreateSignatureEnvelopeRequest, options?: RawAxiosRequestConfig): AxiosPromise<SignatureEnvelopeDTO>;
|
|
123
|
+
/**
|
|
124
|
+
*
|
|
125
|
+
* @summary Get a single envelope I sent
|
|
126
|
+
* @param {string} id
|
|
127
|
+
* @param {*} [options] Override http request option.
|
|
128
|
+
* @throws {RequiredError}
|
|
129
|
+
*/
|
|
130
|
+
get1(id: string, options?: RawAxiosRequestConfig): AxiosPromise<SignatureEnvelopeDTO>;
|
|
131
|
+
/**
|
|
132
|
+
*
|
|
133
|
+
* @summary List envelopes I sent for signature
|
|
134
|
+
* @param {*} [options] Override http request option.
|
|
135
|
+
* @throws {RequiredError}
|
|
136
|
+
*/
|
|
137
|
+
listSent(options?: RawAxiosRequestConfig): AxiosPromise<Array<SignatureEnvelopeDTO>>;
|
|
138
|
+
/**
|
|
139
|
+
*
|
|
140
|
+
* @summary List documents waiting for my signature
|
|
141
|
+
* @param {*} [options] Override http request option.
|
|
142
|
+
* @throws {RequiredError}
|
|
143
|
+
*/
|
|
144
|
+
listToSign(options?: RawAxiosRequestConfig): AxiosPromise<Array<SignatureEnvelopeDTO>>;
|
|
145
|
+
};
|
|
146
|
+
/**
|
|
147
|
+
* DigitalSignatureApi - object-oriented interface
|
|
148
|
+
*/
|
|
149
|
+
export declare class DigitalSignatureApi extends BaseAPI {
|
|
150
|
+
/**
|
|
151
|
+
*
|
|
152
|
+
* @summary Cancel a non-terminal envelope
|
|
153
|
+
* @param {string} id
|
|
154
|
+
* @param {*} [options] Override http request option.
|
|
155
|
+
* @throws {RequiredError}
|
|
156
|
+
*/
|
|
157
|
+
cancel(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SignatureEnvelopeDTO, any, {}>>;
|
|
158
|
+
/**
|
|
159
|
+
*
|
|
160
|
+
* @summary Create and send a signature envelope
|
|
161
|
+
* @param {CreateSignatureEnvelopeRequest} createSignatureEnvelopeRequest
|
|
162
|
+
* @param {*} [options] Override http request option.
|
|
163
|
+
* @throws {RequiredError}
|
|
164
|
+
*/
|
|
165
|
+
create(createSignatureEnvelopeRequest: CreateSignatureEnvelopeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SignatureEnvelopeDTO, any, {}>>;
|
|
166
|
+
/**
|
|
167
|
+
*
|
|
168
|
+
* @summary Get a single envelope I sent
|
|
169
|
+
* @param {string} id
|
|
170
|
+
* @param {*} [options] Override http request option.
|
|
171
|
+
* @throws {RequiredError}
|
|
172
|
+
*/
|
|
173
|
+
get1(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SignatureEnvelopeDTO, any, {}>>;
|
|
174
|
+
/**
|
|
175
|
+
*
|
|
176
|
+
* @summary List envelopes I sent for signature
|
|
177
|
+
* @param {*} [options] Override http request option.
|
|
178
|
+
* @throws {RequiredError}
|
|
179
|
+
*/
|
|
180
|
+
listSent(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SignatureEnvelopeDTO[], any, {}>>;
|
|
181
|
+
/**
|
|
182
|
+
*
|
|
183
|
+
* @summary List documents waiting for my signature
|
|
184
|
+
* @param {*} [options] Override http request option.
|
|
185
|
+
* @throws {RequiredError}
|
|
186
|
+
*/
|
|
187
|
+
listToSign(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SignatureEnvelopeDTO[], any, {}>>;
|
|
188
|
+
}
|