@openfilz-sdk/typescript-ee 1.4.4 → 1.5.1

package/docs/DigitalSignatureApi.md

@@ -0,0 +1,300 @@
+# DigitalSignatureApi
+
+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|
+
+# **archive**
+> SignatureArchiveDTO archive()
+
+
+### 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.archive(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**SignatureArchiveDTO**
+
+### 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)
+
+# **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)
+

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/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/SignatureArchiveDTO.md

@@ -0,0 +1,30 @@
+# SignatureArchiveDTO
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pdfaDocId** | **string** |  | [optional] [default to undefined]
+**flavor** | **string** |  | [optional] [default to undefined]
+**compliant** | **boolean** |  | [optional] [default to undefined]
+**status** | **string** |  | [optional] [default to undefined]
+**report** | **string** |  | [optional] [default to undefined]
+**createdAt** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SignatureArchiveDTO } from '@openfilz-sdk/typescript-ee';
+
+const instance: SignatureArchiveDTO = {
+    pdfaDocId,
+    flavor,
+    compliant,
+    status,
+    report,
+    createdAt,
+};
+```
+
+[[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)