@openfilz-sdk/typescript-ee 1.5.0 → 1.5.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -101,6 +101,7 @@ docs/ShareRequest.md
101
101
  docs/ShareResultError.md
102
102
  docs/ShareResultItem.md
103
103
  docs/ShareResultResponse.md
104
+ docs/SignatureArchiveDTO.md
104
105
  docs/SignatureEnvelopeDTO.md
105
106
  docs/SignatureFieldPlacement.md
106
107
  docs/SignatureRecipientDTO.md
@@ -186,6 +187,7 @@ models/share-request.ts
186
187
  models/share-result-error.ts
187
188
  models/share-result-item.ts
188
189
  models/share-result-response.ts
190
+ models/signature-archive-dto.ts
189
191
  models/signature-envelope-dto.ts
190
192
  models/signature-field-placement.ts
191
193
  models/signature-recipient-dto.ts
@@ -1 +1 @@
1
- d05bceb7c52480a5bb12f3093c993a0e89d0f939a11e7ce539e823d5c30fe070
1
+ 311dcc0aa1560fc232e9bfed7bc4a45e7564a8a1ec137be210f701742a0668be
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- ## @openfilz-sdk/typescript-ee@1.5.0
1
+ ## @openfilz-sdk/typescript-ee@1.5.2
2
2
 
3
3
  This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
4
4
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
36
36
  _published:_
37
37
 
38
38
  ```
39
- npm install @openfilz-sdk/typescript-ee@1.5.0 --save
39
+ npm install @openfilz-sdk/typescript-ee@1.5.2 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
@@ -83,6 +83,7 @@ Class | Method | HTTP request | Description
83
83
  *DelegatedBrowseGrantsEndUserApi* | [**disableLinkedWebhook**](docs/DelegatedBrowseGrantsEndUserApi.md#disablelinkedwebhook) | **POST** /api/v1/users/me/delegated/grants/{id}/disable-webhook | Disable the webhook created from this grant
84
84
  *DelegatedBrowseGrantsEndUserApi* | [**listIncoming**](docs/DelegatedBrowseGrantsEndUserApi.md#listincoming) | **GET** /api/v1/users/me/delegated/grants | List grants addressed to me
85
85
  *DelegatedBrowseGrantsEndUserApi* | [**revoke**](docs/DelegatedBrowseGrantsEndUserApi.md#revoke) | **POST** /api/v1/users/me/delegated/grants/{id}/revoke | Revoke an accepted grant
86
+ *DigitalSignatureApi* | [**archive**](docs/DigitalSignatureApi.md#archive) | **GET** /api/v1/signatures/{id}/archive | Get the PDF/A archive + veraPDF compliance for a completed envelope
86
87
  *DigitalSignatureApi* | [**cancel**](docs/DigitalSignatureApi.md#cancel) | **POST** /api/v1/signatures/{id}/cancel | Cancel a non-terminal envelope
87
88
  *DigitalSignatureApi* | [**create**](docs/DigitalSignatureApi.md#create) | **POST** /api/v1/signatures | Create and send a signature envelope
88
89
  *DigitalSignatureApi* | [**get1**](docs/DigitalSignatureApi.md#get1) | **GET** /api/v1/signatures/{id} | Get a single envelope I sent
@@ -221,6 +222,7 @@ Class | Method | HTTP request | Description
221
222
  - [ShareResultError](docs/ShareResultError.md)
222
223
  - [ShareResultItem](docs/ShareResultItem.md)
223
224
  - [ShareResultResponse](docs/ShareResultResponse.md)
225
+ - [SignatureArchiveDTO](docs/SignatureArchiveDTO.md)
224
226
  - [SignatureEnvelopeDTO](docs/SignatureEnvelopeDTO.md)
225
227
  - [SignatureFieldPlacement](docs/SignatureFieldPlacement.md)
226
228
  - [SignatureRecipientDTO](docs/SignatureRecipientDTO.md)
@@ -24,12 +24,52 @@ import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError
24
24
  // @ts-ignore
25
25
  import type { CreateSignatureEnvelopeRequest } from '../models';
26
26
  // @ts-ignore
27
+ import type { SignatureArchiveDTO } from '../models';
28
+ // @ts-ignore
27
29
  import type { SignatureEnvelopeDTO } from '../models';
28
30
  /**
29
31
  * DigitalSignatureApi - axios parameter creator
30
32
  */
31
33
  export const DigitalSignatureApiAxiosParamCreator = function (configuration?: Configuration) {
32
34
  return {
35
+ /**
36
+ *
37
+ * @summary Get the PDF/A archive + veraPDF compliance for a completed envelope
38
+ * @param {string} id
39
+ * @param {*} [options] Override http request option.
40
+ * @throws {RequiredError}
41
+ */
42
+ archive: async (id: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
43
+ // verify required parameter 'id' is not null or undefined
44
+ assertParamExists('archive', 'id', id)
45
+ const localVarPath = `/api/v1/signatures/{id}/archive`
46
+ .replace(`{${"id"}}`, encodeURIComponent(String(id)));
47
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
48
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
49
+ let baseOptions;
50
+ if (configuration) {
51
+ baseOptions = configuration.baseOptions;
52
+ }
53
+
54
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
55
+ const localVarHeaderParameter = {} as any;
56
+ const localVarQueryParameter = {} as any;
57
+
58
+ // authentication keycloak_auth required
59
+ // http bearer authentication required
60
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
61
+
62
+ localVarHeaderParameter['Accept'] = 'application/json';
63
+
64
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
65
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
66
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
67
+
68
+ return {
69
+ url: toPathString(localVarUrlObj),
70
+ options: localVarRequestOptions,
71
+ };
72
+ },
33
73
  /**
34
74
  *
35
75
  * @summary Cancel a non-terminal envelope
@@ -222,6 +262,19 @@ export const DigitalSignatureApiAxiosParamCreator = function (configuration?: Co
222
262
  export const DigitalSignatureApiFp = function(configuration?: Configuration) {
223
263
  const localVarAxiosParamCreator = DigitalSignatureApiAxiosParamCreator(configuration)
224
264
  return {
265
+ /**
266
+ *
267
+ * @summary Get the PDF/A archive + veraPDF compliance for a completed envelope
268
+ * @param {string} id
269
+ * @param {*} [options] Override http request option.
270
+ * @throws {RequiredError}
271
+ */
272
+ async archive(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SignatureArchiveDTO>> {
273
+ const localVarAxiosArgs = await localVarAxiosParamCreator.archive(id, options);
274
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
275
+ const localVarOperationServerBasePath = operationServerMap['DigitalSignatureApi.archive']?.[localVarOperationServerIndex]?.url;
276
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
277
+ },
225
278
  /**
226
279
  *
227
280
  * @summary Cancel a non-terminal envelope
@@ -294,6 +347,16 @@ export const DigitalSignatureApiFp = function(configuration?: Configuration) {
294
347
  export const DigitalSignatureApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
295
348
  const localVarFp = DigitalSignatureApiFp(configuration)
296
349
  return {
350
+ /**
351
+ *
352
+ * @summary Get the PDF/A archive + veraPDF compliance for a completed envelope
353
+ * @param {string} id
354
+ * @param {*} [options] Override http request option.
355
+ * @throws {RequiredError}
356
+ */
357
+ archive(id: string, options?: RawAxiosRequestConfig): AxiosPromise<SignatureArchiveDTO> {
358
+ return localVarFp.archive(id, options).then((request) => request(axios, basePath));
359
+ },
297
360
  /**
298
361
  *
299
362
  * @summary Cancel a non-terminal envelope
@@ -349,6 +412,17 @@ export const DigitalSignatureApiFactory = function (configuration?: Configuratio
349
412
  * DigitalSignatureApi - object-oriented interface
350
413
  */
351
414
  export class DigitalSignatureApi extends BaseAPI {
415
+ /**
416
+ *
417
+ * @summary Get the PDF/A archive + veraPDF compliance for a completed envelope
418
+ * @param {string} id
419
+ * @param {*} [options] Override http request option.
420
+ * @throws {RequiredError}
421
+ */
422
+ public archive(id: string, options?: RawAxiosRequestConfig) {
423
+ return DigitalSignatureApiFp(this.configuration).archive(id, options).then((request) => request(this.axios, this.basePath));
424
+ }
425
+
352
426
  /**
353
427
  *
354
428
  * @summary Cancel a non-terminal envelope
@@ -13,11 +13,20 @@ import type { Configuration } from '../configuration';
13
13
  import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
14
14
  import { type RequestArgs, BaseAPI } from '../base';
15
15
  import type { CreateSignatureEnvelopeRequest } from '../models';
16
+ import type { SignatureArchiveDTO } from '../models';
16
17
  import type { SignatureEnvelopeDTO } from '../models';
17
18
  /**
18
19
  * DigitalSignatureApi - axios parameter creator
19
20
  */
20
21
  export declare const DigitalSignatureApiAxiosParamCreator: (configuration?: Configuration) => {
22
+ /**
23
+ *
24
+ * @summary Get the PDF/A archive + veraPDF compliance for a completed envelope
25
+ * @param {string} id
26
+ * @param {*} [options] Override http request option.
27
+ * @throws {RequiredError}
28
+ */
29
+ archive: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
21
30
  /**
22
31
  *
23
32
  * @summary Cancel a non-terminal envelope
@@ -61,6 +70,14 @@ export declare const DigitalSignatureApiAxiosParamCreator: (configuration?: Conf
61
70
  * DigitalSignatureApi - functional programming interface
62
71
  */
63
72
  export declare const DigitalSignatureApiFp: (configuration?: Configuration) => {
73
+ /**
74
+ *
75
+ * @summary Get the PDF/A archive + veraPDF compliance for a completed envelope
76
+ * @param {string} id
77
+ * @param {*} [options] Override http request option.
78
+ * @throws {RequiredError}
79
+ */
80
+ archive(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SignatureArchiveDTO>>;
64
81
  /**
65
82
  *
66
83
  * @summary Cancel a non-terminal envelope
@@ -104,6 +121,14 @@ export declare const DigitalSignatureApiFp: (configuration?: Configuration) => {
104
121
  * DigitalSignatureApi - factory interface
105
122
  */
106
123
  export declare const DigitalSignatureApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
124
+ /**
125
+ *
126
+ * @summary Get the PDF/A archive + veraPDF compliance for a completed envelope
127
+ * @param {string} id
128
+ * @param {*} [options] Override http request option.
129
+ * @throws {RequiredError}
130
+ */
131
+ archive(id: string, options?: RawAxiosRequestConfig): AxiosPromise<SignatureArchiveDTO>;
107
132
  /**
108
133
  *
109
134
  * @summary Cancel a non-terminal envelope
@@ -147,6 +172,14 @@ export declare const DigitalSignatureApiFactory: (configuration?: Configuration,
147
172
  * DigitalSignatureApi - object-oriented interface
148
173
  */
149
174
  export declare class DigitalSignatureApi extends BaseAPI {
175
+ /**
176
+ *
177
+ * @summary Get the PDF/A archive + veraPDF compliance for a completed envelope
178
+ * @param {string} id
179
+ * @param {*} [options] Override http request option.
180
+ * @throws {RequiredError}
181
+ */
182
+ archive(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SignatureArchiveDTO, any, {}>>;
150
183
  /**
151
184
  *
152
185
  * @summary Cancel a non-terminal envelope
@@ -34,6 +34,39 @@ const base_1 = require("../base");
34
34
  */
35
35
  const DigitalSignatureApiAxiosParamCreator = function (configuration) {
36
36
  return {
37
+ /**
38
+ *
39
+ * @summary Get the PDF/A archive + veraPDF compliance for a completed envelope
40
+ * @param {string} id
41
+ * @param {*} [options] Override http request option.
42
+ * @throws {RequiredError}
43
+ */
44
+ archive: (id_1, ...args_1) => __awaiter(this, [id_1, ...args_1], void 0, function* (id, options = {}) {
45
+ // verify required parameter 'id' is not null or undefined
46
+ (0, common_1.assertParamExists)('archive', 'id', id);
47
+ const localVarPath = `/api/v1/signatures/{id}/archive`
48
+ .replace(`{${"id"}}`, encodeURIComponent(String(id)));
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: 'GET' }, 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
+ localVarHeaderParameter['Accept'] = 'application/json';
62
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
63
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
64
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
65
+ return {
66
+ url: (0, common_1.toPathString)(localVarUrlObj),
67
+ options: localVarRequestOptions,
68
+ };
69
+ }),
37
70
  /**
38
71
  *
39
72
  * @summary Cancel a non-terminal envelope
@@ -201,6 +234,22 @@ exports.DigitalSignatureApiAxiosParamCreator = DigitalSignatureApiAxiosParamCrea
201
234
  const DigitalSignatureApiFp = function (configuration) {
202
235
  const localVarAxiosParamCreator = (0, exports.DigitalSignatureApiAxiosParamCreator)(configuration);
203
236
  return {
237
+ /**
238
+ *
239
+ * @summary Get the PDF/A archive + veraPDF compliance for a completed envelope
240
+ * @param {string} id
241
+ * @param {*} [options] Override http request option.
242
+ * @throws {RequiredError}
243
+ */
244
+ archive(id, options) {
245
+ return __awaiter(this, void 0, void 0, function* () {
246
+ var _a, _b, _c;
247
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.archive(id, options);
248
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
249
+ const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['DigitalSignatureApi.archive']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
250
+ return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
251
+ });
252
+ },
204
253
  /**
205
254
  *
206
255
  * @summary Cancel a non-terminal envelope
@@ -288,6 +337,16 @@ exports.DigitalSignatureApiFp = DigitalSignatureApiFp;
288
337
  const DigitalSignatureApiFactory = function (configuration, basePath, axios) {
289
338
  const localVarFp = (0, exports.DigitalSignatureApiFp)(configuration);
290
339
  return {
340
+ /**
341
+ *
342
+ * @summary Get the PDF/A archive + veraPDF compliance for a completed envelope
343
+ * @param {string} id
344
+ * @param {*} [options] Override http request option.
345
+ * @throws {RequiredError}
346
+ */
347
+ archive(id, options) {
348
+ return localVarFp.archive(id, options).then((request) => request(axios, basePath));
349
+ },
291
350
  /**
292
351
  *
293
352
  * @summary Cancel a non-terminal envelope
@@ -343,6 +402,16 @@ exports.DigitalSignatureApiFactory = DigitalSignatureApiFactory;
343
402
  * DigitalSignatureApi - object-oriented interface
344
403
  */
345
404
  class DigitalSignatureApi extends base_1.BaseAPI {
405
+ /**
406
+ *
407
+ * @summary Get the PDF/A archive + veraPDF compliance for a completed envelope
408
+ * @param {string} id
409
+ * @param {*} [options] Override http request option.
410
+ * @throws {RequiredError}
411
+ */
412
+ archive(id, options) {
413
+ return (0, exports.DigitalSignatureApiFp)(this.configuration).archive(id, options).then((request) => request(this.axios, this.basePath));
414
+ }
346
415
  /**
347
416
  *
348
417
  * @summary Cancel a non-terminal envelope
@@ -13,11 +13,20 @@ import type { Configuration } from '../configuration';
13
13
  import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
14
14
  import { type RequestArgs, BaseAPI } from '../base';
15
15
  import type { CreateSignatureEnvelopeRequest } from '../models';
16
+ import type { SignatureArchiveDTO } from '../models';
16
17
  import type { SignatureEnvelopeDTO } from '../models';
17
18
  /**
18
19
  * DigitalSignatureApi - axios parameter creator
19
20
  */
20
21
  export declare const DigitalSignatureApiAxiosParamCreator: (configuration?: Configuration) => {
22
+ /**
23
+ *
24
+ * @summary Get the PDF/A archive + veraPDF compliance for a completed envelope
25
+ * @param {string} id
26
+ * @param {*} [options] Override http request option.
27
+ * @throws {RequiredError}
28
+ */
29
+ archive: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
21
30
  /**
22
31
  *
23
32
  * @summary Cancel a non-terminal envelope
@@ -61,6 +70,14 @@ export declare const DigitalSignatureApiAxiosParamCreator: (configuration?: Conf
61
70
  * DigitalSignatureApi - functional programming interface
62
71
  */
63
72
  export declare const DigitalSignatureApiFp: (configuration?: Configuration) => {
73
+ /**
74
+ *
75
+ * @summary Get the PDF/A archive + veraPDF compliance for a completed envelope
76
+ * @param {string} id
77
+ * @param {*} [options] Override http request option.
78
+ * @throws {RequiredError}
79
+ */
80
+ archive(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SignatureArchiveDTO>>;
64
81
  /**
65
82
  *
66
83
  * @summary Cancel a non-terminal envelope
@@ -104,6 +121,14 @@ export declare const DigitalSignatureApiFp: (configuration?: Configuration) => {
104
121
  * DigitalSignatureApi - factory interface
105
122
  */
106
123
  export declare const DigitalSignatureApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
124
+ /**
125
+ *
126
+ * @summary Get the PDF/A archive + veraPDF compliance for a completed envelope
127
+ * @param {string} id
128
+ * @param {*} [options] Override http request option.
129
+ * @throws {RequiredError}
130
+ */
131
+ archive(id: string, options?: RawAxiosRequestConfig): AxiosPromise<SignatureArchiveDTO>;
107
132
  /**
108
133
  *
109
134
  * @summary Cancel a non-terminal envelope
@@ -147,6 +172,14 @@ export declare const DigitalSignatureApiFactory: (configuration?: Configuration,
147
172
  * DigitalSignatureApi - object-oriented interface
148
173
  */
149
174
  export declare class DigitalSignatureApi extends BaseAPI {
175
+ /**
176
+ *
177
+ * @summary Get the PDF/A archive + veraPDF compliance for a completed envelope
178
+ * @param {string} id
179
+ * @param {*} [options] Override http request option.
180
+ * @throws {RequiredError}
181
+ */
182
+ archive(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SignatureArchiveDTO, any, {}>>;
150
183
  /**
151
184
  *
152
185
  * @summary Cancel a non-terminal envelope
@@ -31,6 +31,39 @@ import { BASE_PATH, BaseAPI, operationServerMap } from '../base';
31
31
  */
32
32
  export const DigitalSignatureApiAxiosParamCreator = function (configuration) {
33
33
  return {
34
+ /**
35
+ *
36
+ * @summary Get the PDF/A archive + veraPDF compliance for a completed envelope
37
+ * @param {string} id
38
+ * @param {*} [options] Override http request option.
39
+ * @throws {RequiredError}
40
+ */
41
+ archive: (id_1, ...args_1) => __awaiter(this, [id_1, ...args_1], void 0, function* (id, options = {}) {
42
+ // verify required parameter 'id' is not null or undefined
43
+ assertParamExists('archive', 'id', id);
44
+ const localVarPath = `/api/v1/signatures/{id}/archive`
45
+ .replace(`{${"id"}}`, encodeURIComponent(String(id)));
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: 'GET' }, baseOptions), options);
53
+ const localVarHeaderParameter = {};
54
+ const localVarQueryParameter = {};
55
+ // authentication keycloak_auth required
56
+ // http bearer authentication required
57
+ yield setBearerAuthToObject(localVarHeaderParameter, configuration);
58
+ localVarHeaderParameter['Accept'] = 'application/json';
59
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
60
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
61
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
62
+ return {
63
+ url: toPathString(localVarUrlObj),
64
+ options: localVarRequestOptions,
65
+ };
66
+ }),
34
67
  /**
35
68
  *
36
69
  * @summary Cancel a non-terminal envelope
@@ -197,6 +230,22 @@ export const DigitalSignatureApiAxiosParamCreator = function (configuration) {
197
230
  export const DigitalSignatureApiFp = function (configuration) {
198
231
  const localVarAxiosParamCreator = DigitalSignatureApiAxiosParamCreator(configuration);
199
232
  return {
233
+ /**
234
+ *
235
+ * @summary Get the PDF/A archive + veraPDF compliance for a completed envelope
236
+ * @param {string} id
237
+ * @param {*} [options] Override http request option.
238
+ * @throws {RequiredError}
239
+ */
240
+ archive(id, options) {
241
+ return __awaiter(this, void 0, void 0, function* () {
242
+ var _a, _b, _c;
243
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.archive(id, options);
244
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
245
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['DigitalSignatureApi.archive']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
246
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
247
+ });
248
+ },
200
249
  /**
201
250
  *
202
251
  * @summary Cancel a non-terminal envelope
@@ -283,6 +332,16 @@ export const DigitalSignatureApiFp = function (configuration) {
283
332
  export const DigitalSignatureApiFactory = function (configuration, basePath, axios) {
284
333
  const localVarFp = DigitalSignatureApiFp(configuration);
285
334
  return {
335
+ /**
336
+ *
337
+ * @summary Get the PDF/A archive + veraPDF compliance for a completed envelope
338
+ * @param {string} id
339
+ * @param {*} [options] Override http request option.
340
+ * @throws {RequiredError}
341
+ */
342
+ archive(id, options) {
343
+ return localVarFp.archive(id, options).then((request) => request(axios, basePath));
344
+ },
286
345
  /**
287
346
  *
288
347
  * @summary Cancel a non-terminal envelope
@@ -337,6 +396,16 @@ export const DigitalSignatureApiFactory = function (configuration, basePath, axi
337
396
  * DigitalSignatureApi - object-oriented interface
338
397
  */
339
398
  export class DigitalSignatureApi extends BaseAPI {
399
+ /**
400
+ *
401
+ * @summary Get the PDF/A archive + veraPDF compliance for a completed envelope
402
+ * @param {string} id
403
+ * @param {*} [options] Override http request option.
404
+ * @throws {RequiredError}
405
+ */
406
+ archive(id, options) {
407
+ return DigitalSignatureApiFp(this.configuration).archive(id, options).then((request) => request(this.axios, this.basePath));
408
+ }
340
409
  /**
341
410
  *
342
411
  * @summary Cancel a non-terminal envelope
@@ -53,6 +53,7 @@ export * from './share-request';
53
53
  export * from './share-result-error';
54
54
  export * from './share-result-item';
55
55
  export * from './share-result-response';
56
+ export * from './signature-archive-dto';
56
57
  export * from './signature-envelope-dto';
57
58
  export * from './signature-field-placement';
58
59
  export * from './signature-recipient-dto';
@@ -53,6 +53,7 @@ export * from './share-request';
53
53
  export * from './share-result-error';
54
54
  export * from './share-result-item';
55
55
  export * from './share-result-response';
56
+ export * from './signature-archive-dto';
56
57
  export * from './signature-envelope-dto';
57
58
  export * from './signature-field-placement';
58
59
  export * from './signature-recipient-dto';
@@ -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
+ export interface SignatureArchiveDTO {
13
+ 'pdfaDocId'?: string;
14
+ 'flavor'?: string;
15
+ 'compliant'?: boolean;
16
+ 'status'?: string;
17
+ 'report'?: string;
18
+ 'createdAt'?: string;
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 {};
@@ -53,6 +53,7 @@ export * from './share-request';
53
53
  export * from './share-result-error';
54
54
  export * from './share-result-item';
55
55
  export * from './share-result-response';
56
+ export * from './signature-archive-dto';
56
57
  export * from './signature-envelope-dto';
57
58
  export * from './signature-field-placement';
58
59
  export * from './signature-recipient-dto';
@@ -69,6 +69,7 @@ __exportStar(require("./share-request"), exports);
69
69
  __exportStar(require("./share-result-error"), exports);
70
70
  __exportStar(require("./share-result-item"), exports);
71
71
  __exportStar(require("./share-result-response"), exports);
72
+ __exportStar(require("./signature-archive-dto"), exports);
72
73
  __exportStar(require("./signature-envelope-dto"), exports);
73
74
  __exportStar(require("./signature-field-placement"), exports);
74
75
  __exportStar(require("./signature-recipient-dto"), exports);
@@ -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
+ export interface SignatureArchiveDTO {
13
+ 'pdfaDocId'?: string;
14
+ 'flavor'?: string;
15
+ 'compliant'?: boolean;
16
+ 'status'?: string;
17
+ 'report'?: string;
18
+ 'createdAt'?: string;
19
+ }
@@ -0,0 +1,15 @@
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
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -4,12 +4,63 @@ All URIs are relative to *http://localhost:8081*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
7
+ |[**archive**](#archive) | **GET** /api/v1/signatures/{id}/archive | Get the PDF/A archive + veraPDF compliance for a completed envelope|
7
8
  |[**cancel**](#cancel) | **POST** /api/v1/signatures/{id}/cancel | Cancel a non-terminal envelope|
8
9
  |[**create**](#create) | **POST** /api/v1/signatures | Create and send a signature envelope|
9
10
  |[**get1**](#get1) | **GET** /api/v1/signatures/{id} | Get a single envelope I sent|
10
11
  |[**listSent**](#listsent) | **GET** /api/v1/signatures | List envelopes I sent for signature|
11
12
  |[**listToSign**](#listtosign) | **GET** /api/v1/signatures/to-sign | List documents waiting for my signature|
12
13
 
14
+ # **archive**
15
+ > SignatureArchiveDTO archive()
16
+
17
+
18
+ ### Example
19
+
20
+ ```typescript
21
+ import {
22
+ DigitalSignatureApi,
23
+ Configuration
24
+ } from '@openfilz-sdk/typescript-ee';
25
+
26
+ const configuration = new Configuration();
27
+ const apiInstance = new DigitalSignatureApi(configuration);
28
+
29
+ let id: string; // (default to undefined)
30
+
31
+ const { status, data } = await apiInstance.archive(
32
+ id
33
+ );
34
+ ```
35
+
36
+ ### Parameters
37
+
38
+ |Name | Type | Description | Notes|
39
+ |------------- | ------------- | ------------- | -------------|
40
+ | **id** | [**string**] | | defaults to undefined|
41
+
42
+
43
+ ### Return type
44
+
45
+ **SignatureArchiveDTO**
46
+
47
+ ### Authorization
48
+
49
+ [keycloak_auth](../README.md#keycloak_auth)
50
+
51
+ ### HTTP request headers
52
+
53
+ - **Content-Type**: Not defined
54
+ - **Accept**: application/json
55
+
56
+
57
+ ### HTTP response details
58
+ | Status code | Description | Response headers |
59
+ |-------------|-------------|------------------|
60
+ |**200** | OK | - |
61
+
62
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
63
+
13
64
  # **cancel**
14
65
  > SignatureEnvelopeDTO cancel()
15
66
 
@@ -0,0 +1,30 @@
1
+ # SignatureArchiveDTO
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **pdfaDocId** | **string** | | [optional] [default to undefined]
9
+ **flavor** | **string** | | [optional] [default to undefined]
10
+ **compliant** | **boolean** | | [optional] [default to undefined]
11
+ **status** | **string** | | [optional] [default to undefined]
12
+ **report** | **string** | | [optional] [default to undefined]
13
+ **createdAt** | **string** | | [optional] [default to undefined]
14
+
15
+ ## Example
16
+
17
+ ```typescript
18
+ import { SignatureArchiveDTO } from '@openfilz-sdk/typescript-ee';
19
+
20
+ const instance: SignatureArchiveDTO = {
21
+ pdfaDocId,
22
+ flavor,
23
+ compliant,
24
+ status,
25
+ report,
26
+ createdAt,
27
+ };
28
+ ```
29
+
30
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
package/models/index.ts CHANGED
@@ -53,6 +53,7 @@ export * from './share-request';
53
53
  export * from './share-result-error';
54
54
  export * from './share-result-item';
55
55
  export * from './share-result-response';
56
+ export * from './signature-archive-dto';
56
57
  export * from './signature-envelope-dto';
57
58
  export * from './signature-field-placement';
58
59
  export * from './signature-recipient-dto';
@@ -0,0 +1,25 @@
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
+
17
+ export interface SignatureArchiveDTO {
18
+ 'pdfaDocId'?: string;
19
+ 'flavor'?: string;
20
+ 'compliant'?: boolean;
21
+ 'status'?: string;
22
+ 'report'?: string;
23
+ 'createdAt'?: string;
24
+ }
25
+
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openfilz-sdk/typescript-ee",
3
- "version": "1.5.0",
3
+ "version": "1.5.2",
4
4
  "description": "OpenAPI client for @openfilz-sdk/typescript-ee",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {