@openfilz-sdk/typescript-ee 1.4.4 → 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/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/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/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/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,439 @@
|
|
|
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
|
+
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
15
|
+
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
16
|
+
return new (P || (P = Promise))(function (resolve, reject) {
|
|
17
|
+
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
18
|
+
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
19
|
+
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
20
|
+
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
21
|
+
});
|
|
22
|
+
};
|
|
23
|
+
import globalAxios from 'axios';
|
|
24
|
+
// Some imports not used depending on template conditions
|
|
25
|
+
// @ts-ignore
|
|
26
|
+
import { DUMMY_BASE_URL, assertParamExists, setBearerAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
|
|
27
|
+
// @ts-ignore
|
|
28
|
+
import { BASE_PATH, BaseAPI, operationServerMap } from '../base';
|
|
29
|
+
/**
|
|
30
|
+
* DigitalSignaturePublicApi - axios parameter creator
|
|
31
|
+
*/
|
|
32
|
+
export const DigitalSignaturePublicApiAxiosParamCreator = function (configuration) {
|
|
33
|
+
return {
|
|
34
|
+
/**
|
|
35
|
+
*
|
|
36
|
+
* @summary Decline to sign (voids the envelope)
|
|
37
|
+
* @param {string} token
|
|
38
|
+
* @param {DeclineSignatureRequest} [declineSignatureRequest]
|
|
39
|
+
* @param {*} [options] Override http request option.
|
|
40
|
+
* @throws {RequiredError}
|
|
41
|
+
*/
|
|
42
|
+
decline1: (token_1, declineSignatureRequest_1, ...args_1) => __awaiter(this, [token_1, declineSignatureRequest_1, ...args_1], void 0, function* (token, declineSignatureRequest, options = {}) {
|
|
43
|
+
// verify required parameter 'token' is not null or undefined
|
|
44
|
+
assertParamExists('decline1', 'token', token);
|
|
45
|
+
const localVarPath = `/api/v1/public/signatures/decline`;
|
|
46
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
47
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
48
|
+
let baseOptions;
|
|
49
|
+
if (configuration) {
|
|
50
|
+
baseOptions = configuration.baseOptions;
|
|
51
|
+
}
|
|
52
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
53
|
+
const localVarHeaderParameter = {};
|
|
54
|
+
const localVarQueryParameter = {};
|
|
55
|
+
// authentication keycloak_auth required
|
|
56
|
+
// http bearer authentication required
|
|
57
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
58
|
+
if (token !== undefined) {
|
|
59
|
+
localVarQueryParameter['token'] = token;
|
|
60
|
+
}
|
|
61
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
62
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
63
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
64
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
65
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
66
|
+
localVarRequestOptions.data = serializeDataIfNeeded(declineSignatureRequest, localVarRequestOptions, configuration);
|
|
67
|
+
return {
|
|
68
|
+
url: toPathString(localVarUrlObj),
|
|
69
|
+
options: localVarRequestOptions,
|
|
70
|
+
};
|
|
71
|
+
}),
|
|
72
|
+
/**
|
|
73
|
+
*
|
|
74
|
+
* @summary Stream the source PDF for signing
|
|
75
|
+
* @param {string} token
|
|
76
|
+
* @param {*} [options] Override http request option.
|
|
77
|
+
* @throws {RequiredError}
|
|
78
|
+
*/
|
|
79
|
+
document: (token_1, ...args_1) => __awaiter(this, [token_1, ...args_1], void 0, function* (token, options = {}) {
|
|
80
|
+
// verify required parameter 'token' is not null or undefined
|
|
81
|
+
assertParamExists('document', 'token', token);
|
|
82
|
+
const localVarPath = `/api/v1/public/signatures/document`;
|
|
83
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
84
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
85
|
+
let baseOptions;
|
|
86
|
+
if (configuration) {
|
|
87
|
+
baseOptions = configuration.baseOptions;
|
|
88
|
+
}
|
|
89
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
90
|
+
const localVarHeaderParameter = {};
|
|
91
|
+
const localVarQueryParameter = {};
|
|
92
|
+
// authentication keycloak_auth required
|
|
93
|
+
// http bearer authentication required
|
|
94
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
95
|
+
if (token !== undefined) {
|
|
96
|
+
localVarQueryParameter['token'] = token;
|
|
97
|
+
}
|
|
98
|
+
localVarHeaderParameter['Accept'] = 'application/pdf';
|
|
99
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
100
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
101
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
102
|
+
return {
|
|
103
|
+
url: toPathString(localVarUrlObj),
|
|
104
|
+
options: localVarRequestOptions,
|
|
105
|
+
};
|
|
106
|
+
}),
|
|
107
|
+
/**
|
|
108
|
+
*
|
|
109
|
+
* @summary Record that the recipient opened the document
|
|
110
|
+
* @param {string} token
|
|
111
|
+
* @param {string} [userAgent]
|
|
112
|
+
* @param {*} [options] Override http request option.
|
|
113
|
+
* @throws {RequiredError}
|
|
114
|
+
*/
|
|
115
|
+
markViewed: (token_1, userAgent_1, ...args_1) => __awaiter(this, [token_1, userAgent_1, ...args_1], void 0, function* (token, userAgent, options = {}) {
|
|
116
|
+
// verify required parameter 'token' is not null or undefined
|
|
117
|
+
assertParamExists('markViewed', 'token', token);
|
|
118
|
+
const localVarPath = `/api/v1/public/signatures/viewed`;
|
|
119
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
120
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
121
|
+
let baseOptions;
|
|
122
|
+
if (configuration) {
|
|
123
|
+
baseOptions = configuration.baseOptions;
|
|
124
|
+
}
|
|
125
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
126
|
+
const localVarHeaderParameter = {};
|
|
127
|
+
const localVarQueryParameter = {};
|
|
128
|
+
// authentication keycloak_auth required
|
|
129
|
+
// http bearer authentication required
|
|
130
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
131
|
+
if (token !== undefined) {
|
|
132
|
+
localVarQueryParameter['token'] = token;
|
|
133
|
+
}
|
|
134
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
135
|
+
if (userAgent != null) {
|
|
136
|
+
localVarHeaderParameter['User-Agent'] = String(userAgent);
|
|
137
|
+
}
|
|
138
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
139
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
140
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
141
|
+
return {
|
|
142
|
+
url: toPathString(localVarUrlObj),
|
|
143
|
+
options: localVarRequestOptions,
|
|
144
|
+
};
|
|
145
|
+
}),
|
|
146
|
+
/**
|
|
147
|
+
*
|
|
148
|
+
* @summary Apply the recipient\'s signature
|
|
149
|
+
* @param {string} token
|
|
150
|
+
* @param {ApplySignatureRequest} applySignatureRequest
|
|
151
|
+
* @param {string} [userAgent]
|
|
152
|
+
* @param {*} [options] Override http request option.
|
|
153
|
+
* @throws {RequiredError}
|
|
154
|
+
*/
|
|
155
|
+
sign: (token_1, applySignatureRequest_1, userAgent_1, ...args_1) => __awaiter(this, [token_1, applySignatureRequest_1, userAgent_1, ...args_1], void 0, function* (token, applySignatureRequest, userAgent, options = {}) {
|
|
156
|
+
// verify required parameter 'token' is not null or undefined
|
|
157
|
+
assertParamExists('sign', 'token', token);
|
|
158
|
+
// verify required parameter 'applySignatureRequest' is not null or undefined
|
|
159
|
+
assertParamExists('sign', 'applySignatureRequest', applySignatureRequest);
|
|
160
|
+
const localVarPath = `/api/v1/public/signatures/sign`;
|
|
161
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
162
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
163
|
+
let baseOptions;
|
|
164
|
+
if (configuration) {
|
|
165
|
+
baseOptions = configuration.baseOptions;
|
|
166
|
+
}
|
|
167
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
168
|
+
const localVarHeaderParameter = {};
|
|
169
|
+
const localVarQueryParameter = {};
|
|
170
|
+
// authentication keycloak_auth required
|
|
171
|
+
// http bearer authentication required
|
|
172
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
173
|
+
if (token !== undefined) {
|
|
174
|
+
localVarQueryParameter['token'] = token;
|
|
175
|
+
}
|
|
176
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
177
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
178
|
+
if (userAgent != null) {
|
|
179
|
+
localVarHeaderParameter['User-Agent'] = String(userAgent);
|
|
180
|
+
}
|
|
181
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
182
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
183
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
184
|
+
localVarRequestOptions.data = serializeDataIfNeeded(applySignatureRequest, localVarRequestOptions, configuration);
|
|
185
|
+
return {
|
|
186
|
+
url: toPathString(localVarUrlObj),
|
|
187
|
+
options: localVarRequestOptions,
|
|
188
|
+
};
|
|
189
|
+
}),
|
|
190
|
+
/**
|
|
191
|
+
*
|
|
192
|
+
* @summary Resolve a signing token to its envelope view
|
|
193
|
+
* @param {string} token
|
|
194
|
+
* @param {*} [options] Override http request option.
|
|
195
|
+
* @throws {RequiredError}
|
|
196
|
+
*/
|
|
197
|
+
view: (token_1, ...args_1) => __awaiter(this, [token_1, ...args_1], void 0, function* (token, options = {}) {
|
|
198
|
+
// verify required parameter 'token' is not null or undefined
|
|
199
|
+
assertParamExists('view', 'token', token);
|
|
200
|
+
const localVarPath = `/api/v1/public/signatures`;
|
|
201
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
202
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
203
|
+
let baseOptions;
|
|
204
|
+
if (configuration) {
|
|
205
|
+
baseOptions = configuration.baseOptions;
|
|
206
|
+
}
|
|
207
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
208
|
+
const localVarHeaderParameter = {};
|
|
209
|
+
const localVarQueryParameter = {};
|
|
210
|
+
// authentication keycloak_auth required
|
|
211
|
+
// http bearer authentication required
|
|
212
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
213
|
+
if (token !== undefined) {
|
|
214
|
+
localVarQueryParameter['token'] = token;
|
|
215
|
+
}
|
|
216
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
217
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
218
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
219
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
220
|
+
return {
|
|
221
|
+
url: toPathString(localVarUrlObj),
|
|
222
|
+
options: localVarRequestOptions,
|
|
223
|
+
};
|
|
224
|
+
}),
|
|
225
|
+
};
|
|
226
|
+
};
|
|
227
|
+
/**
|
|
228
|
+
* DigitalSignaturePublicApi - functional programming interface
|
|
229
|
+
*/
|
|
230
|
+
export const DigitalSignaturePublicApiFp = function (configuration) {
|
|
231
|
+
const localVarAxiosParamCreator = DigitalSignaturePublicApiAxiosParamCreator(configuration);
|
|
232
|
+
return {
|
|
233
|
+
/**
|
|
234
|
+
*
|
|
235
|
+
* @summary Decline to sign (voids the envelope)
|
|
236
|
+
* @param {string} token
|
|
237
|
+
* @param {DeclineSignatureRequest} [declineSignatureRequest]
|
|
238
|
+
* @param {*} [options] Override http request option.
|
|
239
|
+
* @throws {RequiredError}
|
|
240
|
+
*/
|
|
241
|
+
decline1(token, declineSignatureRequest, options) {
|
|
242
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
243
|
+
var _a, _b, _c;
|
|
244
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.decline1(token, declineSignatureRequest, options);
|
|
245
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
246
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['DigitalSignaturePublicApi.decline1']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
247
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
248
|
+
});
|
|
249
|
+
},
|
|
250
|
+
/**
|
|
251
|
+
*
|
|
252
|
+
* @summary Stream the source PDF for signing
|
|
253
|
+
* @param {string} token
|
|
254
|
+
* @param {*} [options] Override http request option.
|
|
255
|
+
* @throws {RequiredError}
|
|
256
|
+
*/
|
|
257
|
+
document(token, options) {
|
|
258
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
259
|
+
var _a, _b, _c;
|
|
260
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.document(token, options);
|
|
261
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
262
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['DigitalSignaturePublicApi.document']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
263
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
264
|
+
});
|
|
265
|
+
},
|
|
266
|
+
/**
|
|
267
|
+
*
|
|
268
|
+
* @summary Record that the recipient opened the document
|
|
269
|
+
* @param {string} token
|
|
270
|
+
* @param {string} [userAgent]
|
|
271
|
+
* @param {*} [options] Override http request option.
|
|
272
|
+
* @throws {RequiredError}
|
|
273
|
+
*/
|
|
274
|
+
markViewed(token, userAgent, options) {
|
|
275
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
276
|
+
var _a, _b, _c;
|
|
277
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.markViewed(token, userAgent, options);
|
|
278
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
279
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['DigitalSignaturePublicApi.markViewed']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
280
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
281
|
+
});
|
|
282
|
+
},
|
|
283
|
+
/**
|
|
284
|
+
*
|
|
285
|
+
* @summary Apply the recipient\'s signature
|
|
286
|
+
* @param {string} token
|
|
287
|
+
* @param {ApplySignatureRequest} applySignatureRequest
|
|
288
|
+
* @param {string} [userAgent]
|
|
289
|
+
* @param {*} [options] Override http request option.
|
|
290
|
+
* @throws {RequiredError}
|
|
291
|
+
*/
|
|
292
|
+
sign(token, applySignatureRequest, userAgent, options) {
|
|
293
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
294
|
+
var _a, _b, _c;
|
|
295
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.sign(token, applySignatureRequest, userAgent, options);
|
|
296
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
297
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['DigitalSignaturePublicApi.sign']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
298
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
299
|
+
});
|
|
300
|
+
},
|
|
301
|
+
/**
|
|
302
|
+
*
|
|
303
|
+
* @summary Resolve a signing token to its envelope view
|
|
304
|
+
* @param {string} token
|
|
305
|
+
* @param {*} [options] Override http request option.
|
|
306
|
+
* @throws {RequiredError}
|
|
307
|
+
*/
|
|
308
|
+
view(token, options) {
|
|
309
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
310
|
+
var _a, _b, _c;
|
|
311
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.view(token, options);
|
|
312
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
313
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['DigitalSignaturePublicApi.view']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
314
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
315
|
+
});
|
|
316
|
+
},
|
|
317
|
+
};
|
|
318
|
+
};
|
|
319
|
+
/**
|
|
320
|
+
* DigitalSignaturePublicApi - factory interface
|
|
321
|
+
*/
|
|
322
|
+
export const DigitalSignaturePublicApiFactory = function (configuration, basePath, axios) {
|
|
323
|
+
const localVarFp = DigitalSignaturePublicApiFp(configuration);
|
|
324
|
+
return {
|
|
325
|
+
/**
|
|
326
|
+
*
|
|
327
|
+
* @summary Decline to sign (voids the envelope)
|
|
328
|
+
* @param {string} token
|
|
329
|
+
* @param {DeclineSignatureRequest} [declineSignatureRequest]
|
|
330
|
+
* @param {*} [options] Override http request option.
|
|
331
|
+
* @throws {RequiredError}
|
|
332
|
+
*/
|
|
333
|
+
decline1(token, declineSignatureRequest, options) {
|
|
334
|
+
return localVarFp.decline1(token, declineSignatureRequest, options).then((request) => request(axios, basePath));
|
|
335
|
+
},
|
|
336
|
+
/**
|
|
337
|
+
*
|
|
338
|
+
* @summary Stream the source PDF for signing
|
|
339
|
+
* @param {string} token
|
|
340
|
+
* @param {*} [options] Override http request option.
|
|
341
|
+
* @throws {RequiredError}
|
|
342
|
+
*/
|
|
343
|
+
document(token, options) {
|
|
344
|
+
return localVarFp.document(token, options).then((request) => request(axios, basePath));
|
|
345
|
+
},
|
|
346
|
+
/**
|
|
347
|
+
*
|
|
348
|
+
* @summary Record that the recipient opened the document
|
|
349
|
+
* @param {string} token
|
|
350
|
+
* @param {string} [userAgent]
|
|
351
|
+
* @param {*} [options] Override http request option.
|
|
352
|
+
* @throws {RequiredError}
|
|
353
|
+
*/
|
|
354
|
+
markViewed(token, userAgent, options) {
|
|
355
|
+
return localVarFp.markViewed(token, userAgent, options).then((request) => request(axios, basePath));
|
|
356
|
+
},
|
|
357
|
+
/**
|
|
358
|
+
*
|
|
359
|
+
* @summary Apply the recipient\'s signature
|
|
360
|
+
* @param {string} token
|
|
361
|
+
* @param {ApplySignatureRequest} applySignatureRequest
|
|
362
|
+
* @param {string} [userAgent]
|
|
363
|
+
* @param {*} [options] Override http request option.
|
|
364
|
+
* @throws {RequiredError}
|
|
365
|
+
*/
|
|
366
|
+
sign(token, applySignatureRequest, userAgent, options) {
|
|
367
|
+
return localVarFp.sign(token, applySignatureRequest, userAgent, options).then((request) => request(axios, basePath));
|
|
368
|
+
},
|
|
369
|
+
/**
|
|
370
|
+
*
|
|
371
|
+
* @summary Resolve a signing token to its envelope view
|
|
372
|
+
* @param {string} token
|
|
373
|
+
* @param {*} [options] Override http request option.
|
|
374
|
+
* @throws {RequiredError}
|
|
375
|
+
*/
|
|
376
|
+
view(token, options) {
|
|
377
|
+
return localVarFp.view(token, options).then((request) => request(axios, basePath));
|
|
378
|
+
},
|
|
379
|
+
};
|
|
380
|
+
};
|
|
381
|
+
/**
|
|
382
|
+
* DigitalSignaturePublicApi - object-oriented interface
|
|
383
|
+
*/
|
|
384
|
+
export class DigitalSignaturePublicApi extends BaseAPI {
|
|
385
|
+
/**
|
|
386
|
+
*
|
|
387
|
+
* @summary Decline to sign (voids the envelope)
|
|
388
|
+
* @param {string} token
|
|
389
|
+
* @param {DeclineSignatureRequest} [declineSignatureRequest]
|
|
390
|
+
* @param {*} [options] Override http request option.
|
|
391
|
+
* @throws {RequiredError}
|
|
392
|
+
*/
|
|
393
|
+
decline1(token, declineSignatureRequest, options) {
|
|
394
|
+
return DigitalSignaturePublicApiFp(this.configuration).decline1(token, declineSignatureRequest, options).then((request) => request(this.axios, this.basePath));
|
|
395
|
+
}
|
|
396
|
+
/**
|
|
397
|
+
*
|
|
398
|
+
* @summary Stream the source PDF for signing
|
|
399
|
+
* @param {string} token
|
|
400
|
+
* @param {*} [options] Override http request option.
|
|
401
|
+
* @throws {RequiredError}
|
|
402
|
+
*/
|
|
403
|
+
document(token, options) {
|
|
404
|
+
return DigitalSignaturePublicApiFp(this.configuration).document(token, options).then((request) => request(this.axios, this.basePath));
|
|
405
|
+
}
|
|
406
|
+
/**
|
|
407
|
+
*
|
|
408
|
+
* @summary Record that the recipient opened the document
|
|
409
|
+
* @param {string} token
|
|
410
|
+
* @param {string} [userAgent]
|
|
411
|
+
* @param {*} [options] Override http request option.
|
|
412
|
+
* @throws {RequiredError}
|
|
413
|
+
*/
|
|
414
|
+
markViewed(token, userAgent, options) {
|
|
415
|
+
return DigitalSignaturePublicApiFp(this.configuration).markViewed(token, userAgent, options).then((request) => request(this.axios, this.basePath));
|
|
416
|
+
}
|
|
417
|
+
/**
|
|
418
|
+
*
|
|
419
|
+
* @summary Apply the recipient\'s signature
|
|
420
|
+
* @param {string} token
|
|
421
|
+
* @param {ApplySignatureRequest} applySignatureRequest
|
|
422
|
+
* @param {string} [userAgent]
|
|
423
|
+
* @param {*} [options] Override http request option.
|
|
424
|
+
* @throws {RequiredError}
|
|
425
|
+
*/
|
|
426
|
+
sign(token, applySignatureRequest, userAgent, options) {
|
|
427
|
+
return DigitalSignaturePublicApiFp(this.configuration).sign(token, applySignatureRequest, userAgent, options).then((request) => request(this.axios, this.basePath));
|
|
428
|
+
}
|
|
429
|
+
/**
|
|
430
|
+
*
|
|
431
|
+
* @summary Resolve a signing token to its envelope view
|
|
432
|
+
* @param {string} token
|
|
433
|
+
* @param {*} [options] Override http request option.
|
|
434
|
+
* @throws {RequiredError}
|
|
435
|
+
*/
|
|
436
|
+
view(token, options) {
|
|
437
|
+
return DigitalSignaturePublicApiFp(this.configuration).view(token, options).then((request) => request(this.axios, this.basePath));
|
|
438
|
+
}
|
|
439
|
+
}
|
package/dist/esm/api.d.ts
CHANGED
|
@@ -15,6 +15,8 @@ export * from './api/comments-api';
|
|
|
15
15
|
export * from './api/dashboard-api';
|
|
16
16
|
export * from './api/delegated-browse-grants-admin-api';
|
|
17
17
|
export * from './api/delegated-browse-grants-end-user-api';
|
|
18
|
+
export * from './api/digital-signature-api';
|
|
19
|
+
export * from './api/digital-signature-public-api';
|
|
18
20
|
export * from './api/document-controller-api';
|
|
19
21
|
export * from './api/document-suggestion-controller-api';
|
|
20
22
|
export * from './api/favorites-api';
|
package/dist/esm/api.js
CHANGED
|
@@ -17,6 +17,8 @@ export * from './api/comments-api';
|
|
|
17
17
|
export * from './api/dashboard-api';
|
|
18
18
|
export * from './api/delegated-browse-grants-admin-api';
|
|
19
19
|
export * from './api/delegated-browse-grants-end-user-api';
|
|
20
|
+
export * from './api/digital-signature-api';
|
|
21
|
+
export * from './api/digital-signature-public-api';
|
|
20
22
|
export * from './api/document-controller-api';
|
|
21
23
|
export * from './api/document-suggestion-controller-api';
|
|
22
24
|
export * from './api/favorites-api';
|
|
@@ -0,0 +1,15 @@
|
|
|
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
|
+
export interface ApplySignatureRequest {
|
|
13
|
+
'signatureImage'?: string;
|
|
14
|
+
'typedName'?: string;
|
|
15
|
+
}
|
|
@@ -0,0 +1,14 @@
|
|
|
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
|
+
export {};
|
|
@@ -0,0 +1,19 @@
|
|
|
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 { SignatureRecipientInput } from './signature-recipient-input';
|
|
13
|
+
export interface CreateSignatureEnvelopeRequest {
|
|
14
|
+
'sourceDocId': string;
|
|
15
|
+
'title': string;
|
|
16
|
+
'message'?: string;
|
|
17
|
+
'recipients': Array<SignatureRecipientInput>;
|
|
18
|
+
'expiresInDays'?: number;
|
|
19
|
+
}
|
|
@@ -0,0 +1,14 @@
|
|
|
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
|
+
export {};
|
|
@@ -0,0 +1,14 @@
|
|
|
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
|
+
export interface DeclineSignatureRequest {
|
|
13
|
+
'reason'?: string;
|
|
14
|
+
}
|
|
@@ -0,0 +1,14 @@
|
|
|
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
|
+
export {};
|
|
@@ -65,6 +65,13 @@ export declare const EnrichedAuditLogActionEnum: {
|
|
|
65
65
|
readonly DelegatedGrantSubscriptionRevokedByAdmin: "DELEGATED_GRANT_SUBSCRIPTION_REVOKED_BY_ADMIN";
|
|
66
66
|
readonly DelegatedBrowse: "DELEGATED_BROWSE";
|
|
67
67
|
readonly AdminMonitoringOptOutChanged: "ADMIN_MONITORING_OPT_OUT_CHANGED";
|
|
68
|
+
readonly SignatureEnvelopeCreated: "SIGNATURE_ENVELOPE_CREATED";
|
|
69
|
+
readonly SignatureEnvelopeSent: "SIGNATURE_ENVELOPE_SENT";
|
|
70
|
+
readonly SignatureDocumentSigned: "SIGNATURE_DOCUMENT_SIGNED";
|
|
71
|
+
readonly SignatureEnvelopeCompleted: "SIGNATURE_ENVELOPE_COMPLETED";
|
|
72
|
+
readonly SignatureEnvelopeDeclined: "SIGNATURE_ENVELOPE_DECLINED";
|
|
73
|
+
readonly SignatureEnvelopeCancelled: "SIGNATURE_ENVELOPE_CANCELLED";
|
|
74
|
+
readonly SignatureEnvelopeExpired: "SIGNATURE_ENVELOPE_EXPIRED";
|
|
68
75
|
};
|
|
69
76
|
export type EnrichedAuditLogActionEnum = typeof EnrichedAuditLogActionEnum[keyof typeof EnrichedAuditLogActionEnum];
|
|
70
77
|
export declare const EnrichedAuditLogResourceTypeEnum: {
|
|
@@ -50,7 +50,14 @@ export const EnrichedAuditLogActionEnum = {
|
|
|
50
50
|
DelegatedGrantConsumed: 'DELEGATED_GRANT_CONSUMED',
|
|
51
51
|
DelegatedGrantSubscriptionRevokedByAdmin: 'DELEGATED_GRANT_SUBSCRIPTION_REVOKED_BY_ADMIN',
|
|
52
52
|
DelegatedBrowse: 'DELEGATED_BROWSE',
|
|
53
|
-
AdminMonitoringOptOutChanged: 'ADMIN_MONITORING_OPT_OUT_CHANGED'
|
|
53
|
+
AdminMonitoringOptOutChanged: 'ADMIN_MONITORING_OPT_OUT_CHANGED',
|
|
54
|
+
SignatureEnvelopeCreated: 'SIGNATURE_ENVELOPE_CREATED',
|
|
55
|
+
SignatureEnvelopeSent: 'SIGNATURE_ENVELOPE_SENT',
|
|
56
|
+
SignatureDocumentSigned: 'SIGNATURE_DOCUMENT_SIGNED',
|
|
57
|
+
SignatureEnvelopeCompleted: 'SIGNATURE_ENVELOPE_COMPLETED',
|
|
58
|
+
SignatureEnvelopeDeclined: 'SIGNATURE_ENVELOPE_DECLINED',
|
|
59
|
+
SignatureEnvelopeCancelled: 'SIGNATURE_ENVELOPE_CANCELLED',
|
|
60
|
+
SignatureEnvelopeExpired: 'SIGNATURE_ENVELOPE_EXPIRED'
|
|
54
61
|
};
|
|
55
62
|
export const EnrichedAuditLogResourceTypeEnum = {
|
|
56
63
|
File: 'FILE',
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
export * from './ancestor-info';
|
|
2
|
+
export * from './apply-signature-request';
|
|
2
3
|
export * from './audit-log-details';
|
|
3
4
|
export * from './audit-verification-result';
|
|
4
5
|
export * from './broken-link';
|
|
@@ -12,8 +13,10 @@ export * from './create-comment-request';
|
|
|
12
13
|
export * from './create-delegated-grant-request';
|
|
13
14
|
export * from './create-folder-audit';
|
|
14
15
|
export * from './create-folder-request';
|
|
16
|
+
export * from './create-signature-envelope-request';
|
|
15
17
|
export * from './create-team-request';
|
|
16
18
|
export * from './dashboard-statistics-response';
|
|
19
|
+
export * from './decline-signature-request';
|
|
17
20
|
export * from './delegated-folder-node';
|
|
18
21
|
export * from './delegated-grant-dto';
|
|
19
22
|
export * from './delete-audit';
|
|
@@ -35,6 +38,7 @@ export * from './mint-upload-token-request';
|
|
|
35
38
|
export * from './move-audit';
|
|
36
39
|
export * from './move-request';
|
|
37
40
|
export * from './notification-dto';
|
|
41
|
+
export * from './public-signature-view';
|
|
38
42
|
export * from './rename-audit';
|
|
39
43
|
export * from './rename-request';
|
|
40
44
|
export * from './replace-audit';
|
|
@@ -49,6 +53,10 @@ export * from './share-request';
|
|
|
49
53
|
export * from './share-result-error';
|
|
50
54
|
export * from './share-result-item';
|
|
51
55
|
export * from './share-result-response';
|
|
56
|
+
export * from './signature-envelope-dto';
|
|
57
|
+
export * from './signature-field-placement';
|
|
58
|
+
export * from './signature-recipient-dto';
|
|
59
|
+
export * from './signature-recipient-input';
|
|
52
60
|
export * from './sort-input';
|
|
53
61
|
export * from './storage-breakdown';
|
|
54
62
|
export * from './suggest';
|
package/dist/esm/models/index.js
CHANGED
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
export * from './ancestor-info';
|
|
2
|
+
export * from './apply-signature-request';
|
|
2
3
|
export * from './audit-log-details';
|
|
3
4
|
export * from './audit-verification-result';
|
|
4
5
|
export * from './broken-link';
|
|
@@ -12,8 +13,10 @@ export * from './create-comment-request';
|
|
|
12
13
|
export * from './create-delegated-grant-request';
|
|
13
14
|
export * from './create-folder-audit';
|
|
14
15
|
export * from './create-folder-request';
|
|
16
|
+
export * from './create-signature-envelope-request';
|
|
15
17
|
export * from './create-team-request';
|
|
16
18
|
export * from './dashboard-statistics-response';
|
|
19
|
+
export * from './decline-signature-request';
|
|
17
20
|
export * from './delegated-folder-node';
|
|
18
21
|
export * from './delegated-grant-dto';
|
|
19
22
|
export * from './delete-audit';
|
|
@@ -35,6 +38,7 @@ export * from './mint-upload-token-request';
|
|
|
35
38
|
export * from './move-audit';
|
|
36
39
|
export * from './move-request';
|
|
37
40
|
export * from './notification-dto';
|
|
41
|
+
export * from './public-signature-view';
|
|
38
42
|
export * from './rename-audit';
|
|
39
43
|
export * from './rename-request';
|
|
40
44
|
export * from './replace-audit';
|
|
@@ -49,6 +53,10 @@ export * from './share-request';
|
|
|
49
53
|
export * from './share-result-error';
|
|
50
54
|
export * from './share-result-item';
|
|
51
55
|
export * from './share-result-response';
|
|
56
|
+
export * from './signature-envelope-dto';
|
|
57
|
+
export * from './signature-field-placement';
|
|
58
|
+
export * from './signature-recipient-dto';
|
|
59
|
+
export * from './signature-recipient-input';
|
|
52
60
|
export * from './sort-input';
|
|
53
61
|
export * from './storage-breakdown';
|
|
54
62
|
export * from './suggest';
|