@openfilz-sdk/typescript 1.2.26 → 1.2.28

package/models/create-signature-envelope-request.ts

@@ -0,0 +1,32 @@
+/* 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.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { SignatureRecipientInput } from './signature-recipient-input';
+
+export interface CreateSignatureEnvelopeRequest {
+    'sourceDocId': string;
+    'title': string;
+    'message'?: string;
+    'recipients': Array<SignatureRecipientInput>;
+    'expiresInDays'?: number;
+    'sequential'?: boolean;
+    'reminderDays'?: number;
+    'locale'?: string;
+    'send'?: boolean;
+    'templateId'?: string;
+}
+

package/models/decline-signature-request.ts

@@ -0,0 +1,20 @@
+/* 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.
+ */
+
+
+
+export interface DeclineSignatureRequest {
+    'reason'?: string;
+}
+

package/models/index.ts

@@ -5,6 +5,7 @@ export * from './ai-connection-test-result';
 export * from './ai-models-response';
 export * from './ai-settings-response';
 export * from './ancestor-info';
+export * from './apply-signature-request';
 export * from './audit-log';
 export * from './audit-log-details';
 export * from './audit-log-details-one-of';
@@ -16,7 +17,9 @@ export * from './copy-response';
 export * from './create-blank-document-request';
 export * from './create-folder-audit';
 export * from './create-folder-request';
+export * from './create-signature-envelope-request';
 export * from './dashboard-statistics-response';
+export * from './decline-signature-request';
 export * from './delete-audit';
 export * from './delete-metadata-audit';
 export * from './delete-metadata-request';
@@ -29,19 +32,34 @@ export * from './file-type-stats';
 export * from './filter-input';
 export * from './folder-element-info';
 export * from './folder-response';
+export * from './instantiate-template-request';
 export * from './list-ai-models-request';
 export * from './move-audit';
 export * from './move-request';
+export * from './public-signature-view';
 export * from './rename-audit';
 export * from './rename-request';
 export * from './replace-audit';
 export * from './restore-version-audit';
 export * from './restore-version-response';
+export * from './role-binding';
 export * from './save-ai-settings-request';
 export * from './search-by-audit-log-request';
 export * from './search-by-metadata-request';
 export * from './search-metadata-request';
 export * from './settings';
+export * from './signature-envelope-dto';
+export * from './signature-event-dto';
+export * from './signature-field-dto';
+export * from './signature-field-input';
+export * from './signature-field-placement';
+export * from './signature-field-value';
+export * from './signature-recipient-dto';
+export * from './signature-recipient-input';
+export * from './signature-template-dto';
+export * from './signature-template-field';
+export * from './signature-template-request';
+export * from './signature-template-role';
 export * from './sort-input';
 export * from './storage-breakdown';
 export * from './suggest';
@@ -52,3 +70,4 @@ export * from './update-metadata-audit';
 export * from './update-metadata-request';
 export * from './upload-audit';
 export * from './upload-response';
+export * from './verify-otp-request';

package/models/instantiate-template-request.ts

@@ -0,0 +1,30 @@
+/* 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.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { RoleBinding } from './role-binding';
+
+export interface InstantiateTemplateRequest {
+    'sourceDocId'?: string;
+    'title'?: string;
+    'message'?: string;
+    'recipients': Array<RoleBinding>;
+    'expiresInDays'?: number;
+    'reminderDays'?: number;
+    'locale'?: string;
+    'send'?: boolean;
+}
+

package/models/public-signature-view.ts

@@ -0,0 +1,70 @@
+/* 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.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { SignatureFieldDTO } from './signature-field-dto';
+
+export interface PublicSignatureView {
+    'envelopeTitle'?: string;
+    'message'?: string;
+    'initiatorEmail'?: string;
+    'documentName'?: string;
+    'recipientName'?: string;
+    'recipientEmail'?: string;
+    'envelopeStatus'?: PublicSignatureViewEnvelopeStatusEnum;
+    'recipientStatus'?: PublicSignatureViewRecipientStatusEnum;
+    'myTurn'?: boolean;
+    'authMethod'?: PublicSignatureViewAuthMethodEnum;
+    'otpRequired'?: boolean;
+    'otpVerified'?: boolean;
+    'fields'?: Array<SignatureFieldDTO>;
+    'otherFields'?: Array<SignatureFieldDTO>;
+    'fieldPage'?: number;
+    'fieldX'?: number;
+    'fieldY'?: number;
+    'fieldW'?: number;
+    'fieldH'?: number;
+    'signatureImage'?: string;
+    'signatureTyped'?: string;
+}
+
+export const PublicSignatureViewEnvelopeStatusEnum = {
+    Draft: 'DRAFT',
+    Sent: 'SENT',
+    Completed: 'COMPLETED',
+    Declined: 'DECLINED',
+    Cancelled: 'CANCELLED',
+    Expired: 'EXPIRED',
+} as const;
+
+export type PublicSignatureViewEnvelopeStatusEnum = typeof PublicSignatureViewEnvelopeStatusEnum[keyof typeof PublicSignatureViewEnvelopeStatusEnum];
+export const PublicSignatureViewRecipientStatusEnum = {
+    Pending: 'PENDING',
+    Viewed: 'VIEWED',
+    Signed: 'SIGNED',
+    Declined: 'DECLINED',
+} as const;
+
+export type PublicSignatureViewRecipientStatusEnum = typeof PublicSignatureViewRecipientStatusEnum[keyof typeof PublicSignatureViewRecipientStatusEnum];
+export const PublicSignatureViewAuthMethodEnum = {
+    None: 'NONE',
+    EmailOtp: 'EMAIL_OTP',
+    SmsOtp: 'SMS_OTP',
+} as const;
+
+export type PublicSignatureViewAuthMethodEnum = typeof PublicSignatureViewAuthMethodEnum[keyof typeof PublicSignatureViewAuthMethodEnum];
+
+

package/models/role-binding.ts

@@ -0,0 +1,25 @@
+/* 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.
+ */
+
+
+
+export interface RoleBinding {
+    'role': string;
+    'userId'?: string;
+    'name'?: string;
+    'email': string;
+    'phone'?: string;
+    'locale'?: string;
+}
+

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

@@ -70,6 +70,16 @@ export const SearchByAuditLogRequestActionEnum = {
     PermanentDeleteFile: 'PERMANENT_DELETE_FILE',
     PermanentDeleteFolder: 'PERMANENT_DELETE_FOLDER',
     EmptyRecycleBin: 'EMPTY_RECYCLE_BIN',
+    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',
+    SignatureReminderSent: 'SIGNATURE_REMINDER_SENT',
+    SignatureTemplateCreated: 'SIGNATURE_TEMPLATE_CREATED',
+    SignatureTemplateDeleted: 'SIGNATURE_TEMPLATE_DELETED',
     ChainGenesis: 'CHAIN_GENESIS',
 } as const;
 

package/models/settings.ts

@@ -23,5 +23,8 @@ export interface Settings {
     'thumbnailsActive'?: boolean;
     'aiActive'?: boolean;
     'aiUserSettingsEnabled'?: boolean;
+    'signatureActive'?: boolean;
+    'signatureAuthMethods'?: Array<string>;
+    'signatureRemindersActive'?: boolean;
 }
 

package/models/signature-envelope-dto.ts

@@ -0,0 +1,51 @@
+/* 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.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { SignatureRecipientDTO } from './signature-recipient-dto';
+
+export interface SignatureEnvelopeDTO {
+    'id'?: string;
+    'title'?: string;
+    'message'?: string;
+    'sourceDocId'?: string;
+    'signedDocId'?: string;
+    'status'?: SignatureEnvelopeDTOStatusEnum;
+    'initiatorEmail'?: string;
+    'sequential'?: boolean;
+    'currentOrder'?: number;
+    'templateId'?: string;
+    'reminderDays'?: number;
+    'sealProvider'?: string;
+    'createdAt'?: string;
+    'sentAt'?: string;
+    'completedAt'?: string;
+    'expiresAt'?: string;
+    'recipients'?: Array<SignatureRecipientDTO>;
+}
+
+export const SignatureEnvelopeDTOStatusEnum = {
+    Draft: 'DRAFT',
+    Sent: 'SENT',
+    Completed: 'COMPLETED',
+    Declined: 'DECLINED',
+    Cancelled: 'CANCELLED',
+    Expired: 'EXPIRED',
+} as const;
+
+export type SignatureEnvelopeDTOStatusEnum = typeof SignatureEnvelopeDTOStatusEnum[keyof typeof SignatureEnvelopeDTOStatusEnum];
+
+

package/models/signature-event-dto.ts

@@ -0,0 +1,42 @@
+/* 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.
+ */
+
+
+
+export interface SignatureEventDTO {
+    'type'?: SignatureEventDTOTypeEnum;
+    'actor'?: string;
+    'docSha256'?: string;
+    'signerIp'?: string;
+    'details'?: string;
+    'createdAt'?: string;
+}
+
+export const SignatureEventDTOTypeEnum = {
+    EnvelopeCreated: 'ENVELOPE_CREATED',
+    EnvelopeSent: 'ENVELOPE_SENT',
+    RecipientViewed: 'RECIPIENT_VIEWED',
+    RecipientOtpVerified: 'RECIPIENT_OTP_VERIFIED',
+    RecipientSigned: 'RECIPIENT_SIGNED',
+    RecipientDeclined: 'RECIPIENT_DECLINED',
+    RecipientReminded: 'RECIPIENT_REMINDED',
+    RecipientLinkResent: 'RECIPIENT_LINK_RESENT',
+    EnvelopeCompleted: 'ENVELOPE_COMPLETED',
+    EnvelopeCancelled: 'ENVELOPE_CANCELLED',
+    EnvelopeExpired: 'ENVELOPE_EXPIRED',
+} as const;
+
+export type SignatureEventDTOTypeEnum = typeof SignatureEventDTOTypeEnum[keyof typeof SignatureEventDTOTypeEnum];
+
+

package/models/signature-field-dto.ts

@@ -0,0 +1,51 @@
+/* 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.
+ */
+
+
+
+export interface SignatureFieldDTO {
+    'id'?: string;
+    'recipientId'?: string;
+    'type'?: SignatureFieldDTOTypeEnum;
+    'page'?: number;
+    'x'?: number;
+    'y'?: number;
+    'w'?: number;
+    'h'?: number;
+    'required'?: boolean;
+    'label'?: string;
+    'options'?: { [key: string]: any; };
+    'value'?: string;
+    'valueImage'?: string;
+    'filledAt'?: string;
+}
+
+export const SignatureFieldDTOTypeEnum = {
+    Signature: 'SIGNATURE',
+    Initials: 'INITIALS',
+    DateSigned: 'DATE_SIGNED',
+    Text: 'TEXT',
+    Number: 'NUMBER',
+    Email: 'EMAIL',
+    Phone: 'PHONE',
+    Checkbox: 'CHECKBOX',
+    Radio: 'RADIO',
+    Select: 'SELECT',
+    Image: 'IMAGE',
+    Stamp: 'STAMP',
+} as const;
+
+export type SignatureFieldDTOTypeEnum = typeof SignatureFieldDTOTypeEnum[keyof typeof SignatureFieldDTOTypeEnum];
+
+

package/models/signature-field-input.ts

@@ -0,0 +1,46 @@
+/* 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.
+ */
+
+
+
+export interface SignatureFieldInput {
+    'type': SignatureFieldInputTypeEnum;
+    'page': number;
+    'x': number;
+    'y': number;
+    'w': number;
+    'h': number;
+    'required'?: boolean;
+    'label'?: string;
+    'options'?: { [key: string]: any; };
+}
+
+export const SignatureFieldInputTypeEnum = {
+    Signature: 'SIGNATURE',
+    Initials: 'INITIALS',
+    DateSigned: 'DATE_SIGNED',
+    Text: 'TEXT',
+    Number: 'NUMBER',
+    Email: 'EMAIL',
+    Phone: 'PHONE',
+    Checkbox: 'CHECKBOX',
+    Radio: 'RADIO',
+    Select: 'SELECT',
+    Image: 'IMAGE',
+    Stamp: 'STAMP',
+} as const;
+
+export type SignatureFieldInputTypeEnum = typeof SignatureFieldInputTypeEnum[keyof typeof SignatureFieldInputTypeEnum];
+
+

package/models/signature-field-placement.ts

@@ -0,0 +1,24 @@
+/* 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.
+ */
+
+
+
+export interface SignatureFieldPlacement {
+    'page': number;
+    'x': number;
+    'y': number;
+    'w': number;
+    'h': number;
+}
+

package/models/signature-field-value.ts

@@ -0,0 +1,22 @@
+/* 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.
+ */
+
+
+
+export interface SignatureFieldValue {
+    'fieldId': string;
+    'value'?: string;
+    'valueImage'?: string;
+}
+

package/models/signature-recipient-dto.ts

@@ -0,0 +1,58 @@
+/* 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.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { SignatureFieldDTO } from './signature-field-dto';
+
+export interface SignatureRecipientDTO {
+    'id'?: string;
+    'userId'?: string;
+    'name'?: string;
+    'email'?: string;
+    'orderIndex'?: number;
+    'role'?: SignatureRecipientDTORoleEnum;
+    'authMethod'?: SignatureRecipientDTOAuthMethodEnum;
+    'status'?: SignatureRecipientDTOStatusEnum;
+    'viewedAt'?: string;
+    'signedAt'?: string;
+    'declineReason'?: string;
+    'reminderCount'?: number;
+    'fields'?: Array<SignatureFieldDTO>;
+}
+
+export const SignatureRecipientDTORoleEnum = {
+    Signer: 'SIGNER',
+    Cc: 'CC',
+} as const;
+
+export type SignatureRecipientDTORoleEnum = typeof SignatureRecipientDTORoleEnum[keyof typeof SignatureRecipientDTORoleEnum];
+export const SignatureRecipientDTOAuthMethodEnum = {
+    None: 'NONE',
+    EmailOtp: 'EMAIL_OTP',
+    SmsOtp: 'SMS_OTP',
+} as const;
+
+export type SignatureRecipientDTOAuthMethodEnum = typeof SignatureRecipientDTOAuthMethodEnum[keyof typeof SignatureRecipientDTOAuthMethodEnum];
+export const SignatureRecipientDTOStatusEnum = {
+    Pending: 'PENDING',
+    Viewed: 'VIEWED',
+    Signed: 'SIGNED',
+    Declined: 'DECLINED',
+} as const;
+
+export type SignatureRecipientDTOStatusEnum = typeof SignatureRecipientDTOStatusEnum[keyof typeof SignatureRecipientDTOStatusEnum];
+
+

package/models/signature-recipient-input.ts

@@ -0,0 +1,50 @@
+/* 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.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { SignatureFieldInput } from './signature-field-input';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { SignatureFieldPlacement } from './signature-field-placement';
+
+export interface SignatureRecipientInput {
+    'userId'?: string;
+    'name'?: string;
+    'email': string;
+    'orderIndex'?: number;
+    'role'?: SignatureRecipientInputRoleEnum;
+    'authMethod'?: SignatureRecipientInputAuthMethodEnum;
+    'phone'?: string;
+    'locale'?: string;
+    'fields'?: Array<SignatureFieldInput>;
+    'field'?: SignatureFieldPlacement;
+}
+
+export const SignatureRecipientInputRoleEnum = {
+    Signer: 'SIGNER',
+    Cc: 'CC',
+} as const;
+
+export type SignatureRecipientInputRoleEnum = typeof SignatureRecipientInputRoleEnum[keyof typeof SignatureRecipientInputRoleEnum];
+export const SignatureRecipientInputAuthMethodEnum = {
+    None: 'NONE',
+    EmailOtp: 'EMAIL_OTP',
+    SmsOtp: 'SMS_OTP',
+} as const;
+
+export type SignatureRecipientInputAuthMethodEnum = typeof SignatureRecipientInputAuthMethodEnum[keyof typeof SignatureRecipientInputAuthMethodEnum];
+
+

package/models/signature-template-dto.ts

@@ -0,0 +1,37 @@
+/* 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.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { SignatureTemplateField } from './signature-template-field';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { SignatureTemplateRole } from './signature-template-role';
+
+export interface SignatureTemplateDTO {
+    'id'?: string;
+    'ownerEmail'?: string;
+    'name'?: string;
+    'description'?: string;
+    'sourceDocId'?: string;
+    'roles'?: Array<SignatureTemplateRole>;
+    'fields'?: Array<SignatureTemplateField>;
+    'message'?: string;
+    'expiresInDays'?: number;
+    'sequential'?: boolean;
+    'createdAt'?: string;
+    'updatedAt'?: string;
+}
+