@openfilz-sdk/typescript-ee 1.8.0 → 1.8.2

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

@@ -0,0 +1,39 @@
+/**
+ * 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 declare const SignatureFieldInputTypeEnum: {
+    readonly Signature: "SIGNATURE";
+    readonly Initials: "INITIALS";
+    readonly DateSigned: "DATE_SIGNED";
+    readonly Text: "TEXT";
+    readonly Number: "NUMBER";
+    readonly Email: "EMAIL";
+    readonly Phone: "PHONE";
+    readonly Checkbox: "CHECKBOX";
+    readonly Radio: "RADIO";
+    readonly Select: "SELECT";
+    readonly Image: "IMAGE";
+    readonly Stamp: "STAMP";
+};
+export type SignatureFieldInputTypeEnum = typeof SignatureFieldInputTypeEnum[keyof typeof SignatureFieldInputTypeEnum];

package/dist/models/signature-field-input.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.SignatureFieldInputTypeEnum = void 0;
+exports.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',
+};

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

@@ -0,0 +1,16 @@
+/**
+ * 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/dist/models/signature-field-value.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

@@ -9,17 +9,33 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+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 declare const SignatureRecipientDTORoleEnum: {
+    readonly Signer: "SIGNER";
+    readonly Cc: "CC";
+};
+export type SignatureRecipientDTORoleEnum = typeof SignatureRecipientDTORoleEnum[keyof typeof SignatureRecipientDTORoleEnum];
+export declare const SignatureRecipientDTOAuthMethodEnum: {
+    readonly None: "NONE";
+    readonly EmailOtp: "EMAIL_OTP";
+    readonly SmsOtp: "SMS_OTP";
+};
+export type SignatureRecipientDTOAuthMethodEnum = typeof SignatureRecipientDTOAuthMethodEnum[keyof typeof SignatureRecipientDTOAuthMethodEnum];
 export declare const SignatureRecipientDTOStatusEnum: {
     readonly Pending: "PENDING";
     readonly Viewed: "VIEWED";

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

@@ -13,7 +13,16 @@
  * Do not edit the class manually.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SignatureRecipientDTOStatusEnum = void 0;
+exports.SignatureRecipientDTOStatusEnum = exports.SignatureRecipientDTOAuthMethodEnum = exports.SignatureRecipientDTORoleEnum = void 0;
+exports.SignatureRecipientDTORoleEnum = {
+    Signer: 'SIGNER',
+    Cc: 'CC',
+};
+exports.SignatureRecipientDTOAuthMethodEnum = {
+    None: 'NONE',
+    EmailOtp: 'EMAIL_OTP',
+    SmsOtp: 'SMS_OTP',
+};
 exports.SignatureRecipientDTOStatusEnum = {
     Pending: 'PENDING',
     Viewed: 'VIEWED',

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

@@ -9,10 +9,28 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import type { SignatureFieldInput } from './signature-field-input';
 import type { SignatureFieldPlacement } from './signature-field-placement';
 export interface SignatureRecipientInput {
     'userId'?: string;
     'name'?: string;
     'email': string;
-    'field': SignatureFieldPlacement;
+    'orderIndex'?: number;
+    'role'?: SignatureRecipientInputRoleEnum;
+    'authMethod'?: SignatureRecipientInputAuthMethodEnum;
+    'phone'?: string;
+    'locale'?: string;
+    'fields'?: Array<SignatureFieldInput>;
+    'field'?: SignatureFieldPlacement;
 }
+export declare const SignatureRecipientInputRoleEnum: {
+    readonly Signer: "SIGNER";
+    readonly Cc: "CC";
+};
+export type SignatureRecipientInputRoleEnum = typeof SignatureRecipientInputRoleEnum[keyof typeof SignatureRecipientInputRoleEnum];
+export declare const SignatureRecipientInputAuthMethodEnum: {
+    readonly None: "NONE";
+    readonly EmailOtp: "EMAIL_OTP";
+    readonly SmsOtp: "SMS_OTP";
+};
+export type SignatureRecipientInputAuthMethodEnum = typeof SignatureRecipientInputAuthMethodEnum[keyof typeof SignatureRecipientInputAuthMethodEnum];

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

@@ -13,3 +13,13 @@
  * Do not edit the class manually.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.SignatureRecipientInputAuthMethodEnum = exports.SignatureRecipientInputRoleEnum = void 0;
+exports.SignatureRecipientInputRoleEnum = {
+    Signer: 'SIGNER',
+    Cc: 'CC',
+};
+exports.SignatureRecipientInputAuthMethodEnum = {
+    None: 'NONE',
+    EmailOtp: 'EMAIL_OTP',
+    SmsOtp: 'SMS_OTP',
+};

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

@@ -0,0 +1,27 @@
+/**
+ * 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 { SignatureTemplateField } from './signature-template-field';
+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;
+}

package/dist/models/signature-template-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-template-field.d.ts

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

package/dist/models/signature-template-field.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.SignatureTemplateFieldTypeEnum = void 0;
+exports.SignatureTemplateFieldTypeEnum = {
+    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',
+};

package/dist/models/signature-template-request.d.ts

@@ -0,0 +1,23 @@
+/**
+ * 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 { SignatureTemplateField } from './signature-template-field';
+import type { SignatureTemplateRole } from './signature-template-role';
+export interface SignatureTemplateRequest {
+    'name': string;
+    'description'?: string;
+    'sourceDocId'?: string;
+    'roles': Array<SignatureTemplateRole>;
+    'fields': Array<SignatureTemplateField>;
+    'message'?: string;
+    'expiresInDays'?: number;
+    'sequential'?: boolean;
+}

package/dist/models/signature-template-request.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-template-role.d.ts

@@ -0,0 +1,28 @@
+/**
+ * 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 SignatureTemplateRole {
+    'name': string;
+    'orderIndex'?: number;
+    'role'?: SignatureTemplateRoleRoleEnum;
+    'authMethod'?: SignatureTemplateRoleAuthMethodEnum;
+}
+export declare const SignatureTemplateRoleRoleEnum: {
+    readonly Signer: "SIGNER";
+    readonly Cc: "CC";
+};
+export type SignatureTemplateRoleRoleEnum = typeof SignatureTemplateRoleRoleEnum[keyof typeof SignatureTemplateRoleRoleEnum];
+export declare const SignatureTemplateRoleAuthMethodEnum: {
+    readonly None: "NONE";
+    readonly EmailOtp: "EMAIL_OTP";
+    readonly SmsOtp: "SMS_OTP";
+};
+export type SignatureTemplateRoleAuthMethodEnum = typeof SignatureTemplateRoleAuthMethodEnum[keyof typeof SignatureTemplateRoleAuthMethodEnum];

package/dist/models/signature-template-role.js

@@ -0,0 +1,25 @@
+"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.SignatureTemplateRoleAuthMethodEnum = exports.SignatureTemplateRoleRoleEnum = void 0;
+exports.SignatureTemplateRoleRoleEnum = {
+    Signer: 'SIGNER',
+    Cc: 'CC',
+};
+exports.SignatureTemplateRoleAuthMethodEnum = {
+    None: 'NONE',
+    EmailOtp: 'EMAIL_OTP',
+    SmsOtp: 'SMS_OTP',
+};

package/dist/models/verify-otp-request.d.ts

@@ -0,0 +1,14 @@
+/**
+ * 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 VerifyOtpRequest {
+    'code': string;
+}

package/dist/models/verify-otp-request.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/AISettingsApi.md

@@ -6,6 +6,7 @@ All URIs are relative to *http://localhost:8081*
 |------------- | ------------- | -------------|
 |[**deleteSettings**](#deletesettings) | **DELETE** /api/v1/settings/ai | Reset my AI settings|
 |[**getSettings1**](#getsettings1) | **GET** /api/v1/settings/ai | Get my AI settings|
+|[**listModels**](#listmodels) | **POST** /api/v1/settings/ai/models | List the provider\'s chat models|
 |[**saveSettings1**](#savesettings1) | **PUT** /api/v1/settings/ai | Save my AI settings|
 |[**testConnection**](#testconnection) | **POST** /api/v1/settings/ai/test | Test AI provider connection|
 
@@ -90,6 +91,58 @@ This endpoint does not have any parameters.
  - **Accept**: application/json
 
 
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+
+[[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)
+
+# **listModels**
+> AiModelsResponse listModels(listAiModelsRequest)
+
+Ask the provider which chat models this key can use, so the picker reflects what exists today rather than a list baked into a release. Falls back to a built-in list (source=FALLBACK) when the provider cannot be reached. POST rather than GET because the key travels in the body, never in a query string; omit apiKey to use the stored key.
+
+### Example
+
+```typescript
+import {
+    AISettingsApi,
+    Configuration,
+    ListAiModelsRequest
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new AISettingsApi(configuration);
+
+let listAiModelsRequest: ListAiModelsRequest; //
+
+const { status, data } = await apiInstance.listModels(
+    listAiModelsRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **listAiModelsRequest** | **ListAiModelsRequest**|  | |
+
+
+### Return type
+
+**AiModelsResponse**
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|

package/docs/AiModelsResponse.md

@@ -0,0 +1,26 @@
+# AiModelsResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**provider** | **string** | Provider the list belongs to | [optional] [default to undefined]
+**models** | **Array<string>** | Model ids, best default first | [optional] [default to undefined]
+**source** | **string** | LIVE or FALLBACK | [optional] [default to undefined]
+**message** | **string** | Why the provider list is unavailable, when source is FALLBACK | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AiModelsResponse } from '@openfilz-sdk/typescript-ee';
+
+const instance: AiModelsResponse = {
+    provider,
+    models,
+    source,
+    message,
+};
+```
+
+[[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/ApplySignatureRequest.md

@@ -7,6 +7,8 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **signatureImage** | **string** |  | [optional] [default to undefined]
 **typedName** | **string** |  | [optional] [default to undefined]
+**fields** | [**Array<SignatureFieldValue>**](SignatureFieldValue.md) |  | [optional] [default to undefined]
+**legacy** | **boolean** |  | [optional] [default to undefined]
 
 ## Example
 
@@ -16,6 +18,8 @@ import { ApplySignatureRequest } from '@openfilz-sdk/typescript-ee';
 const instance: ApplySignatureRequest = {
     signatureImage,
     typedName,
+    fields,
+    legacy,
 };
 ```
 

package/docs/BulkRow.md

@@ -0,0 +1,28 @@
+# BulkRow
+
+
+## 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]
+**locale** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { BulkRow } from '@openfilz-sdk/typescript-ee';
+
+const instance: BulkRow = {
+    sourceDocId,
+    title,
+    message,
+    recipients,
+    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/BulkRowResult.md

@@ -0,0 +1,26 @@
+# BulkRowResult
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**row** | **number** |  | [optional] [default to undefined]
+**envelopeId** | **string** |  | [optional] [default to undefined]
+**status** | **string** |  | [optional] [default to undefined]
+**error** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { BulkRowResult } from '@openfilz-sdk/typescript-ee';
+
+const instance: BulkRowResult = {
+    row,
+    envelopeId,
+    status,
+    error,
+};
+```
+
+[[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/BulkSendRequest.md

@@ -0,0 +1,28 @@
+# BulkSendRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**templateId** | **string** |  | [default to undefined]
+**rows** | [**Array<BulkRow>**](BulkRow.md) |  | [default to undefined]
+**expiresInDays** | **number** |  | [optional] [default to undefined]
+**reminderDays** | **number** |  | [optional] [default to undefined]
+**send** | **boolean** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { BulkSendRequest } from '@openfilz-sdk/typescript-ee';
+
+const instance: BulkSendRequest = {
+    templateId,
+    rows,
+    expiresInDays,
+    reminderDays,
+    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/BulkSendResponse.md

@@ -0,0 +1,26 @@
+# BulkSendResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total** | **number** |  | [optional] [default to undefined]
+**created** | **number** |  | [optional] [default to undefined]
+**failed** | **number** |  | [optional] [default to undefined]
+**results** | [**Array<BulkRowResult>**](BulkRowResult.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { BulkSendResponse } from '@openfilz-sdk/typescript-ee';
+
+const instance: BulkSendResponse = {
+    total,
+    created,
+    failed,
+    results,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)