@openfilz-sdk/typescript 1.2.26 → 1.2.28

package/dist/models/signature-recipient-input.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.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/ApplySignatureRequest.md

@@ -0,0 +1,26 @@
+# ApplySignatureRequest
+
+
+## Properties
+
+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
+
+```typescript
+import { ApplySignatureRequest } from '@openfilz-sdk/typescript';
+
+const instance: ApplySignatureRequest = {
+    signatureImage,
+    typedName,
+    fields,
+    legacy,
+};
+```
+
+[[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,38 @@
+# 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]
+**sequential** | **boolean** |  | [optional] [default to undefined]
+**reminderDays** | **number** |  | [optional] [default to undefined]
+**locale** | **string** |  | [optional] [default to undefined]
+**send** | **boolean** |  | [optional] [default to undefined]
+**templateId** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CreateSignatureEnvelopeRequest } from '@openfilz-sdk/typescript';
+
+const instance: CreateSignatureEnvelopeRequest = {
+    sourceDocId,
+    title,
+    message,
+    recipients,
+    expiresInDays,
+    sequential,
+    reminderDays,
+    locale,
+    send,
+    templateId,
+};
+```
+
+[[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';
+
+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)