@openfilz-sdk/typescript-ee 1.4.3 → 1.5.0

package/docs/DigitalSignaturePublicApi.md

@@ -0,0 +1,276 @@
+# DigitalSignaturePublicApi
+
+All URIs are relative to *http://localhost:8081*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**decline1**](#decline1) | **POST** /api/v1/public/signatures/decline | Decline to sign (voids the envelope)|
+|[**document**](#document) | **GET** /api/v1/public/signatures/document | Stream the source PDF for signing|
+|[**markViewed**](#markviewed) | **POST** /api/v1/public/signatures/viewed | Record that the recipient opened the document|
+|[**sign**](#sign) | **POST** /api/v1/public/signatures/sign | Apply the recipient\'s signature|
+|[**view**](#view) | **GET** /api/v1/public/signatures | Resolve a signing token to its envelope view|
+
+# **decline1**
+> PublicSignatureView decline1()
+
+
+### Example
+
+```typescript
+import {
+    DigitalSignaturePublicApi,
+    Configuration,
+    DeclineSignatureRequest
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new DigitalSignaturePublicApi(configuration);
+
+let token: string; // (default to undefined)
+let declineSignatureRequest: DeclineSignatureRequest; // (optional)
+
+const { status, data } = await apiInstance.decline1(
+    token,
+    declineSignatureRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **declineSignatureRequest** | **DeclineSignatureRequest**|  | |
+| **token** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**PublicSignatureView**
+
+### 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 |
+|-------------|-------------|------------------|
+|**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)
+
+# **document**
+> File document()
+
+
+### Example
+
+```typescript
+import {
+    DigitalSignaturePublicApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new DigitalSignaturePublicApi(configuration);
+
+let token: string; // (default to undefined)
+
+const { status, data } = await apiInstance.document(
+    token
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **token** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**File**
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/pdf
+
+
+### 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)
+
+# **markViewed**
+> PublicSignatureView markViewed()
+
+
+### Example
+
+```typescript
+import {
+    DigitalSignaturePublicApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new DigitalSignaturePublicApi(configuration);
+
+let token: string; // (default to undefined)
+let userAgent: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.markViewed(
+    token,
+    userAgent
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **token** | [**string**] |  | defaults to undefined|
+| **userAgent** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**PublicSignatureView**
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **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)
+
+# **sign**
+> PublicSignatureView sign(applySignatureRequest)
+
+
+### Example
+
+```typescript
+import {
+    DigitalSignaturePublicApi,
+    Configuration,
+    ApplySignatureRequest
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new DigitalSignaturePublicApi(configuration);
+
+let token: string; // (default to undefined)
+let applySignatureRequest: ApplySignatureRequest; //
+let userAgent: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.sign(
+    token,
+    applySignatureRequest,
+    userAgent
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **applySignatureRequest** | **ApplySignatureRequest**|  | |
+| **token** | [**string**] |  | defaults to undefined|
+| **userAgent** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**PublicSignatureView**
+
+### 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 |
+|-------------|-------------|------------------|
+|**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)
+
+# **view**
+> PublicSignatureView view()
+
+
+### Example
+
+```typescript
+import {
+    DigitalSignaturePublicApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new DigitalSignaturePublicApi(configuration);
+
+let token: string; // (default to undefined)
+
+const { status, data } = await apiInstance.view(
+    token
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **token** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**PublicSignatureView**
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **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)
+

package/docs/MintUploadTokenRequest.md

@@ -9,6 +9,7 @@ Name | Type | Description | Notes
 **maxSizeBytes** | **number** |  | [optional] [default to undefined]
 **allowedMimeTypes** | **Array<string>** |  | [default to undefined]
 **ttlSeconds** | **number** |  | [optional] [default to undefined]
+**allowDuplicateFileNames** | **boolean** |  | [optional] [default to undefined]
 
 ## Example
 
@@ -20,6 +21,7 @@ const instance: MintUploadTokenRequest = {
     maxSizeBytes,
     allowedMimeTypes,
     ttlSeconds,
+    allowDuplicateFileNames,
 };
 ```
 

package/docs/PublicSignatureView.md

@@ -0,0 +1,48 @@
+# 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]
+**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-ee';
+
+const instance: PublicSignatureView = {
+    envelopeTitle,
+    message,
+    initiatorEmail,
+    documentName,
+    recipientName,
+    recipientEmail,
+    envelopeStatus,
+    recipientStatus,
+    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/SignatureEnvelopeDTO.md

@@ -0,0 +1,40 @@
+# 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]
+**createdAt** | **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-ee';
+
+const instance: SignatureEnvelopeDTO = {
+    id,
+    title,
+    message,
+    sourceDocId,
+    signedDocId,
+    status,
+    initiatorEmail,
+    createdAt,
+    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/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,10 @@ export * from './share-request';
 export * from './share-result-error';
 export * from './share-result-item';
 export * from './share-result-response';
+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/mint-upload-token-request.ts

@@ -19,5 +19,6 @@ export interface MintUploadTokenRequest {
     'maxSizeBytes'?: number;
     'allowedMimeTypes': Array<string>;
     'ttlSeconds'?: number;
+    'allowDuplicateFileNames'?: boolean;
 }
 

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];