@openfilz-sdk/typescript-ee 1.4.4 → 1.5.1

package/dist/models/enriched-audit-log.js

@@ -53,7 +53,14 @@ exports.EnrichedAuditLogActionEnum = {
     DelegatedGrantConsumed: 'DELEGATED_GRANT_CONSUMED',
     DelegatedGrantSubscriptionRevokedByAdmin: 'DELEGATED_GRANT_SUBSCRIPTION_REVOKED_BY_ADMIN',
     DelegatedBrowse: 'DELEGATED_BROWSE',
-    AdminMonitoringOptOutChanged: 'ADMIN_MONITORING_OPT_OUT_CHANGED'
+    AdminMonitoringOptOutChanged: 'ADMIN_MONITORING_OPT_OUT_CHANGED',
+    SignatureEnvelopeCreated: 'SIGNATURE_ENVELOPE_CREATED',
+    SignatureEnvelopeSent: 'SIGNATURE_ENVELOPE_SENT',
+    SignatureDocumentSigned: 'SIGNATURE_DOCUMENT_SIGNED',
+    SignatureEnvelopeCompleted: 'SIGNATURE_ENVELOPE_COMPLETED',
+    SignatureEnvelopeDeclined: 'SIGNATURE_ENVELOPE_DECLINED',
+    SignatureEnvelopeCancelled: 'SIGNATURE_ENVELOPE_CANCELLED',
+    SignatureEnvelopeExpired: 'SIGNATURE_ENVELOPE_EXPIRED'
 };
 exports.EnrichedAuditLogResourceTypeEnum = {
     File: 'FILE',

package/dist/models/index.d.ts

@@ -1,4 +1,5 @@
 export * from './ancestor-info';
+export * from './apply-signature-request';
 export * from './audit-log-details';
 export * from './audit-verification-result';
 export * from './broken-link';
@@ -12,8 +13,10 @@ export * from './create-comment-request';
 export * from './create-delegated-grant-request';
 export * from './create-folder-audit';
 export * from './create-folder-request';
+export * from './create-signature-envelope-request';
 export * from './create-team-request';
 export * from './dashboard-statistics-response';
+export * from './decline-signature-request';
 export * from './delegated-folder-node';
 export * from './delegated-grant-dto';
 export * from './delete-audit';
@@ -35,6 +38,7 @@ export * from './mint-upload-token-request';
 export * from './move-audit';
 export * from './move-request';
 export * from './notification-dto';
+export * from './public-signature-view';
 export * from './rename-audit';
 export * from './rename-request';
 export * from './replace-audit';
@@ -49,6 +53,11 @@ export * from './share-request';
 export * from './share-result-error';
 export * from './share-result-item';
 export * from './share-result-response';
+export * from './signature-archive-dto';
+export * from './signature-envelope-dto';
+export * from './signature-field-placement';
+export * from './signature-recipient-dto';
+export * from './signature-recipient-input';
 export * from './sort-input';
 export * from './storage-breakdown';
 export * from './suggest';

package/dist/models/index.js

@@ -15,6 +15,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./ancestor-info"), exports);
+__exportStar(require("./apply-signature-request"), exports);
 __exportStar(require("./audit-log-details"), exports);
 __exportStar(require("./audit-verification-result"), exports);
 __exportStar(require("./broken-link"), exports);
@@ -28,8 +29,10 @@ __exportStar(require("./create-comment-request"), exports);
 __exportStar(require("./create-delegated-grant-request"), exports);
 __exportStar(require("./create-folder-audit"), exports);
 __exportStar(require("./create-folder-request"), exports);
+__exportStar(require("./create-signature-envelope-request"), exports);
 __exportStar(require("./create-team-request"), exports);
 __exportStar(require("./dashboard-statistics-response"), exports);
+__exportStar(require("./decline-signature-request"), exports);
 __exportStar(require("./delegated-folder-node"), exports);
 __exportStar(require("./delegated-grant-dto"), exports);
 __exportStar(require("./delete-audit"), exports);
@@ -51,6 +54,7 @@ __exportStar(require("./mint-upload-token-request"), exports);
 __exportStar(require("./move-audit"), exports);
 __exportStar(require("./move-request"), exports);
 __exportStar(require("./notification-dto"), exports);
+__exportStar(require("./public-signature-view"), exports);
 __exportStar(require("./rename-audit"), exports);
 __exportStar(require("./rename-request"), exports);
 __exportStar(require("./replace-audit"), exports);
@@ -65,6 +69,11 @@ __exportStar(require("./share-request"), exports);
 __exportStar(require("./share-result-error"), exports);
 __exportStar(require("./share-result-item"), exports);
 __exportStar(require("./share-result-response"), exports);
+__exportStar(require("./signature-archive-dto"), exports);
+__exportStar(require("./signature-envelope-dto"), exports);
+__exportStar(require("./signature-field-placement"), exports);
+__exportStar(require("./signature-recipient-dto"), exports);
+__exportStar(require("./signature-recipient-input"), exports);
 __exportStar(require("./sort-input"), exports);
 __exportStar(require("./storage-breakdown"), exports);
 __exportStar(require("./suggest"), exports);

package/dist/models/notification-dto.d.ts

@@ -28,5 +28,8 @@ export declare const NotificationDTOTypeEnum: {
     readonly DelegatedGrantRequested: "DELEGATED_GRANT_REQUESTED";
     readonly DelegatedGrantConsumed: "DELEGATED_GRANT_CONSUMED";
     readonly DelegatedGrantExpired: "DELEGATED_GRANT_EXPIRED";
+    readonly SignatureRequest: "SIGNATURE_REQUEST";
+    readonly SignatureCompleted: "SIGNATURE_COMPLETED";
+    readonly SignatureDeclined: "SIGNATURE_DECLINED";
 };
 export type NotificationDTOTypeEnum = typeof NotificationDTOTypeEnum[keyof typeof NotificationDTOTypeEnum];

package/dist/models/notification-dto.js

@@ -21,5 +21,8 @@ exports.NotificationDTOTypeEnum = {
     VirusDetected: 'VIRUS_DETECTED',
     DelegatedGrantRequested: 'DELEGATED_GRANT_REQUESTED',
     DelegatedGrantConsumed: 'DELEGATED_GRANT_CONSUMED',
-    DelegatedGrantExpired: 'DELEGATED_GRANT_EXPIRED'
+    DelegatedGrantExpired: 'DELEGATED_GRANT_EXPIRED',
+    SignatureRequest: 'SIGNATURE_REQUEST',
+    SignatureCompleted: 'SIGNATURE_COMPLETED',
+    SignatureDeclined: 'SIGNATURE_DECLINED'
 };

package/dist/models/public-signature-view.d.ts

@@ -0,0 +1,44 @@
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export interface PublicSignatureView {
+    'envelopeTitle'?: string;
+    'message'?: string;
+    'initiatorEmail'?: string;
+    'documentName'?: string;
+    'recipientName'?: string;
+    'recipientEmail'?: string;
+    'envelopeStatus'?: PublicSignatureViewEnvelopeStatusEnum;
+    'recipientStatus'?: PublicSignatureViewRecipientStatusEnum;
+    'fieldPage'?: number;
+    'fieldX'?: number;
+    'fieldY'?: number;
+    'fieldW'?: number;
+    'fieldH'?: number;
+    'signatureImage'?: string;
+    'signatureTyped'?: string;
+}
+export declare const PublicSignatureViewEnvelopeStatusEnum: {
+    readonly Draft: "DRAFT";
+    readonly Sent: "SENT";
+    readonly Completed: "COMPLETED";
+    readonly Declined: "DECLINED";
+    readonly Cancelled: "CANCELLED";
+    readonly Expired: "EXPIRED";
+};
+export type PublicSignatureViewEnvelopeStatusEnum = typeof PublicSignatureViewEnvelopeStatusEnum[keyof typeof PublicSignatureViewEnvelopeStatusEnum];
+export declare const PublicSignatureViewRecipientStatusEnum: {
+    readonly Pending: "PENDING";
+    readonly Viewed: "VIEWED";
+    readonly Signed: "SIGNED";
+    readonly Declined: "DECLINED";
+};
+export type PublicSignatureViewRecipientStatusEnum = typeof PublicSignatureViewRecipientStatusEnum[keyof typeof PublicSignatureViewRecipientStatusEnum];

package/dist/models/public-signature-view.js

@@ -0,0 +1,30 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PublicSignatureViewRecipientStatusEnum = exports.PublicSignatureViewEnvelopeStatusEnum = void 0;
+exports.PublicSignatureViewEnvelopeStatusEnum = {
+    Draft: 'DRAFT',
+    Sent: 'SENT',
+    Completed: 'COMPLETED',
+    Declined: 'DECLINED',
+    Cancelled: 'CANCELLED',
+    Expired: 'EXPIRED'
+};
+exports.PublicSignatureViewRecipientStatusEnum = {
+    Pending: 'PENDING',
+    Viewed: 'VIEWED',
+    Signed: 'SIGNED',
+    Declined: 'DECLINED'
+};

package/dist/models/search-by-audit-log-request.d.ts

@@ -81,5 +81,12 @@ export declare const SearchByAuditLogRequestActionEnum: {
     readonly DelegatedGrantSubscriptionRevokedByAdmin: "DELEGATED_GRANT_SUBSCRIPTION_REVOKED_BY_ADMIN";
     readonly DelegatedBrowse: "DELEGATED_BROWSE";
     readonly AdminMonitoringOptOutChanged: "ADMIN_MONITORING_OPT_OUT_CHANGED";
+    readonly SignatureEnvelopeCreated: "SIGNATURE_ENVELOPE_CREATED";
+    readonly SignatureEnvelopeSent: "SIGNATURE_ENVELOPE_SENT";
+    readonly SignatureDocumentSigned: "SIGNATURE_DOCUMENT_SIGNED";
+    readonly SignatureEnvelopeCompleted: "SIGNATURE_ENVELOPE_COMPLETED";
+    readonly SignatureEnvelopeDeclined: "SIGNATURE_ENVELOPE_DECLINED";
+    readonly SignatureEnvelopeCancelled: "SIGNATURE_ENVELOPE_CANCELLED";
+    readonly SignatureEnvelopeExpired: "SIGNATURE_ENVELOPE_EXPIRED";
 };
 export type SearchByAuditLogRequestActionEnum = typeof SearchByAuditLogRequestActionEnum[keyof typeof SearchByAuditLogRequestActionEnum];

package/dist/models/search-by-audit-log-request.js

@@ -57,5 +57,12 @@ exports.SearchByAuditLogRequestActionEnum = {
     DelegatedGrantConsumed: 'DELEGATED_GRANT_CONSUMED',
     DelegatedGrantSubscriptionRevokedByAdmin: 'DELEGATED_GRANT_SUBSCRIPTION_REVOKED_BY_ADMIN',
     DelegatedBrowse: 'DELEGATED_BROWSE',
-    AdminMonitoringOptOutChanged: 'ADMIN_MONITORING_OPT_OUT_CHANGED'
+    AdminMonitoringOptOutChanged: 'ADMIN_MONITORING_OPT_OUT_CHANGED',
+    SignatureEnvelopeCreated: 'SIGNATURE_ENVELOPE_CREATED',
+    SignatureEnvelopeSent: 'SIGNATURE_ENVELOPE_SENT',
+    SignatureDocumentSigned: 'SIGNATURE_DOCUMENT_SIGNED',
+    SignatureEnvelopeCompleted: 'SIGNATURE_ENVELOPE_COMPLETED',
+    SignatureEnvelopeDeclined: 'SIGNATURE_ENVELOPE_DECLINED',
+    SignatureEnvelopeCancelled: 'SIGNATURE_ENVELOPE_CANCELLED',
+    SignatureEnvelopeExpired: 'SIGNATURE_ENVELOPE_EXPIRED'
 };

package/dist/models/signature-archive-dto.d.ts

@@ -0,0 +1,19 @@
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export interface SignatureArchiveDTO {
+    'pdfaDocId'?: string;
+    'flavor'?: string;
+    'compliant'?: boolean;
+    'status'?: string;
+    'report'?: string;
+    'createdAt'?: string;
+}

package/dist/models/signature-archive-dto.js

@@ -0,0 +1,15 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/signature-envelope-dto.d.ts

@@ -0,0 +1,34 @@
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { SignatureRecipientDTO } from './signature-recipient-dto';
+export interface SignatureEnvelopeDTO {
+    'id'?: string;
+    'title'?: string;
+    'message'?: string;
+    'sourceDocId'?: string;
+    'signedDocId'?: string;
+    'status'?: SignatureEnvelopeDTOStatusEnum;
+    'initiatorEmail'?: string;
+    'createdAt'?: string;
+    'completedAt'?: string;
+    'expiresAt'?: string;
+    'recipients'?: Array<SignatureRecipientDTO>;
+}
+export declare const SignatureEnvelopeDTOStatusEnum: {
+    readonly Draft: "DRAFT";
+    readonly Sent: "SENT";
+    readonly Completed: "COMPLETED";
+    readonly Declined: "DECLINED";
+    readonly Cancelled: "CANCELLED";
+    readonly Expired: "EXPIRED";
+};
+export type SignatureEnvelopeDTOStatusEnum = typeof SignatureEnvelopeDTOStatusEnum[keyof typeof SignatureEnvelopeDTOStatusEnum];

package/dist/models/signature-envelope-dto.js

@@ -0,0 +1,24 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SignatureEnvelopeDTOStatusEnum = void 0;
+exports.SignatureEnvelopeDTOStatusEnum = {
+    Draft: 'DRAFT',
+    Sent: 'SENT',
+    Completed: 'COMPLETED',
+    Declined: 'DECLINED',
+    Cancelled: 'CANCELLED',
+    Expired: 'EXPIRED'
+};

package/dist/models/signature-field-placement.d.ts

@@ -0,0 +1,18 @@
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export interface SignatureFieldPlacement {
+    'page': number;
+    'x': number;
+    'y': number;
+    'w': number;
+    'h': number;
+}

package/dist/models/signature-field-placement.js

@@ -0,0 +1,15 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/signature-recipient-dto.d.ts

@@ -0,0 +1,29 @@
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export interface SignatureRecipientDTO {
+    'id'?: string;
+    'userId'?: string;
+    'name'?: string;
+    'email'?: string;
+    'orderIndex'?: number;
+    'status'?: SignatureRecipientDTOStatusEnum;
+    'viewedAt'?: string;
+    'signedAt'?: string;
+    'declineReason'?: string;
+}
+export declare const SignatureRecipientDTOStatusEnum: {
+    readonly Pending: "PENDING";
+    readonly Viewed: "VIEWED";
+    readonly Signed: "SIGNED";
+    readonly Declined: "DECLINED";
+};
+export type SignatureRecipientDTOStatusEnum = typeof SignatureRecipientDTOStatusEnum[keyof typeof SignatureRecipientDTOStatusEnum];

package/dist/models/signature-recipient-dto.js

@@ -0,0 +1,22 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SignatureRecipientDTOStatusEnum = void 0;
+exports.SignatureRecipientDTOStatusEnum = {
+    Pending: 'PENDING',
+    Viewed: 'VIEWED',
+    Signed: 'SIGNED',
+    Declined: 'DECLINED'
+};

package/dist/models/signature-recipient-input.d.ts

@@ -0,0 +1,18 @@
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { SignatureFieldPlacement } from './signature-field-placement';
+export interface SignatureRecipientInput {
+    'userId'?: string;
+    'name'?: string;
+    'email': string;
+    'field': SignatureFieldPlacement;
+}

package/dist/models/signature-recipient-input.js

@@ -0,0 +1,15 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/docs/ApplySignatureRequest.md

@@ -0,0 +1,22 @@
+# ApplySignatureRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**signatureImage** | **string** |  | [optional] [default to undefined]
+**typedName** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ApplySignatureRequest } from '@openfilz-sdk/typescript-ee';
+
+const instance: ApplySignatureRequest = {
+    signatureImage,
+    typedName,
+};
+```
+
+[[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/CreateSignatureEnvelopeRequest.md

@@ -0,0 +1,28 @@
+# CreateSignatureEnvelopeRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sourceDocId** | **string** |  | [default to undefined]
+**title** | **string** |  | [default to undefined]
+**message** | **string** |  | [optional] [default to undefined]
+**recipients** | [**Array<SignatureRecipientInput>**](SignatureRecipientInput.md) |  | [default to undefined]
+**expiresInDays** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CreateSignatureEnvelopeRequest } from '@openfilz-sdk/typescript-ee';
+
+const instance: CreateSignatureEnvelopeRequest = {
+    sourceDocId,
+    title,
+    message,
+    recipients,
+    expiresInDays,
+};
+```
+
+[[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/DeclineSignatureRequest.md

@@ -0,0 +1,20 @@
+# DeclineSignatureRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**reason** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { DeclineSignatureRequest } from '@openfilz-sdk/typescript-ee';
+
+const instance: DeclineSignatureRequest = {
+    reason,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)