# ESignApi

All URIs are relative to *http://localhost:8081*

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**cancel1**](#cancel1) | **POST** /api/v1/signatures/{id}/cancel | Cancel a non-terminal envelope|
|[**cloudSubscription**](#cloudsubscription) | **GET** /api/v1/signatures/cloud-subscription | Cloud Signing subscription and month-to-date usage (openfilz-cloud seal provider only)|
|[**create**](#create) | **POST** /api/v1/signatures | Create an envelope (sent immediately unless send=false)|
|[**events**](#events) | **GET** /api/v1/signatures/{id}/events | Audit trail of one of my envelopes|
|[**get2**](#get2) | **GET** /api/v1/signatures/{id} | Get one of my envelopes (recipients + fields)|
|[**listSent**](#listsent) | **GET** /api/v1/signatures | List envelopes I sent for signature|
|[**listToSign**](#listtosign) | **GET** /api/v1/signatures/to-sign | List envelopes waiting for my signature|
|[**resend**](#resend) | **POST** /api/v1/signatures/{id}/recipients/{recipientId}/resend | Resend the signing link to a recipient (new token, previous one revoked)|
|[**send**](#send) | **POST** /api/v1/signatures/{id}/send | Send a DRAFT envelope|
|[**signedDocument**](#signeddocument) | **GET** /api/v1/signatures/{id}/signed-document | Download the sealed PDF of a completed envelope|

# **cancel1**
> SignatureEnvelopeDTO cancel1()


### Example

```typescript
import {
    ESignApi,
    Configuration
} from '@openfilz-sdk/typescript';

const configuration = new Configuration();
const apiInstance = new ESignApi(configuration);

let id: string; // (default to undefined)

const { status, data } = await apiInstance.cancel1(
    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)

# **cloudSubscription**
> CloudSignatureSubscription cloudSubscription()


### Example

```typescript
import {
    ESignApi,
    Configuration
} from '@openfilz-sdk/typescript';

const configuration = new Configuration();
const apiInstance = new ESignApi(configuration);

const { status, data } = await apiInstance.cloudSubscription();
```

### Parameters
This endpoint does not have any parameters.


### Return type

**CloudSignatureSubscription**

### 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 {
    ESignApi,
    Configuration,
    CreateSignatureEnvelopeRequest
} from '@openfilz-sdk/typescript';

const configuration = new Configuration();
const apiInstance = new ESignApi(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)

# **events**
> Array<SignatureEventDTO> events()


### Example

```typescript
import {
    ESignApi,
    Configuration
} from '@openfilz-sdk/typescript';

const configuration = new Configuration();
const apiInstance = new ESignApi(configuration);

let id: string; // (default to undefined)

const { status, data } = await apiInstance.events(
    id
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **id** | [**string**] |  | defaults to undefined|


### Return type

**Array<SignatureEventDTO>**

### 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)

# **get2**
> SignatureEnvelopeDTO get2()


### Example

```typescript
import {
    ESignApi,
    Configuration
} from '@openfilz-sdk/typescript';

const configuration = new Configuration();
const apiInstance = new ESignApi(configuration);

let id: string; // (default to undefined)

const { status, data } = await apiInstance.get2(
    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 {
    ESignApi,
    Configuration
} from '@openfilz-sdk/typescript';

const configuration = new Configuration();
const apiInstance = new ESignApi(configuration);

let status: 'DRAFT' | 'SENT' | 'COMPLETED' | 'DECLINED' | 'CANCELLED' | 'EXPIRED'; // (optional) (default to undefined)

const { status, data } = await apiInstance.listSent(
    status
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **status** | [**&#39;DRAFT&#39; | &#39;SENT&#39; | &#39;COMPLETED&#39; | &#39;DECLINED&#39; | &#39;CANCELLED&#39; | &#39;EXPIRED&#39;**]**Array<&#39;DRAFT&#39; &#124; &#39;SENT&#39; &#124; &#39;COMPLETED&#39; &#124; &#39;DECLINED&#39; &#124; &#39;CANCELLED&#39; &#124; &#39;EXPIRED&#39;>** |  | (optional) defaults to undefined|


### 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 {
    ESignApi,
    Configuration
} from '@openfilz-sdk/typescript';

const configuration = new Configuration();
const apiInstance = new ESignApi(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)

# **resend**
> SignatureEnvelopeDTO resend()


### Example

```typescript
import {
    ESignApi,
    Configuration
} from '@openfilz-sdk/typescript';

const configuration = new Configuration();
const apiInstance = new ESignApi(configuration);

let id: string; // (default to undefined)
let recipientId: string; // (default to undefined)

const { status, data } = await apiInstance.resend(
    id,
    recipientId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **id** | [**string**] |  | defaults to undefined|
| **recipientId** | [**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)

# **send**
> SignatureEnvelopeDTO send()


### Example

```typescript
import {
    ESignApi,
    Configuration
} from '@openfilz-sdk/typescript';

const configuration = new Configuration();
const apiInstance = new ESignApi(configuration);

let id: string; // (default to undefined)

const { status, data } = await apiInstance.send(
    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)

# **signedDocument**
> File signedDocument()


### Example

```typescript
import {
    ESignApi,
    Configuration
} from '@openfilz-sdk/typescript';

const configuration = new Configuration();
const apiInstance = new ESignApi(configuration);

let id: string; // (default to undefined)

const { status, data } = await apiInstance.signedDocument(
    id
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **id** | [**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)