@openfilz-sdk/typescript-ee 1.4.4 → 1.5.1

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