@openfilz-sdk/typescript-ee 1.8.9 → 1.8.11
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 +2 -0
- package/.openapi-generator/openfilz-api-generate-typescript-sdk.sha256 +1 -1
- package/README.md +4 -2
- package/api/esign-api.ts +67 -0
- package/dist/api/esign-api.d.ts +29 -0
- package/dist/api/esign-api.js +62 -0
- package/dist/esm/api/esign-api.d.ts +29 -0
- package/dist/esm/api/esign-api.js +62 -0
- package/dist/esm/models/cloud-signature-subscription.d.ts +22 -0
- package/dist/esm/models/cloud-signature-subscription.js +14 -0
- package/dist/esm/models/index.d.ts +1 -0
- package/dist/esm/models/index.js +1 -0
- package/dist/esm/models/settings.d.ts +1 -0
- package/dist/models/cloud-signature-subscription.d.ts +22 -0
- package/dist/models/cloud-signature-subscription.js +15 -0
- package/dist/models/index.d.ts +1 -0
- package/dist/models/index.js +1 -0
- package/dist/models/settings.d.ts +1 -0
- package/docs/CloudSignatureSubscription.md +36 -0
- package/docs/ESignApi.md +44 -0
- package/docs/Settings.md +2 -0
- package/models/cloud-signature-subscription.ts +28 -0
- package/models/index.ts +1 -0
- package/models/settings.ts +1 -0
- package/package.json +1 -1
package/.openapi-generator/FILES
CHANGED
|
@@ -50,6 +50,7 @@ docs/BulkRow.md
|
|
|
50
50
|
docs/BulkRowResult.md
|
|
51
51
|
docs/BulkSendRequest.md
|
|
52
52
|
docs/BulkSendResponse.md
|
|
53
|
+
docs/CloudSignatureSubscription.md
|
|
53
54
|
docs/CollaborationAuditControllerApi.md
|
|
54
55
|
docs/CollaborationControllerApi.md
|
|
55
56
|
docs/CommentDTO.md
|
|
@@ -183,6 +184,7 @@ models/bulk-row-result.ts
|
|
|
183
184
|
models/bulk-row.ts
|
|
184
185
|
models/bulk-send-request.ts
|
|
185
186
|
models/bulk-send-response.ts
|
|
187
|
+
models/cloud-signature-subscription.ts
|
|
186
188
|
models/comment-dto.ts
|
|
187
189
|
models/consume-delegated-grant-request.ts
|
|
188
190
|
models/copy-audit.ts
|
|
@@ -1 +1 @@
|
|
|
1
|
-
|
|
1
|
+
f79cae24dc8a30429dc9c45bec64e84a37098f9f44e5eaa9eec829d1d4f189ea
|
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @openfilz-sdk/typescript-ee@1.8.
|
|
1
|
+
## @openfilz-sdk/typescript-ee@1.8.11
|
|
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.8.
|
|
39
|
+
npm install @openfilz-sdk/typescript-ee@1.8.11 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
|
@@ -112,6 +112,7 @@ Class | Method | HTTP request | Description
|
|
|
112
112
|
*DocumentVersionControllerApi* | [**listVersions**](docs/DocumentVersionControllerApi.md#listversions) | **GET** /api/v1/documents/{documentId}/versions | List document versions
|
|
113
113
|
*DocumentVersionControllerApi* | [**restoreVersion**](docs/DocumentVersionControllerApi.md#restoreversion) | **POST** /api/v1/documents/{documentId}/versions/{versionId}/restore | Restore a previous document version
|
|
114
114
|
*ESignApi* | [**cancel**](docs/ESignApi.md#cancel) | **POST** /api/v1/signatures/{id}/cancel | Cancel a non-terminal envelope
|
|
115
|
+
*ESignApi* | [**cloudSubscription**](docs/ESignApi.md#cloudsubscription) | **GET** /api/v1/signatures/cloud-subscription | Cloud Signing subscription and month-to-date usage (openfilz-cloud seal provider only)
|
|
115
116
|
*ESignApi* | [**create**](docs/ESignApi.md#create) | **POST** /api/v1/signatures | Create an envelope (sent immediately unless send=false)
|
|
116
117
|
*ESignApi* | [**events**](docs/ESignApi.md#events) | **GET** /api/v1/signatures/{id}/events | Audit trail of one of my envelopes
|
|
117
118
|
*ESignApi* | [**get2**](docs/ESignApi.md#get2) | **GET** /api/v1/signatures/{id} | Get one of my envelopes (recipients + fields)
|
|
@@ -208,6 +209,7 @@ Class | Method | HTTP request | Description
|
|
|
208
209
|
- [BulkRowResult](docs/BulkRowResult.md)
|
|
209
210
|
- [BulkSendRequest](docs/BulkSendRequest.md)
|
|
210
211
|
- [BulkSendResponse](docs/BulkSendResponse.md)
|
|
212
|
+
- [CloudSignatureSubscription](docs/CloudSignatureSubscription.md)
|
|
211
213
|
- [CommentDTO](docs/CommentDTO.md)
|
|
212
214
|
- [ConsumeDelegatedGrantRequest](docs/ConsumeDelegatedGrantRequest.md)
|
|
213
215
|
- [CopyAudit](docs/CopyAudit.md)
|
package/api/esign-api.ts
CHANGED
|
@@ -22,6 +22,8 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj
|
|
|
22
22
|
// @ts-ignore
|
|
23
23
|
import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base';
|
|
24
24
|
// @ts-ignore
|
|
25
|
+
import type { CloudSignatureSubscription } from '../models';
|
|
26
|
+
// @ts-ignore
|
|
25
27
|
import type { CreateSignatureEnvelopeRequest } from '../models';
|
|
26
28
|
// @ts-ignore
|
|
27
29
|
import type { SignatureEnvelopeDTO } from '../models';
|
|
@@ -70,6 +72,40 @@ export const ESignApiAxiosParamCreator = function (configuration?: Configuration
|
|
|
70
72
|
options: localVarRequestOptions,
|
|
71
73
|
};
|
|
72
74
|
},
|
|
75
|
+
/**
|
|
76
|
+
*
|
|
77
|
+
* @summary Cloud Signing subscription and month-to-date usage (openfilz-cloud seal provider only)
|
|
78
|
+
* @param {*} [options] Override http request option.
|
|
79
|
+
* @throws {RequiredError}
|
|
80
|
+
*/
|
|
81
|
+
cloudSubscription: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
82
|
+
const localVarPath = `/api/v1/signatures/cloud-subscription`;
|
|
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
|
+
|
|
90
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
91
|
+
const localVarHeaderParameter = {} as any;
|
|
92
|
+
const localVarQueryParameter = {} as any;
|
|
93
|
+
|
|
94
|
+
// authentication keycloak_auth required
|
|
95
|
+
// http bearer authentication required
|
|
96
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
97
|
+
|
|
98
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
99
|
+
|
|
100
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
101
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
102
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
103
|
+
|
|
104
|
+
return {
|
|
105
|
+
url: toPathString(localVarUrlObj),
|
|
106
|
+
options: localVarRequestOptions,
|
|
107
|
+
};
|
|
108
|
+
},
|
|
73
109
|
/**
|
|
74
110
|
*
|
|
75
111
|
* @summary Create an envelope (sent immediately unless send=false)
|
|
@@ -398,6 +434,18 @@ export const ESignApiFp = function(configuration?: Configuration) {
|
|
|
398
434
|
const localVarOperationServerBasePath = operationServerMap['ESignApi.cancel']?.[localVarOperationServerIndex]?.url;
|
|
399
435
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
400
436
|
},
|
|
437
|
+
/**
|
|
438
|
+
*
|
|
439
|
+
* @summary Cloud Signing subscription and month-to-date usage (openfilz-cloud seal provider only)
|
|
440
|
+
* @param {*} [options] Override http request option.
|
|
441
|
+
* @throws {RequiredError}
|
|
442
|
+
*/
|
|
443
|
+
async cloudSubscription(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CloudSignatureSubscription>> {
|
|
444
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.cloudSubscription(options);
|
|
445
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
446
|
+
const localVarOperationServerBasePath = operationServerMap['ESignApi.cloudSubscription']?.[localVarOperationServerIndex]?.url;
|
|
447
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
448
|
+
},
|
|
401
449
|
/**
|
|
402
450
|
*
|
|
403
451
|
* @summary Create an envelope (sent immediately unless send=false)
|
|
@@ -521,6 +569,15 @@ export const ESignApiFactory = function (configuration?: Configuration, basePath
|
|
|
521
569
|
cancel(id: string, options?: RawAxiosRequestConfig): AxiosPromise<SignatureEnvelopeDTO> {
|
|
522
570
|
return localVarFp.cancel(id, options).then((request) => request(axios, basePath));
|
|
523
571
|
},
|
|
572
|
+
/**
|
|
573
|
+
*
|
|
574
|
+
* @summary Cloud Signing subscription and month-to-date usage (openfilz-cloud seal provider only)
|
|
575
|
+
* @param {*} [options] Override http request option.
|
|
576
|
+
* @throws {RequiredError}
|
|
577
|
+
*/
|
|
578
|
+
cloudSubscription(options?: RawAxiosRequestConfig): AxiosPromise<CloudSignatureSubscription> {
|
|
579
|
+
return localVarFp.cloudSubscription(options).then((request) => request(axios, basePath));
|
|
580
|
+
},
|
|
524
581
|
/**
|
|
525
582
|
*
|
|
526
583
|
* @summary Create an envelope (sent immediately unless send=false)
|
|
@@ -619,6 +676,16 @@ export class ESignApi extends BaseAPI {
|
|
|
619
676
|
return ESignApiFp(this.configuration).cancel(id, options).then((request) => request(this.axios, this.basePath));
|
|
620
677
|
}
|
|
621
678
|
|
|
679
|
+
/**
|
|
680
|
+
*
|
|
681
|
+
* @summary Cloud Signing subscription and month-to-date usage (openfilz-cloud seal provider only)
|
|
682
|
+
* @param {*} [options] Override http request option.
|
|
683
|
+
* @throws {RequiredError}
|
|
684
|
+
*/
|
|
685
|
+
public cloudSubscription(options?: RawAxiosRequestConfig) {
|
|
686
|
+
return ESignApiFp(this.configuration).cloudSubscription(options).then((request) => request(this.axios, this.basePath));
|
|
687
|
+
}
|
|
688
|
+
|
|
622
689
|
/**
|
|
623
690
|
*
|
|
624
691
|
* @summary Create an envelope (sent immediately unless send=false)
|
package/dist/api/esign-api.d.ts
CHANGED
|
@@ -12,6 +12,7 @@
|
|
|
12
12
|
import type { Configuration } from '../configuration';
|
|
13
13
|
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
14
14
|
import { type RequestArgs, BaseAPI } from '../base';
|
|
15
|
+
import type { CloudSignatureSubscription } from '../models';
|
|
15
16
|
import type { CreateSignatureEnvelopeRequest } from '../models';
|
|
16
17
|
import type { SignatureEnvelopeDTO } from '../models';
|
|
17
18
|
import type { SignatureEventDTO } from '../models';
|
|
@@ -27,6 +28,13 @@ export declare const ESignApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
27
28
|
* @throws {RequiredError}
|
|
28
29
|
*/
|
|
29
30
|
cancel: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
31
|
+
/**
|
|
32
|
+
*
|
|
33
|
+
* @summary Cloud Signing subscription and month-to-date usage (openfilz-cloud seal provider only)
|
|
34
|
+
* @param {*} [options] Override http request option.
|
|
35
|
+
* @throws {RequiredError}
|
|
36
|
+
*/
|
|
37
|
+
cloudSubscription: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
30
38
|
/**
|
|
31
39
|
*
|
|
32
40
|
* @summary Create an envelope (sent immediately unless send=false)
|
|
@@ -104,6 +112,13 @@ export declare const ESignApiFp: (configuration?: Configuration) => {
|
|
|
104
112
|
* @throws {RequiredError}
|
|
105
113
|
*/
|
|
106
114
|
cancel(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SignatureEnvelopeDTO>>;
|
|
115
|
+
/**
|
|
116
|
+
*
|
|
117
|
+
* @summary Cloud Signing subscription and month-to-date usage (openfilz-cloud seal provider only)
|
|
118
|
+
* @param {*} [options] Override http request option.
|
|
119
|
+
* @throws {RequiredError}
|
|
120
|
+
*/
|
|
121
|
+
cloudSubscription(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CloudSignatureSubscription>>;
|
|
107
122
|
/**
|
|
108
123
|
*
|
|
109
124
|
* @summary Create an envelope (sent immediately unless send=false)
|
|
@@ -181,6 +196,13 @@ export declare const ESignApiFactory: (configuration?: Configuration, basePath?:
|
|
|
181
196
|
* @throws {RequiredError}
|
|
182
197
|
*/
|
|
183
198
|
cancel(id: string, options?: RawAxiosRequestConfig): AxiosPromise<SignatureEnvelopeDTO>;
|
|
199
|
+
/**
|
|
200
|
+
*
|
|
201
|
+
* @summary Cloud Signing subscription and month-to-date usage (openfilz-cloud seal provider only)
|
|
202
|
+
* @param {*} [options] Override http request option.
|
|
203
|
+
* @throws {RequiredError}
|
|
204
|
+
*/
|
|
205
|
+
cloudSubscription(options?: RawAxiosRequestConfig): AxiosPromise<CloudSignatureSubscription>;
|
|
184
206
|
/**
|
|
185
207
|
*
|
|
186
208
|
* @summary Create an envelope (sent immediately unless send=false)
|
|
@@ -258,6 +280,13 @@ export declare class ESignApi extends BaseAPI {
|
|
|
258
280
|
* @throws {RequiredError}
|
|
259
281
|
*/
|
|
260
282
|
cancel(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SignatureEnvelopeDTO, any, {}, any>>;
|
|
283
|
+
/**
|
|
284
|
+
*
|
|
285
|
+
* @summary Cloud Signing subscription and month-to-date usage (openfilz-cloud seal provider only)
|
|
286
|
+
* @param {*} [options] Override http request option.
|
|
287
|
+
* @throws {RequiredError}
|
|
288
|
+
*/
|
|
289
|
+
cloudSubscription(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CloudSignatureSubscription, any, {}, any>>;
|
|
261
290
|
/**
|
|
262
291
|
*
|
|
263
292
|
* @summary Create an envelope (sent immediately unless send=false)
|
package/dist/api/esign-api.js
CHANGED
|
@@ -67,6 +67,35 @@ const ESignApiAxiosParamCreator = function (configuration) {
|
|
|
67
67
|
options: localVarRequestOptions,
|
|
68
68
|
};
|
|
69
69
|
}),
|
|
70
|
+
/**
|
|
71
|
+
*
|
|
72
|
+
* @summary Cloud Signing subscription and month-to-date usage (openfilz-cloud seal provider only)
|
|
73
|
+
* @param {*} [options] Override http request option.
|
|
74
|
+
* @throws {RequiredError}
|
|
75
|
+
*/
|
|
76
|
+
cloudSubscription: (...args_1) => __awaiter(this, [...args_1], void 0, function* (options = {}) {
|
|
77
|
+
const localVarPath = `/api/v1/signatures/cloud-subscription`;
|
|
78
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
79
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
80
|
+
let baseOptions;
|
|
81
|
+
if (configuration) {
|
|
82
|
+
baseOptions = configuration.baseOptions;
|
|
83
|
+
}
|
|
84
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
85
|
+
const localVarHeaderParameter = {};
|
|
86
|
+
const localVarQueryParameter = {};
|
|
87
|
+
// authentication keycloak_auth required
|
|
88
|
+
// http bearer authentication required
|
|
89
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
90
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
91
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
92
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
93
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
94
|
+
return {
|
|
95
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
96
|
+
options: localVarRequestOptions,
|
|
97
|
+
};
|
|
98
|
+
}),
|
|
70
99
|
/**
|
|
71
100
|
*
|
|
72
101
|
* @summary Create an envelope (sent immediately unless send=false)
|
|
@@ -357,6 +386,21 @@ const ESignApiFp = function (configuration) {
|
|
|
357
386
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
358
387
|
});
|
|
359
388
|
},
|
|
389
|
+
/**
|
|
390
|
+
*
|
|
391
|
+
* @summary Cloud Signing subscription and month-to-date usage (openfilz-cloud seal provider only)
|
|
392
|
+
* @param {*} [options] Override http request option.
|
|
393
|
+
* @throws {RequiredError}
|
|
394
|
+
*/
|
|
395
|
+
cloudSubscription(options) {
|
|
396
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
397
|
+
var _a, _b, _c;
|
|
398
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.cloudSubscription(options);
|
|
399
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
400
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ESignApi.cloudSubscription']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
401
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
402
|
+
});
|
|
403
|
+
},
|
|
360
404
|
/**
|
|
361
405
|
*
|
|
362
406
|
* @summary Create an envelope (sent immediately unless send=false)
|
|
@@ -504,6 +548,15 @@ const ESignApiFactory = function (configuration, basePath, axios) {
|
|
|
504
548
|
cancel(id, options) {
|
|
505
549
|
return localVarFp.cancel(id, options).then((request) => request(axios, basePath));
|
|
506
550
|
},
|
|
551
|
+
/**
|
|
552
|
+
*
|
|
553
|
+
* @summary Cloud Signing subscription and month-to-date usage (openfilz-cloud seal provider only)
|
|
554
|
+
* @param {*} [options] Override http request option.
|
|
555
|
+
* @throws {RequiredError}
|
|
556
|
+
*/
|
|
557
|
+
cloudSubscription(options) {
|
|
558
|
+
return localVarFp.cloudSubscription(options).then((request) => request(axios, basePath));
|
|
559
|
+
},
|
|
507
560
|
/**
|
|
508
561
|
*
|
|
509
562
|
* @summary Create an envelope (sent immediately unless send=false)
|
|
@@ -601,6 +654,15 @@ class ESignApi extends base_1.BaseAPI {
|
|
|
601
654
|
cancel(id, options) {
|
|
602
655
|
return (0, exports.ESignApiFp)(this.configuration).cancel(id, options).then((request) => request(this.axios, this.basePath));
|
|
603
656
|
}
|
|
657
|
+
/**
|
|
658
|
+
*
|
|
659
|
+
* @summary Cloud Signing subscription and month-to-date usage (openfilz-cloud seal provider only)
|
|
660
|
+
* @param {*} [options] Override http request option.
|
|
661
|
+
* @throws {RequiredError}
|
|
662
|
+
*/
|
|
663
|
+
cloudSubscription(options) {
|
|
664
|
+
return (0, exports.ESignApiFp)(this.configuration).cloudSubscription(options).then((request) => request(this.axios, this.basePath));
|
|
665
|
+
}
|
|
604
666
|
/**
|
|
605
667
|
*
|
|
606
668
|
* @summary Create an envelope (sent immediately unless send=false)
|
|
@@ -12,6 +12,7 @@
|
|
|
12
12
|
import type { Configuration } from '../configuration';
|
|
13
13
|
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
14
14
|
import { type RequestArgs, BaseAPI } from '../base';
|
|
15
|
+
import type { CloudSignatureSubscription } from '../models';
|
|
15
16
|
import type { CreateSignatureEnvelopeRequest } from '../models';
|
|
16
17
|
import type { SignatureEnvelopeDTO } from '../models';
|
|
17
18
|
import type { SignatureEventDTO } from '../models';
|
|
@@ -27,6 +28,13 @@ export declare const ESignApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
27
28
|
* @throws {RequiredError}
|
|
28
29
|
*/
|
|
29
30
|
cancel: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
31
|
+
/**
|
|
32
|
+
*
|
|
33
|
+
* @summary Cloud Signing subscription and month-to-date usage (openfilz-cloud seal provider only)
|
|
34
|
+
* @param {*} [options] Override http request option.
|
|
35
|
+
* @throws {RequiredError}
|
|
36
|
+
*/
|
|
37
|
+
cloudSubscription: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
30
38
|
/**
|
|
31
39
|
*
|
|
32
40
|
* @summary Create an envelope (sent immediately unless send=false)
|
|
@@ -104,6 +112,13 @@ export declare const ESignApiFp: (configuration?: Configuration) => {
|
|
|
104
112
|
* @throws {RequiredError}
|
|
105
113
|
*/
|
|
106
114
|
cancel(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SignatureEnvelopeDTO>>;
|
|
115
|
+
/**
|
|
116
|
+
*
|
|
117
|
+
* @summary Cloud Signing subscription and month-to-date usage (openfilz-cloud seal provider only)
|
|
118
|
+
* @param {*} [options] Override http request option.
|
|
119
|
+
* @throws {RequiredError}
|
|
120
|
+
*/
|
|
121
|
+
cloudSubscription(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CloudSignatureSubscription>>;
|
|
107
122
|
/**
|
|
108
123
|
*
|
|
109
124
|
* @summary Create an envelope (sent immediately unless send=false)
|
|
@@ -181,6 +196,13 @@ export declare const ESignApiFactory: (configuration?: Configuration, basePath?:
|
|
|
181
196
|
* @throws {RequiredError}
|
|
182
197
|
*/
|
|
183
198
|
cancel(id: string, options?: RawAxiosRequestConfig): AxiosPromise<SignatureEnvelopeDTO>;
|
|
199
|
+
/**
|
|
200
|
+
*
|
|
201
|
+
* @summary Cloud Signing subscription and month-to-date usage (openfilz-cloud seal provider only)
|
|
202
|
+
* @param {*} [options] Override http request option.
|
|
203
|
+
* @throws {RequiredError}
|
|
204
|
+
*/
|
|
205
|
+
cloudSubscription(options?: RawAxiosRequestConfig): AxiosPromise<CloudSignatureSubscription>;
|
|
184
206
|
/**
|
|
185
207
|
*
|
|
186
208
|
* @summary Create an envelope (sent immediately unless send=false)
|
|
@@ -258,6 +280,13 @@ export declare class ESignApi extends BaseAPI {
|
|
|
258
280
|
* @throws {RequiredError}
|
|
259
281
|
*/
|
|
260
282
|
cancel(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SignatureEnvelopeDTO, any, {}, any>>;
|
|
283
|
+
/**
|
|
284
|
+
*
|
|
285
|
+
* @summary Cloud Signing subscription and month-to-date usage (openfilz-cloud seal provider only)
|
|
286
|
+
* @param {*} [options] Override http request option.
|
|
287
|
+
* @throws {RequiredError}
|
|
288
|
+
*/
|
|
289
|
+
cloudSubscription(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CloudSignatureSubscription, any, {}, any>>;
|
|
261
290
|
/**
|
|
262
291
|
*
|
|
263
292
|
* @summary Create an envelope (sent immediately unless send=false)
|
|
@@ -64,6 +64,35 @@ export const ESignApiAxiosParamCreator = function (configuration) {
|
|
|
64
64
|
options: localVarRequestOptions,
|
|
65
65
|
};
|
|
66
66
|
}),
|
|
67
|
+
/**
|
|
68
|
+
*
|
|
69
|
+
* @summary Cloud Signing subscription and month-to-date usage (openfilz-cloud seal provider only)
|
|
70
|
+
* @param {*} [options] Override http request option.
|
|
71
|
+
* @throws {RequiredError}
|
|
72
|
+
*/
|
|
73
|
+
cloudSubscription: (...args_1) => __awaiter(this, [...args_1], void 0, function* (options = {}) {
|
|
74
|
+
const localVarPath = `/api/v1/signatures/cloud-subscription`;
|
|
75
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
76
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
77
|
+
let baseOptions;
|
|
78
|
+
if (configuration) {
|
|
79
|
+
baseOptions = configuration.baseOptions;
|
|
80
|
+
}
|
|
81
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
82
|
+
const localVarHeaderParameter = {};
|
|
83
|
+
const localVarQueryParameter = {};
|
|
84
|
+
// authentication keycloak_auth required
|
|
85
|
+
// http bearer authentication required
|
|
86
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
87
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
88
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
89
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
90
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
91
|
+
return {
|
|
92
|
+
url: toPathString(localVarUrlObj),
|
|
93
|
+
options: localVarRequestOptions,
|
|
94
|
+
};
|
|
95
|
+
}),
|
|
67
96
|
/**
|
|
68
97
|
*
|
|
69
98
|
* @summary Create an envelope (sent immediately unless send=false)
|
|
@@ -353,6 +382,21 @@ export const ESignApiFp = function (configuration) {
|
|
|
353
382
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
354
383
|
});
|
|
355
384
|
},
|
|
385
|
+
/**
|
|
386
|
+
*
|
|
387
|
+
* @summary Cloud Signing subscription and month-to-date usage (openfilz-cloud seal provider only)
|
|
388
|
+
* @param {*} [options] Override http request option.
|
|
389
|
+
* @throws {RequiredError}
|
|
390
|
+
*/
|
|
391
|
+
cloudSubscription(options) {
|
|
392
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
393
|
+
var _a, _b, _c;
|
|
394
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.cloudSubscription(options);
|
|
395
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
396
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ESignApi.cloudSubscription']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
397
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
398
|
+
});
|
|
399
|
+
},
|
|
356
400
|
/**
|
|
357
401
|
*
|
|
358
402
|
* @summary Create an envelope (sent immediately unless send=false)
|
|
@@ -499,6 +543,15 @@ export const ESignApiFactory = function (configuration, basePath, axios) {
|
|
|
499
543
|
cancel(id, options) {
|
|
500
544
|
return localVarFp.cancel(id, options).then((request) => request(axios, basePath));
|
|
501
545
|
},
|
|
546
|
+
/**
|
|
547
|
+
*
|
|
548
|
+
* @summary Cloud Signing subscription and month-to-date usage (openfilz-cloud seal provider only)
|
|
549
|
+
* @param {*} [options] Override http request option.
|
|
550
|
+
* @throws {RequiredError}
|
|
551
|
+
*/
|
|
552
|
+
cloudSubscription(options) {
|
|
553
|
+
return localVarFp.cloudSubscription(options).then((request) => request(axios, basePath));
|
|
554
|
+
},
|
|
502
555
|
/**
|
|
503
556
|
*
|
|
504
557
|
* @summary Create an envelope (sent immediately unless send=false)
|
|
@@ -595,6 +648,15 @@ export class ESignApi extends BaseAPI {
|
|
|
595
648
|
cancel(id, options) {
|
|
596
649
|
return ESignApiFp(this.configuration).cancel(id, options).then((request) => request(this.axios, this.basePath));
|
|
597
650
|
}
|
|
651
|
+
/**
|
|
652
|
+
*
|
|
653
|
+
* @summary Cloud Signing subscription and month-to-date usage (openfilz-cloud seal provider only)
|
|
654
|
+
* @param {*} [options] Override http request option.
|
|
655
|
+
* @throws {RequiredError}
|
|
656
|
+
*/
|
|
657
|
+
cloudSubscription(options) {
|
|
658
|
+
return ESignApiFp(this.configuration).cloudSubscription(options).then((request) => request(this.axios, this.basePath));
|
|
659
|
+
}
|
|
598
660
|
/**
|
|
599
661
|
*
|
|
600
662
|
* @summary Create an envelope (sent immediately unless send=false)
|
|
@@ -0,0 +1,22 @@
|
|
|
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 CloudSignatureSubscription {
|
|
13
|
+
'status'?: string;
|
|
14
|
+
'billingMode'?: string;
|
|
15
|
+
'monthlyQuota'?: number;
|
|
16
|
+
'usedThisMonth'?: number;
|
|
17
|
+
'remaining'?: number;
|
|
18
|
+
'periodStart'?: string;
|
|
19
|
+
'periodEnd'?: string;
|
|
20
|
+
'hardCap'?: boolean;
|
|
21
|
+
'memberSince'?: string;
|
|
22
|
+
}
|
|
@@ -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 {};
|
|
@@ -13,6 +13,7 @@ export * from './bulk-row';
|
|
|
13
13
|
export * from './bulk-row-result';
|
|
14
14
|
export * from './bulk-send-request';
|
|
15
15
|
export * from './bulk-send-response';
|
|
16
|
+
export * from './cloud-signature-subscription';
|
|
16
17
|
export * from './comment-dto';
|
|
17
18
|
export * from './consume-delegated-grant-request';
|
|
18
19
|
export * from './copy-audit';
|
package/dist/esm/models/index.js
CHANGED
|
@@ -13,6 +13,7 @@ export * from './bulk-row';
|
|
|
13
13
|
export * from './bulk-row-result';
|
|
14
14
|
export * from './bulk-send-request';
|
|
15
15
|
export * from './bulk-send-response';
|
|
16
|
+
export * from './cloud-signature-subscription';
|
|
16
17
|
export * from './comment-dto';
|
|
17
18
|
export * from './consume-delegated-grant-request';
|
|
18
19
|
export * from './copy-audit';
|
|
@@ -0,0 +1,22 @@
|
|
|
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 CloudSignatureSubscription {
|
|
13
|
+
'status'?: string;
|
|
14
|
+
'billingMode'?: string;
|
|
15
|
+
'monthlyQuota'?: number;
|
|
16
|
+
'usedThisMonth'?: number;
|
|
17
|
+
'remaining'?: number;
|
|
18
|
+
'periodStart'?: string;
|
|
19
|
+
'periodEnd'?: string;
|
|
20
|
+
'hardCap'?: boolean;
|
|
21
|
+
'memberSince'?: string;
|
|
22
|
+
}
|
|
@@ -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 });
|
package/dist/models/index.d.ts
CHANGED
|
@@ -13,6 +13,7 @@ export * from './bulk-row';
|
|
|
13
13
|
export * from './bulk-row-result';
|
|
14
14
|
export * from './bulk-send-request';
|
|
15
15
|
export * from './bulk-send-response';
|
|
16
|
+
export * from './cloud-signature-subscription';
|
|
16
17
|
export * from './comment-dto';
|
|
17
18
|
export * from './consume-delegated-grant-request';
|
|
18
19
|
export * from './copy-audit';
|
package/dist/models/index.js
CHANGED
|
@@ -29,6 +29,7 @@ __exportStar(require("./bulk-row"), exports);
|
|
|
29
29
|
__exportStar(require("./bulk-row-result"), exports);
|
|
30
30
|
__exportStar(require("./bulk-send-request"), exports);
|
|
31
31
|
__exportStar(require("./bulk-send-response"), exports);
|
|
32
|
+
__exportStar(require("./cloud-signature-subscription"), exports);
|
|
32
33
|
__exportStar(require("./comment-dto"), exports);
|
|
33
34
|
__exportStar(require("./consume-delegated-grant-request"), exports);
|
|
34
35
|
__exportStar(require("./copy-audit"), exports);
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# CloudSignatureSubscription
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**status** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**billingMode** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**monthlyQuota** | **number** | | [optional] [default to undefined]
|
|
11
|
+
**usedThisMonth** | **number** | | [optional] [default to undefined]
|
|
12
|
+
**remaining** | **number** | | [optional] [default to undefined]
|
|
13
|
+
**periodStart** | **string** | | [optional] [default to undefined]
|
|
14
|
+
**periodEnd** | **string** | | [optional] [default to undefined]
|
|
15
|
+
**hardCap** | **boolean** | | [optional] [default to undefined]
|
|
16
|
+
**memberSince** | **string** | | [optional] [default to undefined]
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
```typescript
|
|
21
|
+
import { CloudSignatureSubscription } from '@openfilz-sdk/typescript-ee';
|
|
22
|
+
|
|
23
|
+
const instance: CloudSignatureSubscription = {
|
|
24
|
+
status,
|
|
25
|
+
billingMode,
|
|
26
|
+
monthlyQuota,
|
|
27
|
+
usedThisMonth,
|
|
28
|
+
remaining,
|
|
29
|
+
periodStart,
|
|
30
|
+
periodEnd,
|
|
31
|
+
hardCap,
|
|
32
|
+
memberSince,
|
|
33
|
+
};
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
[[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/docs/ESignApi.md
CHANGED
|
@@ -5,6 +5,7 @@ All URIs are relative to *http://localhost:8081*
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
7
|
|[**cancel**](#cancel) | **POST** /api/v1/signatures/{id}/cancel | Cancel a non-terminal envelope|
|
|
8
|
+
|[**cloudSubscription**](#cloudsubscription) | **GET** /api/v1/signatures/cloud-subscription | Cloud Signing subscription and month-to-date usage (openfilz-cloud seal provider only)|
|
|
8
9
|
|[**create**](#create) | **POST** /api/v1/signatures | Create an envelope (sent immediately unless send=false)|
|
|
9
10
|
|[**events**](#events) | **GET** /api/v1/signatures/{id}/events | Audit trail of one of my envelopes|
|
|
10
11
|
|[**get2**](#get2) | **GET** /api/v1/signatures/{id} | Get one of my envelopes (recipients + fields)|
|
|
@@ -57,6 +58,49 @@ const { status, data } = await apiInstance.cancel(
|
|
|
57
58
|
- **Accept**: application/json
|
|
58
59
|
|
|
59
60
|
|
|
61
|
+
### HTTP response details
|
|
62
|
+
| Status code | Description | Response headers |
|
|
63
|
+
|-------------|-------------|------------------|
|
|
64
|
+
|**200** | OK | - |
|
|
65
|
+
|
|
66
|
+
[[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)
|
|
67
|
+
|
|
68
|
+
# **cloudSubscription**
|
|
69
|
+
> CloudSignatureSubscription cloudSubscription()
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
### Example
|
|
73
|
+
|
|
74
|
+
```typescript
|
|
75
|
+
import {
|
|
76
|
+
ESignApi,
|
|
77
|
+
Configuration
|
|
78
|
+
} from '@openfilz-sdk/typescript-ee';
|
|
79
|
+
|
|
80
|
+
const configuration = new Configuration();
|
|
81
|
+
const apiInstance = new ESignApi(configuration);
|
|
82
|
+
|
|
83
|
+
const { status, data } = await apiInstance.cloudSubscription();
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
### Parameters
|
|
87
|
+
This endpoint does not have any parameters.
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
### Return type
|
|
91
|
+
|
|
92
|
+
**CloudSignatureSubscription**
|
|
93
|
+
|
|
94
|
+
### Authorization
|
|
95
|
+
|
|
96
|
+
[keycloak_auth](../README.md#keycloak_auth)
|
|
97
|
+
|
|
98
|
+
### HTTP request headers
|
|
99
|
+
|
|
100
|
+
- **Content-Type**: Not defined
|
|
101
|
+
- **Accept**: application/json
|
|
102
|
+
|
|
103
|
+
|
|
60
104
|
### HTTP response details
|
|
61
105
|
| Status code | Description | Response headers |
|
|
62
106
|
|-------------|-------------|------------------|
|
package/docs/Settings.md
CHANGED
|
@@ -16,6 +16,7 @@ Name | Type | Description | Notes
|
|
|
16
16
|
**signatureActive** | **boolean** | | [optional] [default to undefined]
|
|
17
17
|
**signatureAuthMethods** | **Array<string>** | | [optional] [default to undefined]
|
|
18
18
|
**signatureRemindersActive** | **boolean** | | [optional] [default to undefined]
|
|
19
|
+
**signatureCloudActive** | **boolean** | | [optional] [default to undefined]
|
|
19
20
|
|
|
20
21
|
## Example
|
|
21
22
|
|
|
@@ -34,6 +35,7 @@ const instance: Settings = {
|
|
|
34
35
|
signatureActive,
|
|
35
36
|
signatureAuthMethods,
|
|
36
37
|
signatureRemindersActive,
|
|
38
|
+
signatureCloudActive,
|
|
37
39
|
};
|
|
38
40
|
```
|
|
39
41
|
|
|
@@ -0,0 +1,28 @@
|
|
|
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 CloudSignatureSubscription {
|
|
18
|
+
'status'?: string;
|
|
19
|
+
'billingMode'?: string;
|
|
20
|
+
'monthlyQuota'?: number;
|
|
21
|
+
'usedThisMonth'?: number;
|
|
22
|
+
'remaining'?: number;
|
|
23
|
+
'periodStart'?: string;
|
|
24
|
+
'periodEnd'?: string;
|
|
25
|
+
'hardCap'?: boolean;
|
|
26
|
+
'memberSince'?: string;
|
|
27
|
+
}
|
|
28
|
+
|
package/models/index.ts
CHANGED
|
@@ -13,6 +13,7 @@ export * from './bulk-row';
|
|
|
13
13
|
export * from './bulk-row-result';
|
|
14
14
|
export * from './bulk-send-request';
|
|
15
15
|
export * from './bulk-send-response';
|
|
16
|
+
export * from './cloud-signature-subscription';
|
|
16
17
|
export * from './comment-dto';
|
|
17
18
|
export * from './consume-delegated-grant-request';
|
|
18
19
|
export * from './copy-audit';
|
package/models/settings.ts
CHANGED