@openfilz-sdk/typescript-ee 1.8.0 → 1.8.2

package/docs/{DigitalSignaturePublicApi.md → ESignPublicApi.md}

@@ -1,4 +1,4 @@
-# DigitalSignaturePublicApi
+# ESignPublicApi
 
 All URIs are relative to *http://localhost:8081*
 
@@ -7,7 +7,9 @@ All URIs are relative to *http://localhost:8081*
 |[**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|
+|[**requestOtp**](#requestotp) | **POST** /api/v1/public/signatures/otp/request | Send a one-time access code to the recipient (EMAIL_OTP / SMS_OTP)|
+|[**sign**](#sign) | **POST** /api/v1/public/signatures/sign | Submit the recipient\'s fields and sign|
+|[**verifyOtp**](#verifyotp) | **POST** /api/v1/public/signatures/otp/verify | Verify the one-time access code|
 |[**view**](#view) | **GET** /api/v1/public/signatures | Resolve a signing token to its envelope view|
 
 # **decline1**
@@ -18,13 +20,13 @@ All URIs are relative to *http://localhost:8081*
 
 ```typescript
 import {
-    DigitalSignaturePublicApi,
+    ESignPublicApi,
     Configuration,
     DeclineSignatureRequest
 } from '@openfilz-sdk/typescript-ee';
 
 const configuration = new Configuration();
-const apiInstance = new DigitalSignaturePublicApi(configuration);
+const apiInstance = new ESignPublicApi(configuration);
 
 let token: string; // (default to undefined)
 let declineSignatureRequest: DeclineSignatureRequest; // (optional)
@@ -72,12 +74,12 @@ const { status, data } = await apiInstance.decline1(
 
 ```typescript
 import {
-    DigitalSignaturePublicApi,
+    ESignPublicApi,
     Configuration
 } from '@openfilz-sdk/typescript-ee';
 
 const configuration = new Configuration();
-const apiInstance = new DigitalSignaturePublicApi(configuration);
+const apiInstance = new ESignPublicApi(configuration);
 
 let token: string; // (default to undefined)
 
@@ -122,12 +124,12 @@ const { status, data } = await apiInstance.document(
 
 ```typescript
 import {
-    DigitalSignaturePublicApi,
+    ESignPublicApi,
     Configuration
 } from '@openfilz-sdk/typescript-ee';
 
 const configuration = new Configuration();
-const apiInstance = new DigitalSignaturePublicApi(configuration);
+const apiInstance = new ESignPublicApi(configuration);
 
 let token: string; // (default to undefined)
 let userAgent: string; // (optional) (default to undefined)
@@ -167,6 +169,56 @@ const { status, data } = await apiInstance.markViewed(
 
 [[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)
 
+# **requestOtp**
+> requestOtp()
+
+
+### Example
+
+```typescript
+import {
+    ESignPublicApi,
+    Configuration
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new ESignPublicApi(configuration);
+
+let token: string; // (default to undefined)
+
+const { status, data } = await apiInstance.requestOtp(
+    token
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **token** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**202** | Accepted |  -  |
+
+[[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)
 
@@ -175,13 +227,13 @@ const { status, data } = await apiInstance.markViewed(
 
 ```typescript
 import {
-    DigitalSignaturePublicApi,
+    ESignPublicApi,
     Configuration,
     ApplySignatureRequest
 } from '@openfilz-sdk/typescript-ee';
 
 const configuration = new Configuration();
-const apiInstance = new DigitalSignaturePublicApi(configuration);
+const apiInstance = new ESignPublicApi(configuration);
 
 let token: string; // (default to undefined)
 let applySignatureRequest: ApplySignatureRequest; //
@@ -203,6 +255,60 @@ const { status, data } = await apiInstance.sign(
 | **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)
+
+# **verifyOtp**
+> PublicSignatureView verifyOtp(verifyOtpRequest)
+
+
+### Example
+
+```typescript
+import {
+    ESignPublicApi,
+    Configuration,
+    VerifyOtpRequest
+} from '@openfilz-sdk/typescript-ee';
+
+const configuration = new Configuration();
+const apiInstance = new ESignPublicApi(configuration);
+
+let token: string; // (default to undefined)
+let verifyOtpRequest: VerifyOtpRequest; //
+
+const { status, data } = await apiInstance.verifyOtp(
+    token,
+    verifyOtpRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **verifyOtpRequest** | **VerifyOtpRequest**|  | |
+| **token** | [**string**] |  | defaults to undefined|
+
+
 ### Return type
 
 **PublicSignatureView**
@@ -232,12 +338,12 @@ const { status, data } = await apiInstance.sign(
 
 ```typescript
 import {
-    DigitalSignaturePublicApi,
+    ESignPublicApi,
     Configuration
 } from '@openfilz-sdk/typescript-ee';
 
 const configuration = new Configuration();
-const apiInstance = new DigitalSignaturePublicApi(configuration);
+const apiInstance = new ESignPublicApi(configuration);
 
 let token: string; // (default to undefined)
 

package/docs/{DigitalSignatureApi.md → ESignTemplatesApi.md}

@@ -1,34 +1,34 @@
-# DigitalSignatureApi
+# ESignTemplatesApi
 
 All URIs are relative to *http://localhost:8081*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
-|[**archive**](#archive) | **GET** /api/v1/signatures/{id}/archive | Get the PDF/A archive + veraPDF compliance for a completed envelope|
-|[**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|
+|[**_delete**](#_delete) | **DELETE** /api/v1/signature-templates/{id} | Delete a template|
+|[**create1**](#create1) | **POST** /api/v1/signature-templates | Create a template|
+|[**get1**](#get1) | **GET** /api/v1/signature-templates/{id} | Get a template|
+|[**instantiate**](#instantiate) | **POST** /api/v1/signature-templates/{id}/envelopes | Create (and send) an envelope from a template|
+|[**list**](#list) | **GET** /api/v1/signature-templates | List my templates|
+|[**update1**](#update1) | **PUT** /api/v1/signature-templates/{id} | Update a template|
 
-# **archive**
-> SignatureArchiveDTO archive()
+# **_delete**
+> _delete()
 
 
 ### Example
 
 ```typescript
 import {
-    DigitalSignatureApi,
+    ESignTemplatesApi,
     Configuration
 } from '@openfilz-sdk/typescript-ee';
 
 const configuration = new Configuration();
-const apiInstance = new DigitalSignatureApi(configuration);
+const apiInstance = new ESignTemplatesApi(configuration);
 
 let id: string; // (default to undefined)
 
-const { status, data } = await apiInstance.archive(
+const { status, data } = await apiInstance._delete(
     id
 );
 ```
@@ -42,7 +42,7 @@ const { status, data } = await apiInstance.archive(
 
 ### Return type
 
-**SignatureArchiveDTO**
+void (empty response body)
 
 ### Authorization
 
@@ -51,35 +51,36 @@ const { status, data } = await apiInstance.archive(
 ### HTTP request headers
 
  - **Content-Type**: Not defined
- - **Accept**: application/json
+ - **Accept**: Not defined
 
 
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-|**200** | OK |  -  |
+|**204** | No Content |  -  |
 
 [[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)
 
-# **cancel**
-> SignatureEnvelopeDTO cancel()
+# **create1**
+> SignatureTemplateDTO create1(signatureTemplateRequest)
 
 
 ### Example
 
 ```typescript
 import {
-    DigitalSignatureApi,
-    Configuration
+    ESignTemplatesApi,
+    Configuration,
+    SignatureTemplateRequest
 } from '@openfilz-sdk/typescript-ee';
 
 const configuration = new Configuration();
-const apiInstance = new DigitalSignatureApi(configuration);
+const apiInstance = new ESignTemplatesApi(configuration);
 
-let id: string; // (default to undefined)
+let signatureTemplateRequest: SignatureTemplateRequest; //
 
-const { status, data } = await apiInstance.cancel(
-    id
+const { status, data } = await apiInstance.create1(
+    signatureTemplateRequest
 );
 ```
 
@@ -87,12 +88,12 @@ const { status, data } = await apiInstance.cancel(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **id** | [**string**] |  | defaults to undefined|
+| **signatureTemplateRequest** | **SignatureTemplateRequest**|  | |
 
 
 ### Return type
 
-**SignatureEnvelopeDTO**
+**SignatureTemplateDTO**
 
 ### Authorization
 
@@ -100,7 +101,7 @@ const { status, data } = await apiInstance.cancel(
 
 ### HTTP request headers
 
- - **Content-Type**: Not defined
+ - **Content-Type**: application/json
  - **Accept**: application/json
 
 
@@ -111,26 +112,25 @@ const { status, data } = await apiInstance.cancel(
 
 [[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)
+# **get1**
+> SignatureTemplateDTO get1()
 
 
 ### Example
 
 ```typescript
 import {
-    DigitalSignatureApi,
-    Configuration,
-    CreateSignatureEnvelopeRequest
+    ESignTemplatesApi,
+    Configuration
 } from '@openfilz-sdk/typescript-ee';
 
 const configuration = new Configuration();
-const apiInstance = new DigitalSignatureApi(configuration);
+const apiInstance = new ESignTemplatesApi(configuration);
 
-let createSignatureEnvelopeRequest: CreateSignatureEnvelopeRequest; //
+let id: string; // (default to undefined)
 
-const { status, data } = await apiInstance.create(
-    createSignatureEnvelopeRequest
+const { status, data } = await apiInstance.get1(
+    id
 );
 ```
 
@@ -138,12 +138,12 @@ const { status, data } = await apiInstance.create(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **createSignatureEnvelopeRequest** | **CreateSignatureEnvelopeRequest**|  | |
+| **id** | [**string**] |  | defaults to undefined|
 
 
 ### Return type
 
-**SignatureEnvelopeDTO**
+**SignatureTemplateDTO**
 
 ### Authorization
 
@@ -151,7 +151,7 @@ const { status, data } = await apiInstance.create(
 
 ### HTTP request headers
 
- - **Content-Type**: application/json
+ - **Content-Type**: Not defined
  - **Accept**: application/json
 
 
@@ -162,25 +162,28 @@ const { status, data } = await apiInstance.create(
 
 [[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()
+# **instantiate**
+> SignatureEnvelopeDTO instantiate(instantiateTemplateRequest)
 
 
 ### Example
 
 ```typescript
 import {
-    DigitalSignatureApi,
-    Configuration
+    ESignTemplatesApi,
+    Configuration,
+    InstantiateTemplateRequest
 } from '@openfilz-sdk/typescript-ee';
 
 const configuration = new Configuration();
-const apiInstance = new DigitalSignatureApi(configuration);
+const apiInstance = new ESignTemplatesApi(configuration);
 
 let id: string; // (default to undefined)
+let instantiateTemplateRequest: InstantiateTemplateRequest; //
 
-const { status, data } = await apiInstance.get1(
-    id
+const { status, data } = await apiInstance.instantiate(
+    id,
+    instantiateTemplateRequest
 );
 ```
 
@@ -188,6 +191,7 @@ const { status, data } = await apiInstance.get1(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
+| **instantiateTemplateRequest** | **InstantiateTemplateRequest**|  | |
 | **id** | [**string**] |  | defaults to undefined|
 
 
@@ -201,7 +205,7 @@ const { status, data } = await apiInstance.get1(
 
 ### HTTP request headers
 
- - **Content-Type**: Not defined
+ - **Content-Type**: application/json
  - **Accept**: application/json
 
 
@@ -212,22 +216,22 @@ const { status, data } = await apiInstance.get1(
 
 [[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()
+# **list**
+> Array<SignatureTemplateDTO> list()
 
 
 ### Example
 
 ```typescript
 import {
-    DigitalSignatureApi,
+    ESignTemplatesApi,
     Configuration
 } from '@openfilz-sdk/typescript-ee';
 
 const configuration = new Configuration();
-const apiInstance = new DigitalSignatureApi(configuration);
+const apiInstance = new ESignTemplatesApi(configuration);
 
-const { status, data } = await apiInstance.listSent();
+const { status, data } = await apiInstance.list();
 ```
 
 ### Parameters
@@ -236,7 +240,7 @@ This endpoint does not have any parameters.
 
 ### Return type
 
-**Array<SignatureEnvelopeDTO>**
+**Array<SignatureTemplateDTO>**
 
 ### Authorization
 
@@ -255,31 +259,42 @@ This endpoint does not have any parameters.
 
 [[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()
+# **update1**
+> SignatureTemplateDTO update1(signatureTemplateRequest)
 
 
 ### Example
 
 ```typescript
 import {
-    DigitalSignatureApi,
-    Configuration
+    ESignTemplatesApi,
+    Configuration,
+    SignatureTemplateRequest
 } from '@openfilz-sdk/typescript-ee';
 
 const configuration = new Configuration();
-const apiInstance = new DigitalSignatureApi(configuration);
+const apiInstance = new ESignTemplatesApi(configuration);
 
-const { status, data } = await apiInstance.listToSign();
+let id: string; // (default to undefined)
+let signatureTemplateRequest: SignatureTemplateRequest; //
+
+const { status, data } = await apiInstance.update1(
+    id,
+    signatureTemplateRequest
+);
 ```
 
 ### Parameters
-This endpoint does not have any parameters.
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **signatureTemplateRequest** | **SignatureTemplateRequest**|  | |
+| **id** | [**string**] |  | defaults to undefined|
 
 
 ### Return type
 
-**Array<SignatureEnvelopeDTO>**
+**SignatureTemplateDTO**
 
 ### Authorization
 
@@ -287,7 +302,7 @@ This endpoint does not have any parameters.
 
 ### HTTP request headers
 
- - **Content-Type**: Not defined
+ - **Content-Type**: application/json
  - **Accept**: application/json
 
 

package/docs/EmbedUrlResponse.md

@@ -0,0 +1,24 @@
+# EmbedUrlResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**recipientId** | **string** |  | [optional] [default to undefined]
+**url** | **string** |  | [optional] [default to undefined]
+**issuedAt** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { EmbedUrlResponse } from '@openfilz-sdk/typescript-ee';
+
+const instance: EmbedUrlResponse = {
+    recipientId,
+    url,
+    issuedAt,
+};
+```
+
+[[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/InstantiateTemplateRequest.md

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

@@ -0,0 +1,24 @@
+# ListAiModelsRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**provider** | **string** | Chat LLM provider | [default to undefined]
+**baseUrl** | **string** | Base URL — required for OPENAI_COMPATIBLE, ignored otherwise | [optional] [default to undefined]
+**apiKey** | **string** | API key (write-only). Omit to use the stored key. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ListAiModelsRequest } from '@openfilz-sdk/typescript-ee';
+
+const instance: ListAiModelsRequest = {
+    provider,
+    baseUrl,
+    apiKey,
+};
+```
+
+[[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/PublicSignatureView.md

@@ -13,6 +13,12 @@ Name | Type | Description | Notes
 **recipientEmail** | **string** |  | [optional] [default to undefined]
 **envelopeStatus** | **string** |  | [optional] [default to undefined]
 **recipientStatus** | **string** |  | [optional] [default to undefined]
+**myTurn** | **boolean** |  | [optional] [default to undefined]
+**authMethod** | **string** |  | [optional] [default to undefined]
+**otpRequired** | **boolean** |  | [optional] [default to undefined]
+**otpVerified** | **boolean** |  | [optional] [default to undefined]
+**fields** | [**Array<SignatureFieldDTO>**](SignatureFieldDTO.md) |  | [optional] [default to undefined]
+**otherFields** | [**Array<SignatureFieldDTO>**](SignatureFieldDTO.md) |  | [optional] [default to undefined]
 **fieldPage** | **number** |  | [optional] [default to undefined]
 **fieldX** | **number** |  | [optional] [default to undefined]
 **fieldY** | **number** |  | [optional] [default to undefined]
@@ -35,6 +41,12 @@ const instance: PublicSignatureView = {
     recipientEmail,
     envelopeStatus,
     recipientStatus,
+    myTurn,
+    authMethod,
+    otpRequired,
+    otpVerified,
+    fields,
+    otherFields,
     fieldPage,
     fieldX,
     fieldY,

package/docs/RoleBinding.md

@@ -0,0 +1,30 @@
+# RoleBinding
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**role** | **string** |  | [default to undefined]
+**userId** | **string** |  | [optional] [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+**email** | **string** |  | [default to undefined]
+**phone** | **string** |  | [optional] [default to undefined]
+**locale** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { RoleBinding } from '@openfilz-sdk/typescript-ee';
+
+const instance: RoleBinding = {
+    role,
+    userId,
+    name,
+    email,
+    phone,
+    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)