@openfilz-sdk/typescript-ee 1.8.0 → 1.8.2

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

@@ -12,7 +12,13 @@ Name | Type | Description | Notes
 **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]
@@ -30,7 +36,13 @@ const instance: SignatureEnvelopeDTO = {
     signedDocId,
     status,
     initiatorEmail,
+    sequential,
+    currentOrder,
+    templateId,
+    reminderDays,
+    sealProvider,
     createdAt,
+    sentAt,
     completedAt,
     expiresAt,
     recipients,

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-ee';
+
+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-ee';
+
+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-ee';
+
+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/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-ee';
+
+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

@@ -10,10 +10,14 @@ Name | Type | Description | Notes
 **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
 
@@ -26,10 +30,14 @@ const instance: SignatureRecipientDTO = {
     name,
     email,
     orderIndex,
+    role,
+    authMethod,
     status,
     viewedAt,
     signedAt,
     declineReason,
+    reminderCount,
+    fields,
 };
 ```
 

package/docs/SignatureRecipientInput.md

@@ -8,7 +8,13 @@ Name | Type | Description | Notes
 **userId** | **string** |  | [optional] [default to undefined]
 **name** | **string** |  | [optional] [default to undefined]
 **email** | **string** |  | [default to undefined]
-**field** | [**SignatureFieldPlacement**](SignatureFieldPlacement.md) |  | [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
 
@@ -19,6 +25,12 @@ const instance: SignatureRecipientInput = {
     userId,
     name,
     email,
+    orderIndex,
+    role,
+    authMethod,
+    phone,
+    locale,
+    fields,
     field,
 };
 ```

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-ee';
+
+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-ee';
+
+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-ee';
+
+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-ee';
+
+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-ee';
+
+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/ai-models-response.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 AiModelsResponse {
+    /**
+     * Provider the list belongs to
+     */
+    'provider'?: AiModelsResponseProviderEnum;
+    /**
+     * Model ids, best default first
+     */
+    'models'?: Array<string>;
+    /**
+     * LIVE or FALLBACK
+     */
+    'source'?: AiModelsResponseSourceEnum;
+    /**
+     * Why the provider list is unavailable, when source is FALLBACK
+     */
+    'message'?: string;
+}
+
+export const AiModelsResponseProviderEnum = {
+    Openai: 'OPENAI',
+    Anthropic: 'ANTHROPIC',
+    Google: 'GOOGLE',
+    OpenaiCompatible: 'OPENAI_COMPATIBLE',
+} as const;
+
+export type AiModelsResponseProviderEnum = typeof AiModelsResponseProviderEnum[keyof typeof AiModelsResponseProviderEnum];
+export const AiModelsResponseSourceEnum = {
+    Live: 'LIVE',
+    Fallback: 'FALLBACK',
+} as const;
+
+export type AiModelsResponseSourceEnum = typeof AiModelsResponseSourceEnum[keyof typeof AiModelsResponseSourceEnum];
+
+

package/models/apply-signature-request.ts

@@ -13,9 +13,14 @@
  */
 
 
+// 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/bulk-row-result.ts

@@ -0,0 +1,23 @@
+/* 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 BulkRowResult {
+    'row'?: number;
+    'envelopeId'?: string;
+    'status'?: string;
+    'error'?: string;
+}
+

package/models/bulk-row.ts

@@ -0,0 +1,27 @@
+/* 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 BulkRow {
+    'sourceDocId'?: string;
+    'title'?: string;
+    'message'?: string;
+    'recipients': Array<RoleBinding>;
+    'locale'?: string;
+}
+

package/models/bulk-send-request.ts

@@ -0,0 +1,27 @@
+/* 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 { BulkRow } from './bulk-row';
+
+export interface BulkSendRequest {
+    'templateId': string;
+    'rows': Array<BulkRow>;
+    'expiresInDays'?: number;
+    'reminderDays'?: number;
+    'send'?: boolean;
+}
+

package/models/bulk-send-response.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 { BulkRowResult } from './bulk-row-result';
+
+export interface BulkSendResponse {
+    'total'?: number;
+    'created'?: number;
+    'failed'?: number;
+    'results'?: Array<BulkRowResult>;
+}
+

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

@@ -23,5 +23,10 @@ export interface CreateSignatureEnvelopeRequest {
     'message'?: string;
     'recipients': Array<SignatureRecipientInput>;
     'expiresInDays'?: number;
+    'sequential'?: boolean;
+    'reminderDays'?: number;
+    'locale'?: string;
+    'send'?: boolean;
+    'templateId'?: string;
 }
 

package/models/embed-url-response.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 EmbedUrlResponse {
+    'recipientId'?: string;
+    'url'?: string;
+    'issuedAt'?: string;
+}
+

package/models/enriched-audit-log.ts

@@ -81,6 +81,9 @@ export const EnrichedAuditLogActionEnum = {
     SignatureEnvelopeDeclined: 'SIGNATURE_ENVELOPE_DECLINED',
     SignatureEnvelopeCancelled: 'SIGNATURE_ENVELOPE_CANCELLED',
     SignatureEnvelopeExpired: 'SIGNATURE_ENVELOPE_EXPIRED',
+    SignatureReminderSent: 'SIGNATURE_REMINDER_SENT',
+    SignatureTemplateCreated: 'SIGNATURE_TEMPLATE_CREATED',
+    SignatureTemplateDeleted: 'SIGNATURE_TEMPLATE_DELETED',
 } as const;
 
 export type EnrichedAuditLogActionEnum = typeof EnrichedAuditLogActionEnum[keyof typeof EnrichedAuditLogActionEnum];