@openfilz-sdk/typescript 1.2.27 → 1.2.28

package/docs/ESignPublicApi.md

@@ -0,0 +1,382 @@
+# ESignPublicApi
+
+All URIs are relative to *http://localhost:8081*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**decline**](#decline) | **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|
+|[**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|
+
+# **decline**
+> PublicSignatureView decline()
+
+
+### Example
+
+```typescript
+import {
+    ESignPublicApi,
+    Configuration,
+    DeclineSignatureRequest
+} from '@openfilz-sdk/typescript';
+
+const configuration = new Configuration();
+const apiInstance = new ESignPublicApi(configuration);
+
+let token: string; // (default to undefined)
+let declineSignatureRequest: DeclineSignatureRequest; // (optional)
+
+const { status, data } = await apiInstance.decline(
+    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 {
+    ESignPublicApi,
+    Configuration
+} from '@openfilz-sdk/typescript';
+
+const configuration = new Configuration();
+const apiInstance = new ESignPublicApi(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 {
+    ESignPublicApi,
+    Configuration
+} from '@openfilz-sdk/typescript';
+
+const configuration = new Configuration();
+const apiInstance = new ESignPublicApi(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)
+
+# **requestOtp**
+> requestOtp()
+
+
+### Example
+
+```typescript
+import {
+    ESignPublicApi,
+    Configuration
+} from '@openfilz-sdk/typescript';
+
+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)
+
+
+### Example
+
+```typescript
+import {
+    ESignPublicApi,
+    Configuration,
+    ApplySignatureRequest
+} from '@openfilz-sdk/typescript';
+
+const configuration = new Configuration();
+const apiInstance = new ESignPublicApi(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)
+
+# **verifyOtp**
+> PublicSignatureView verifyOtp(verifyOtpRequest)
+
+
+### Example
+
+```typescript
+import {
+    ESignPublicApi,
+    Configuration,
+    VerifyOtpRequest
+} from '@openfilz-sdk/typescript';
+
+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**
+
+### 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 {
+    ESignPublicApi,
+    Configuration
+} from '@openfilz-sdk/typescript';
+
+const configuration = new Configuration();
+const apiInstance = new ESignPublicApi(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/ESignTemplatesApi.md

@@ -0,0 +1,315 @@
+# ESignTemplatesApi
+
+All URIs are relative to *http://localhost:8081*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**_delete**](#_delete) | **DELETE** /api/v1/signature-templates/{id} | Delete a template|
+|[**create1**](#create1) | **POST** /api/v1/signature-templates | Create a template|
+|[**get**](#get) | **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|
+|[**update**](#update) | **PUT** /api/v1/signature-templates/{id} | Update a template|
+
+# **_delete**
+> _delete()
+
+
+### Example
+
+```typescript
+import {
+    ESignTemplatesApi,
+    Configuration
+} from '@openfilz-sdk/typescript';
+
+const configuration = new Configuration();
+const apiInstance = new ESignTemplatesApi(configuration);
+
+let id: string; // (default to undefined)
+
+const { status, data } = await apiInstance._delete(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**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 |
+|-------------|-------------|------------------|
+|**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)
+
+# **create1**
+> SignatureTemplateDTO create1(signatureTemplateRequest)
+
+
+### Example
+
+```typescript
+import {
+    ESignTemplatesApi,
+    Configuration,
+    SignatureTemplateRequest
+} from '@openfilz-sdk/typescript';
+
+const configuration = new Configuration();
+const apiInstance = new ESignTemplatesApi(configuration);
+
+let signatureTemplateRequest: SignatureTemplateRequest; //
+
+const { status, data } = await apiInstance.create1(
+    signatureTemplateRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **signatureTemplateRequest** | **SignatureTemplateRequest**|  | |
+
+
+### Return type
+
+**SignatureTemplateDTO**
+
+### 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)
+
+# **get**
+> SignatureTemplateDTO get()
+
+
+### Example
+
+```typescript
+import {
+    ESignTemplatesApi,
+    Configuration
+} from '@openfilz-sdk/typescript';
+
+const configuration = new Configuration();
+const apiInstance = new ESignTemplatesApi(configuration);
+
+let id: string; // (default to undefined)
+
+const { status, data } = await apiInstance.get(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**SignatureTemplateDTO**
+
+### 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)
+
+# **instantiate**
+> SignatureEnvelopeDTO instantiate(instantiateTemplateRequest)
+
+
+### Example
+
+```typescript
+import {
+    ESignTemplatesApi,
+    Configuration,
+    InstantiateTemplateRequest
+} from '@openfilz-sdk/typescript';
+
+const configuration = new Configuration();
+const apiInstance = new ESignTemplatesApi(configuration);
+
+let id: string; // (default to undefined)
+let instantiateTemplateRequest: InstantiateTemplateRequest; //
+
+const { status, data } = await apiInstance.instantiate(
+    id,
+    instantiateTemplateRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **instantiateTemplateRequest** | **InstantiateTemplateRequest**|  | |
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### 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)
+
+# **list**
+> Array<SignatureTemplateDTO> list()
+
+
+### Example
+
+```typescript
+import {
+    ESignTemplatesApi,
+    Configuration
+} from '@openfilz-sdk/typescript';
+
+const configuration = new Configuration();
+const apiInstance = new ESignTemplatesApi(configuration);
+
+const { status, data } = await apiInstance.list();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**Array<SignatureTemplateDTO>**
+
+### 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)
+
+# **update**
+> SignatureTemplateDTO update(signatureTemplateRequest)
+
+
+### Example
+
+```typescript
+import {
+    ESignTemplatesApi,
+    Configuration,
+    SignatureTemplateRequest
+} from '@openfilz-sdk/typescript';
+
+const configuration = new Configuration();
+const apiInstance = new ESignTemplatesApi(configuration);
+
+let id: string; // (default to undefined)
+let signatureTemplateRequest: SignatureTemplateRequest; //
+
+const { status, data } = await apiInstance.update(
+    id,
+    signatureTemplateRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **signatureTemplateRequest** | **SignatureTemplateRequest**|  | |
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**SignatureTemplateDTO**
+
+### 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)
+