@openfilz-sdk/typescript 1.2.26 → 1.2.28

package/docs/InstantiateTemplateRequest.md

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

@@ -0,0 +1,60 @@
+# PublicSignatureView
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**envelopeTitle** | **string** |  | [optional] [default to undefined]
+**message** | **string** |  | [optional] [default to undefined]
+**initiatorEmail** | **string** |  | [optional] [default to undefined]
+**documentName** | **string** |  | [optional] [default to undefined]
+**recipientName** | **string** |  | [optional] [default to undefined]
+**recipientEmail** | **string** |  | [optional] [default to undefined]
+**envelopeStatus** | **string** |  | [optional] [default to undefined]
+**recipientStatus** | **string** |  | [optional] [default to undefined]
+**myTurn** | **boolean** |  | [optional] [default to undefined]
+**authMethod** | **string** |  | [optional] [default to undefined]
+**otpRequired** | **boolean** |  | [optional] [default to undefined]
+**otpVerified** | **boolean** |  | [optional] [default to undefined]
+**fields** | [**Array<SignatureFieldDTO>**](SignatureFieldDTO.md) |  | [optional] [default to undefined]
+**otherFields** | [**Array<SignatureFieldDTO>**](SignatureFieldDTO.md) |  | [optional] [default to undefined]
+**fieldPage** | **number** |  | [optional] [default to undefined]
+**fieldX** | **number** |  | [optional] [default to undefined]
+**fieldY** | **number** |  | [optional] [default to undefined]
+**fieldW** | **number** |  | [optional] [default to undefined]
+**fieldH** | **number** |  | [optional] [default to undefined]
+**signatureImage** | **string** |  | [optional] [default to undefined]
+**signatureTyped** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PublicSignatureView } from '@openfilz-sdk/typescript';
+
+const instance: PublicSignatureView = {
+    envelopeTitle,
+    message,
+    initiatorEmail,
+    documentName,
+    recipientName,
+    recipientEmail,
+    envelopeStatus,
+    recipientStatus,
+    myTurn,
+    authMethod,
+    otpRequired,
+    otpVerified,
+    fields,
+    otherFields,
+    fieldPage,
+    fieldX,
+    fieldY,
+    fieldW,
+    fieldH,
+    signatureImage,
+    signatureTyped,
+};
+```
+
+[[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/RoleBinding.md

@@ -0,0 +1,30 @@
+# RoleBinding
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**role** | **string** |  | [default to undefined]
+**userId** | **string** |  | [optional] [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+**email** | **string** |  | [default to undefined]
+**phone** | **string** |  | [optional] [default to undefined]
+**locale** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { RoleBinding } from '@openfilz-sdk/typescript';
+
+const instance: RoleBinding = {
+    role,
+    userId,
+    name,
+    email,
+    phone,
+    locale,
+};
+```
+
+[[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/Settings.md

@@ -13,6 +13,9 @@ Name | Type | Description | Notes
 **thumbnailsActive** | **boolean** |  | [optional] [default to undefined]
 **aiActive** | **boolean** |  | [optional] [default to undefined]
 **aiUserSettingsEnabled** | **boolean** |  | [optional] [default to undefined]
+**signatureActive** | **boolean** |  | [optional] [default to undefined]
+**signatureAuthMethods** | **Array<string>** |  | [optional] [default to undefined]
+**signatureRemindersActive** | **boolean** |  | [optional] [default to undefined]
 
 ## Example
 
@@ -28,6 +31,9 @@ const instance: Settings = {
     thumbnailsActive,
     aiActive,
     aiUserSettingsEnabled,
+    signatureActive,
+    signatureAuthMethods,
+    signatureRemindersActive,
 };
 ```
 

package/docs/SignatureEnvelopeDTO.md

@@ -0,0 +1,52 @@
+# SignatureEnvelopeDTO
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [optional] [default to undefined]
+**title** | **string** |  | [optional] [default to undefined]
+**message** | **string** |  | [optional] [default to undefined]
+**sourceDocId** | **string** |  | [optional] [default to undefined]
+**signedDocId** | **string** |  | [optional] [default to undefined]
+**status** | **string** |  | [optional] [default to undefined]
+**initiatorEmail** | **string** |  | [optional] [default to undefined]
+**sequential** | **boolean** |  | [optional] [default to undefined]
+**currentOrder** | **number** |  | [optional] [default to undefined]
+**templateId** | **string** |  | [optional] [default to undefined]
+**reminderDays** | **number** |  | [optional] [default to undefined]
+**sealProvider** | **string** |  | [optional] [default to undefined]
+**createdAt** | **string** |  | [optional] [default to undefined]
+**sentAt** | **string** |  | [optional] [default to undefined]
+**completedAt** | **string** |  | [optional] [default to undefined]
+**expiresAt** | **string** |  | [optional] [default to undefined]
+**recipients** | [**Array<SignatureRecipientDTO>**](SignatureRecipientDTO.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SignatureEnvelopeDTO } from '@openfilz-sdk/typescript';
+
+const instance: SignatureEnvelopeDTO = {
+    id,
+    title,
+    message,
+    sourceDocId,
+    signedDocId,
+    status,
+    initiatorEmail,
+    sequential,
+    currentOrder,
+    templateId,
+    reminderDays,
+    sealProvider,
+    createdAt,
+    sentAt,
+    completedAt,
+    expiresAt,
+    recipients,
+};
+```
+
+[[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/SignatureEventDTO.md

@@ -0,0 +1,30 @@
+# SignatureEventDTO
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **string** |  | [optional] [default to undefined]
+**actor** | **string** |  | [optional] [default to undefined]
+**docSha256** | **string** |  | [optional] [default to undefined]
+**signerIp** | **string** |  | [optional] [default to undefined]
+**details** | **string** |  | [optional] [default to undefined]
+**createdAt** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SignatureEventDTO } from '@openfilz-sdk/typescript';
+
+const instance: SignatureEventDTO = {
+    type,
+    actor,
+    docSha256,
+    signerIp,
+    details,
+    createdAt,
+};
+```
+
+[[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/SignatureFieldDTO.md

@@ -0,0 +1,46 @@
+# SignatureFieldDTO
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [optional] [default to undefined]
+**recipientId** | **string** |  | [optional] [default to undefined]
+**type** | **string** |  | [optional] [default to undefined]
+**page** | **number** |  | [optional] [default to undefined]
+**x** | **number** |  | [optional] [default to undefined]
+**y** | **number** |  | [optional] [default to undefined]
+**w** | **number** |  | [optional] [default to undefined]
+**h** | **number** |  | [optional] [default to undefined]
+**required** | **boolean** |  | [optional] [default to undefined]
+**label** | **string** |  | [optional] [default to undefined]
+**_options** | **{ [key: string]: any; }** |  | [optional] [default to undefined]
+**value** | **string** |  | [optional] [default to undefined]
+**valueImage** | **string** |  | [optional] [default to undefined]
+**filledAt** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SignatureFieldDTO } from '@openfilz-sdk/typescript';
+
+const instance: SignatureFieldDTO = {
+    id,
+    recipientId,
+    type,
+    page,
+    x,
+    y,
+    w,
+    h,
+    required,
+    label,
+    _options,
+    value,
+    valueImage,
+    filledAt,
+};
+```
+
+[[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/SignatureFieldInput.md

@@ -0,0 +1,36 @@
+# SignatureFieldInput
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **string** |  | [default to undefined]
+**page** | **number** |  | [default to undefined]
+**x** | **number** |  | [default to undefined]
+**y** | **number** |  | [default to undefined]
+**w** | **number** |  | [default to undefined]
+**h** | **number** |  | [default to undefined]
+**required** | **boolean** |  | [optional] [default to undefined]
+**label** | **string** |  | [optional] [default to undefined]
+**_options** | **{ [key: string]: any; }** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SignatureFieldInput } from '@openfilz-sdk/typescript';
+
+const instance: SignatureFieldInput = {
+    type,
+    page,
+    x,
+    y,
+    w,
+    h,
+    required,
+    label,
+    _options,
+};
+```
+
+[[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/SignatureFieldPlacement.md

@@ -0,0 +1,28 @@
+# SignatureFieldPlacement
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**page** | **number** |  | [default to undefined]
+**x** | **number** |  | [default to undefined]
+**y** | **number** |  | [default to undefined]
+**w** | **number** |  | [default to undefined]
+**h** | **number** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { SignatureFieldPlacement } from '@openfilz-sdk/typescript';
+
+const instance: SignatureFieldPlacement = {
+    page,
+    x,
+    y,
+    w,
+    h,
+};
+```
+
+[[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/SignatureFieldValue.md

@@ -0,0 +1,24 @@
+# SignatureFieldValue
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**fieldId** | **string** |  | [default to undefined]
+**value** | **string** |  | [optional] [default to undefined]
+**valueImage** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SignatureFieldValue } from '@openfilz-sdk/typescript';
+
+const instance: SignatureFieldValue = {
+    fieldId,
+    value,
+    valueImage,
+};
+```
+
+[[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/SignatureRecipientDTO.md

@@ -0,0 +1,44 @@
+# SignatureRecipientDTO
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [optional] [default to undefined]
+**userId** | **string** |  | [optional] [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+**email** | **string** |  | [optional] [default to undefined]
+**orderIndex** | **number** |  | [optional] [default to undefined]
+**role** | **string** |  | [optional] [default to undefined]
+**authMethod** | **string** |  | [optional] [default to undefined]
+**status** | **string** |  | [optional] [default to undefined]
+**viewedAt** | **string** |  | [optional] [default to undefined]
+**signedAt** | **string** |  | [optional] [default to undefined]
+**declineReason** | **string** |  | [optional] [default to undefined]
+**reminderCount** | **number** |  | [optional] [default to undefined]
+**fields** | [**Array<SignatureFieldDTO>**](SignatureFieldDTO.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SignatureRecipientDTO } from '@openfilz-sdk/typescript';
+
+const instance: SignatureRecipientDTO = {
+    id,
+    userId,
+    name,
+    email,
+    orderIndex,
+    role,
+    authMethod,
+    status,
+    viewedAt,
+    signedAt,
+    declineReason,
+    reminderCount,
+    fields,
+};
+```
+
+[[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/SignatureRecipientInput.md

@@ -0,0 +1,38 @@
+# SignatureRecipientInput
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**userId** | **string** |  | [optional] [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+**email** | **string** |  | [default to undefined]
+**orderIndex** | **number** |  | [optional] [default to undefined]
+**role** | **string** |  | [optional] [default to undefined]
+**authMethod** | **string** |  | [optional] [default to undefined]
+**phone** | **string** |  | [optional] [default to undefined]
+**locale** | **string** |  | [optional] [default to undefined]
+**fields** | [**Array<SignatureFieldInput>**](SignatureFieldInput.md) |  | [optional] [default to undefined]
+**field** | [**SignatureFieldPlacement**](SignatureFieldPlacement.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SignatureRecipientInput } from '@openfilz-sdk/typescript';
+
+const instance: SignatureRecipientInput = {
+    userId,
+    name,
+    email,
+    orderIndex,
+    role,
+    authMethod,
+    phone,
+    locale,
+    fields,
+    field,
+};
+```
+
+[[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/SignatureTemplateDTO.md

@@ -0,0 +1,42 @@
+# SignatureTemplateDTO
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [optional] [default to undefined]
+**ownerEmail** | **string** |  | [optional] [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+**sourceDocId** | **string** |  | [optional] [default to undefined]
+**roles** | [**Array<SignatureTemplateRole>**](SignatureTemplateRole.md) |  | [optional] [default to undefined]
+**fields** | [**Array<SignatureTemplateField>**](SignatureTemplateField.md) |  | [optional] [default to undefined]
+**message** | **string** |  | [optional] [default to undefined]
+**expiresInDays** | **number** |  | [optional] [default to undefined]
+**sequential** | **boolean** |  | [optional] [default to undefined]
+**createdAt** | **string** |  | [optional] [default to undefined]
+**updatedAt** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SignatureTemplateDTO } from '@openfilz-sdk/typescript';
+
+const instance: SignatureTemplateDTO = {
+    id,
+    ownerEmail,
+    name,
+    description,
+    sourceDocId,
+    roles,
+    fields,
+    message,
+    expiresInDays,
+    sequential,
+    createdAt,
+    updatedAt,
+};
+```
+
+[[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/SignatureTemplateField.md

@@ -0,0 +1,38 @@
+# SignatureTemplateField
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**role** | **string** |  | [default to undefined]
+**type** | **string** |  | [default to undefined]
+**page** | **number** |  | [default to undefined]
+**x** | **number** |  | [default to undefined]
+**y** | **number** |  | [default to undefined]
+**w** | **number** |  | [default to undefined]
+**h** | **number** |  | [default to undefined]
+**required** | **boolean** |  | [optional] [default to undefined]
+**label** | **string** |  | [optional] [default to undefined]
+**_options** | **{ [key: string]: any; }** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SignatureTemplateField } from '@openfilz-sdk/typescript';
+
+const instance: SignatureTemplateField = {
+    role,
+    type,
+    page,
+    x,
+    y,
+    w,
+    h,
+    required,
+    label,
+    _options,
+};
+```
+
+[[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/SignatureTemplateRequest.md

@@ -0,0 +1,34 @@
+# SignatureTemplateRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** |  | [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+**sourceDocId** | **string** |  | [optional] [default to undefined]
+**roles** | [**Array<SignatureTemplateRole>**](SignatureTemplateRole.md) |  | [default to undefined]
+**fields** | [**Array<SignatureTemplateField>**](SignatureTemplateField.md) |  | [default to undefined]
+**message** | **string** |  | [optional] [default to undefined]
+**expiresInDays** | **number** |  | [optional] [default to undefined]
+**sequential** | **boolean** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SignatureTemplateRequest } from '@openfilz-sdk/typescript';
+
+const instance: SignatureTemplateRequest = {
+    name,
+    description,
+    sourceDocId,
+    roles,
+    fields,
+    message,
+    expiresInDays,
+    sequential,
+};
+```
+
+[[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/SignatureTemplateRole.md

@@ -0,0 +1,26 @@
+# SignatureTemplateRole
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** |  | [default to undefined]
+**orderIndex** | **number** |  | [optional] [default to undefined]
+**role** | **string** |  | [optional] [default to undefined]
+**authMethod** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SignatureTemplateRole } from '@openfilz-sdk/typescript';
+
+const instance: SignatureTemplateRole = {
+    name,
+    orderIndex,
+    role,
+    authMethod,
+};
+```
+
+[[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/VerifyOtpRequest.md

@@ -0,0 +1,20 @@
+# VerifyOtpRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { VerifyOtpRequest } from '@openfilz-sdk/typescript';
+
+const instance: VerifyOtpRequest = {
+    code,
+};
+```
+
+[[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/apply-signature-request.ts

@@ -0,0 +1,26 @@
+/* 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 { SignatureFieldValue } from './signature-field-value';
+
+export interface ApplySignatureRequest {
+    'signatureImage'?: string;
+    'typedName'?: string;
+    'fields'?: Array<SignatureFieldValue>;
+    'legacy'?: boolean;
+}
+

package/models/audit-log.ts

@@ -55,6 +55,16 @@ export const AuditLogActionEnum = {
     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;