@openfilz-sdk/typescript-ee 1.4.3 → 1.5.0

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

@@ -0,0 +1,34 @@
+/**
+ * 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 { 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 declare const SignatureEnvelopeDTOStatusEnum: {
+    readonly Draft: "DRAFT";
+    readonly Sent: "SENT";
+    readonly Completed: "COMPLETED";
+    readonly Declined: "DECLINED";
+    readonly Cancelled: "CANCELLED";
+    readonly Expired: "EXPIRED";
+};
+export type SignatureEnvelopeDTOStatusEnum = typeof SignatureEnvelopeDTOStatusEnum[keyof typeof SignatureEnvelopeDTOStatusEnum];

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

@@ -0,0 +1,24 @@
+"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.SignatureEnvelopeDTOStatusEnum = void 0;
+exports.SignatureEnvelopeDTOStatusEnum = {
+    Draft: 'DRAFT',
+    Sent: 'SENT',
+    Completed: 'COMPLETED',
+    Declined: 'DECLINED',
+    Cancelled: 'CANCELLED',
+    Expired: 'EXPIRED'
+};

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

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

@@ -0,0 +1,29 @@
+/**
+ * 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 declare const SignatureRecipientDTOStatusEnum: {
+    readonly Pending: "PENDING";
+    readonly Viewed: "VIEWED";
+    readonly Signed: "SIGNED";
+    readonly Declined: "DECLINED";
+};
+export type SignatureRecipientDTOStatusEnum = typeof SignatureRecipientDTOStatusEnum[keyof typeof SignatureRecipientDTOStatusEnum];

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

@@ -0,0 +1,22 @@
+"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.SignatureRecipientDTOStatusEnum = void 0;
+exports.SignatureRecipientDTOStatusEnum = {
+    Pending: 'PENDING',
+    Viewed: 'VIEWED',
+    Signed: 'SIGNED',
+    Declined: 'DECLINED'
+};

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

@@ -0,0 +1,18 @@
+/**
+ * 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 { SignatureFieldPlacement } from './signature-field-placement';
+export interface SignatureRecipientInput {
+    'userId'?: string;
+    'name'?: string;
+    'email': string;
+    'field': SignatureFieldPlacement;
+}

package/dist/models/signature-recipient-input.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,22 @@
+# ApplySignatureRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**signatureImage** | **string** |  | [optional] [default to undefined]
+**typedName** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ApplySignatureRequest } from '@openfilz-sdk/typescript-ee';
+
+const instance: ApplySignatureRequest = {
+    signatureImage,
+    typedName,
+};
+```
+
+[[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,28 @@
+# 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]
+
+## Example
+
+```typescript
+import { CreateSignatureEnvelopeRequest } from '@openfilz-sdk/typescript-ee';
+
+const instance: CreateSignatureEnvelopeRequest = {
+    sourceDocId,
+    title,
+    message,
+    recipients,
+    expiresInDays,
+};
+```
+
+[[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-ee';
+
+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)

package/docs/DigitalSignatureApi.md

@@ -0,0 +1,249 @@
+# DigitalSignatureApi
+
+All URIs are relative to *http://localhost:8081*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**cancel**](#cancel) | **POST** /api/v1/signatures/{id}/cancel | Cancel a non-terminal envelope|
+|[**create**](#create) | **POST** /api/v1/signatures | Create and send a signature envelope|
+|[**get1**](#get1) | **GET** /api/v1/signatures/{id} | Get a single envelope I sent|
+|[**listSent**](#listsent) | **GET** /api/v1/signatures | List envelopes I sent for signature|
+|[**listToSign**](#listtosign) | **GET** /api/v1/signatures/to-sign | List documents waiting for my signature|
+
+# **cancel**
+> SignatureEnvelopeDTO cancel()
+
+
+### Example
+
+```typescript
+import {
+    DigitalSignatureApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new DigitalSignatureApi(configuration);
+
+let id: string; // (default to undefined)
+
+const { status, data } = await apiInstance.cancel(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**SignatureEnvelopeDTO**
+
+### 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)
+
+# **create**
+> SignatureEnvelopeDTO create(createSignatureEnvelopeRequest)
+
+
+### Example
+
+```typescript
+import {
+    DigitalSignatureApi,
+    Configuration,
+    CreateSignatureEnvelopeRequest
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new DigitalSignatureApi(configuration);
+
+let createSignatureEnvelopeRequest: CreateSignatureEnvelopeRequest; //
+
+const { status, data } = await apiInstance.create(
+    createSignatureEnvelopeRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **createSignatureEnvelopeRequest** | **CreateSignatureEnvelopeRequest**|  | |
+
+
+### Return type
+
+**SignatureEnvelopeDTO**
+
+### 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)
+
+# **get1**
+> SignatureEnvelopeDTO get1()
+
+
+### Example
+
+```typescript
+import {
+    DigitalSignatureApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new DigitalSignatureApi(configuration);
+
+let id: string; // (default to undefined)
+
+const { status, data } = await apiInstance.get1(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**SignatureEnvelopeDTO**
+
+### 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)
+
+# **listSent**
+> Array<SignatureEnvelopeDTO> listSent()
+
+
+### Example
+
+```typescript
+import {
+    DigitalSignatureApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new DigitalSignatureApi(configuration);
+
+const { status, data } = await apiInstance.listSent();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**Array<SignatureEnvelopeDTO>**
+
+### 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)
+
+# **listToSign**
+> Array<SignatureEnvelopeDTO> listToSign()
+
+
+### Example
+
+```typescript
+import {
+    DigitalSignatureApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new DigitalSignatureApi(configuration);
+
+const { status, data } = await apiInstance.listToSign();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**Array<SignatureEnvelopeDTO>**
+
+### 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)
+