@openfilz-sdk/typescript-ee 1.4.4 → 1.5.1

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

@@ -0,0 +1,36 @@
+# 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]
+**status** | **string** |  | [optional] [default to undefined]
+**viewedAt** | **string** |  | [optional] [default to undefined]
+**signedAt** | **string** |  | [optional] [default to undefined]
+**declineReason** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SignatureRecipientDTO } from '@openfilz-sdk/typescript-ee';
+
+const instance: SignatureRecipientDTO = {
+    id,
+    userId,
+    name,
+    email,
+    orderIndex,
+    status,
+    viewedAt,
+    signedAt,
+    declineReason,
+};
+```
+
+[[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,26 @@
+# SignatureRecipientInput
+
+
+## Properties
+
+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]
+
+## Example
+
+```typescript
+import { SignatureRecipientInput } from '@openfilz-sdk/typescript-ee';
+
+const instance: SignatureRecipientInput = {
+    userId,
+    name,
+    email,
+    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/models/apply-signature-request.ts

@@ -0,0 +1,21 @@
+/* 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 ApplySignatureRequest {
+    'signatureImage'?: string;
+    'typedName'?: string;
+}
+

package/models/create-signature-envelope-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 { SignatureRecipientInput } from './signature-recipient-input';
+
+export interface CreateSignatureEnvelopeRequest {
+    'sourceDocId': string;
+    'title': string;
+    'message'?: string;
+    'recipients': Array<SignatureRecipientInput>;
+    'expiresInDays'?: number;
+}
+

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/enriched-audit-log.ts

@@ -72,7 +72,14 @@ export const EnrichedAuditLogActionEnum = {
     DelegatedGrantConsumed: 'DELEGATED_GRANT_CONSUMED',
     DelegatedGrantSubscriptionRevokedByAdmin: 'DELEGATED_GRANT_SUBSCRIPTION_REVOKED_BY_ADMIN',
     DelegatedBrowse: 'DELEGATED_BROWSE',
-    AdminMonitoringOptOutChanged: 'ADMIN_MONITORING_OPT_OUT_CHANGED'
+    AdminMonitoringOptOutChanged: 'ADMIN_MONITORING_OPT_OUT_CHANGED',
+    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'
 } as const;
 
 export type EnrichedAuditLogActionEnum = typeof EnrichedAuditLogActionEnum[keyof typeof EnrichedAuditLogActionEnum];

package/models/index.ts

@@ -1,4 +1,5 @@
 export * from './ancestor-info';
+export * from './apply-signature-request';
 export * from './audit-log-details';
 export * from './audit-verification-result';
 export * from './broken-link';
@@ -12,8 +13,10 @@ export * from './create-comment-request';
 export * from './create-delegated-grant-request';
 export * from './create-folder-audit';
 export * from './create-folder-request';
+export * from './create-signature-envelope-request';
 export * from './create-team-request';
 export * from './dashboard-statistics-response';
+export * from './decline-signature-request';
 export * from './delegated-folder-node';
 export * from './delegated-grant-dto';
 export * from './delete-audit';
@@ -35,6 +38,7 @@ export * from './mint-upload-token-request';
 export * from './move-audit';
 export * from './move-request';
 export * from './notification-dto';
+export * from './public-signature-view';
 export * from './rename-audit';
 export * from './rename-request';
 export * from './replace-audit';
@@ -49,6 +53,11 @@ export * from './share-request';
 export * from './share-result-error';
 export * from './share-result-item';
 export * from './share-result-response';
+export * from './signature-archive-dto';
+export * from './signature-envelope-dto';
+export * from './signature-field-placement';
+export * from './signature-recipient-dto';
+export * from './signature-recipient-input';
 export * from './sort-input';
 export * from './storage-breakdown';
 export * from './suggest';

package/models/notification-dto.ts

@@ -33,7 +33,10 @@ export const NotificationDTOTypeEnum = {
     VirusDetected: 'VIRUS_DETECTED',
     DelegatedGrantRequested: 'DELEGATED_GRANT_REQUESTED',
     DelegatedGrantConsumed: 'DELEGATED_GRANT_CONSUMED',
-    DelegatedGrantExpired: 'DELEGATED_GRANT_EXPIRED'
+    DelegatedGrantExpired: 'DELEGATED_GRANT_EXPIRED',
+    SignatureRequest: 'SIGNATURE_REQUEST',
+    SignatureCompleted: 'SIGNATURE_COMPLETED',
+    SignatureDeclined: 'SIGNATURE_DECLINED'
 } as const;
 
 export type NotificationDTOTypeEnum = typeof NotificationDTOTypeEnum[keyof typeof NotificationDTOTypeEnum];

package/models/public-signature-view.ts

@@ -0,0 +1,54 @@
+/* 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 PublicSignatureView {
+    'envelopeTitle'?: string;
+    'message'?: string;
+    'initiatorEmail'?: string;
+    'documentName'?: string;
+    'recipientName'?: string;
+    'recipientEmail'?: string;
+    'envelopeStatus'?: PublicSignatureViewEnvelopeStatusEnum;
+    'recipientStatus'?: PublicSignatureViewRecipientStatusEnum;
+    '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];
+
+

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

@@ -85,7 +85,14 @@ export const SearchByAuditLogRequestActionEnum = {
     DelegatedGrantConsumed: 'DELEGATED_GRANT_CONSUMED',
     DelegatedGrantSubscriptionRevokedByAdmin: 'DELEGATED_GRANT_SUBSCRIPTION_REVOKED_BY_ADMIN',
     DelegatedBrowse: 'DELEGATED_BROWSE',
-    AdminMonitoringOptOutChanged: 'ADMIN_MONITORING_OPT_OUT_CHANGED'
+    AdminMonitoringOptOutChanged: 'ADMIN_MONITORING_OPT_OUT_CHANGED',
+    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'
 } as const;
 
 export type SearchByAuditLogRequestActionEnum = typeof SearchByAuditLogRequestActionEnum[keyof typeof SearchByAuditLogRequestActionEnum];

package/models/signature-archive-dto.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 SignatureArchiveDTO {
+    'pdfaDocId'?: string;
+    'flavor'?: string;
+    'compliant'?: boolean;
+    'status'?: string;
+    'report'?: string;
+    'createdAt'?: string;
+}
+

package/models/signature-envelope-dto.ts

@@ -0,0 +1,45 @@
+/* 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;
+    'createdAt'?: 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-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-recipient-dto.ts

@@ -0,0 +1,38 @@
+/* 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 SignatureRecipientDTO {
+    'id'?: string;
+    'userId'?: string;
+    'name'?: string;
+    'email'?: string;
+    'orderIndex'?: number;
+    'status'?: SignatureRecipientDTOStatusEnum;
+    'viewedAt'?: string;
+    'signedAt'?: string;
+    'declineReason'?: string;
+}
+
+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,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 { SignatureFieldPlacement } from './signature-field-placement';
+
+export interface SignatureRecipientInput {
+    'userId'?: string;
+    'name'?: string;
+    'email': string;
+    'field': SignatureFieldPlacement;
+}
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openfilz-sdk/typescript-ee",
-  "version": "1.4.4",
+  "version": "1.5.1",
   "description": "OpenAPI client for @openfilz-sdk/typescript-ee",
   "author": "OpenAPI-Generator Contributors",
   "repository": {