> ## Documentation Index
> Fetch the complete documentation index at: https://apidoc.sign.plus/llms.txt
> Use this file to discover all available pages before exploring further.

# Sdk reference

A list of all methods in the `SignplusService` service. Click on the method name to view detailed information about that method.

| Methods                                                                             | Description                                                     |
| :---------------------------------------------------------------------------------- | :-------------------------------------------------------------- |
| [CreateEnvelopeAsync](#createenvelopeasync)                                         | Create new envelope                                             |
| [CreateEnvelopeFromTemplateAsync](#createenvelopefromtemplateasync)                 | Create new envelope from template                               |
| [ListEnvelopesAsync](#listenvelopesasync)                                           | List envelopes                                                  |
| [GetEnvelopeAsync](#getenvelopeasync)                                               | Get envelope                                                    |
| [DeleteEnvelopeAsync](#deleteenvelopeasync)                                         | Delete envelope                                                 |
| [DownloadEnvelopeSignedDocumentsAsync](#downloadenvelopesigneddocumentsasync)       | Download signed documents for an envelope                       |
| [DownloadEnvelopeCertificateAsync](#downloadenvelopecertificateasync)               | Download certificate of completion for an envelope              |
| [GetEnvelopeDocumentAsync](#getenvelopedocumentasync)                               | Get envelope document                                           |
| [GetEnvelopeDocumentsAsync](#getenvelopedocumentsasync)                             | Get envelope documents                                          |
| [AddEnvelopeDocumentAsync](#addenvelopedocumentasync)                               | Add envelope document                                           |
| [SetEnvelopeDynamicFieldsAsync](#setenvelopedynamicfieldsasync)                     | Set envelope dynamic fields                                     |
| [AddEnvelopeSigningStepsAsync](#addenvelopesigningstepsasync)                       | Add envelope signing steps                                      |
| [SetEnvelopeAttachmentsSettingsAsync](#setenvelopeattachmentssettingsasync)         | Set envelope attachment settings                                |
| [SetEnvelopeAttachmentsPlaceholdersAsync](#setenvelopeattachmentsplaceholdersasync) | Placeholders to be set, completely replacing the existing ones. |
| [GetAttachmentFileAsync](#getattachmentfileasync)                                   | Get envelope attachment file                                    |
| [SendEnvelopeAsync](#sendenvelopeasync)                                             | Send envelope for signature                                     |
| [DuplicateEnvelopeAsync](#duplicateenvelopeasync)                                   | Duplicate envelope                                              |
| [VoidEnvelopeAsync](#voidenvelopeasync)                                             | Void envelope                                                   |
| [RenameEnvelopeAsync](#renameenvelopeasync)                                         | Rename envelope                                                 |
| [SetEnvelopeCommentAsync](#setenvelopecommentasync)                                 | Set envelope comment                                            |
| [SetEnvelopeNotificationAsync](#setenvelopenotificationasync)                       | Set envelope notification                                       |
| [SetEnvelopeExpirationDateAsync](#setenvelopeexpirationdateasync)                   | Set envelope expiration date                                    |
| [SetEnvelopeLegalityLevelAsync](#setenvelopelegalitylevelasync)                     | Set envelope legality level                                     |
| [GetEnvelopeAnnotationsAsync](#getenvelopeannotationsasync)                         | Get envelope annotations                                        |
| [GetEnvelopeDocumentAnnotationsAsync](#getenvelopedocumentannotationsasync)         | Get envelope document annotations                               |
| [AddEnvelopeAnnotationAsync](#addenvelopeannotationasync)                           | Add envelope annotation                                         |
| [DeleteEnvelopeAnnotationAsync](#deleteenvelopeannotationasync)                     | Delete envelope annotation                                      |
| [CreateTemplateAsync](#createtemplateasync)                                         | Create new template                                             |
| [ListTemplatesAsync](#listtemplatesasync)                                           | List templates                                                  |
| [GetTemplateAsync](#gettemplateasync)                                               | Get template                                                    |
| [DeleteTemplateAsync](#deletetemplateasync)                                         | Delete template                                                 |
| [DuplicateTemplateAsync](#duplicatetemplateasync)                                   | Duplicate template                                              |
| [AddTemplateDocumentAsync](#addtemplatedocumentasync)                               | Add template document                                           |
| [GetTemplateDocumentAsync](#gettemplatedocumentasync)                               | Get template document                                           |
| [GetTemplateDocumentsAsync](#gettemplatedocumentsasync)                             | Get template documents                                          |
| [AddTemplateSigningStepsAsync](#addtemplatesigningstepsasync)                       | Add template signing steps                                      |
| [RenameTemplateAsync](#renametemplateasync)                                         | Rename template                                                 |
| [SetTemplateCommentAsync](#settemplatecommentasync)                                 | Set template comment                                            |
| [SetTemplateNotificationAsync](#settemplatenotificationasync)                       | Set template notification                                       |
| [GetTemplateAnnotationsAsync](#gettemplateannotationsasync)                         | Get template annotations                                        |
| [GetDocumentTemplateAnnotationsAsync](#getdocumenttemplateannotationsasync)         | Get document template annotations                               |
| [AddTemplateAnnotationAsync](#addtemplateannotationasync)                           | Add template annotation                                         |
| [DeleteTemplateAnnotationAsync](#deletetemplateannotationasync)                     | Delete template annotation                                      |
| [SetTemplateAttachmentsSettingsAsync](#settemplateattachmentssettingsasync)         | Set template attachment settings                                |
| [SetTemplateAttachmentsPlaceholdersAsync](#settemplateattachmentsplaceholdersasync) | Placeholders to be set, completely replacing the existing ones. |
| [CreateWebhookAsync](#createwebhookasync)                                           | Create webhook                                                  |
| [ListWebhooksAsync](#listwebhooksasync)                                             | List webhooks                                                   |
| [DeleteWebhookAsync](#deletewebhookasync)                                           | Delete webhook                                                  |

## CreateEnvelopeAsync

Create new envelope

* HTTP Method: `POST`
* Endpoint: `/envelope`

**Parameters**

| Name  | Type                                                                           | Required | Description       |
| :---- | :----------------------------------------------------------------------------- | :------- | :---------------- |
| input | [CreateEnvelopeRequest](/api-reference/endpoints/signplus/create-new-envelope) | ✅        | The request body. |

**Return Type**

`Envelope`

**Example Usage Code Snippet**

```csharp theme={null}
using Alohi.Signplus;
using Alohi.Signplus.Config;
using Alohi.Signplus.Models;

var config = new SignplusConfig{};

var client = new SignplusClient(config);

var input = new CreateEnvelopeRequest("name", EnvelopeLegalityLevel.Ses, 8, "comment", false);

var response = await client.Signplus.CreateEnvelopeAsync(input);

Console.WriteLine(response);
```

## CreateEnvelopeFromTemplateAsync

Create new envelope from template

* HTTP Method: `POST`
* Endpoint: `/envelope/from_template/{template_id}`

**Parameters**

| Name       | Type                                                                                                     | Required | Description       |
| :--------- | :------------------------------------------------------------------------------------------------------- | :------- | :---------------- |
| input      | [CreateEnvelopeFromTemplateRequest](/api-reference/endpoints/signplus/create-new-envelope-from-template) | ✅        | The request body. |
| templateId | string                                                                                                   | ✅        |                   |

**Return Type**

`Envelope`

**Example Usage Code Snippet**

```csharp theme={null}
using Alohi.Signplus;
using Alohi.Signplus.Config;
using Alohi.Signplus.Models;

var config = new SignplusConfig{};

var client = new SignplusClient(config);

var input = new CreateEnvelopeFromTemplateRequest("name", "comment", true);

var response = await client.Signplus.CreateEnvelopeFromTemplateAsync(input, "template_id");

Console.WriteLine(response);
```

## ListEnvelopesAsync

List envelopes

* HTTP Method: `POST`
* Endpoint: `/envelopes`

**Parameters**

| Name  | Type                                                                     | Required | Description       |
| :---- | :----------------------------------------------------------------------- | :------- | :---------------- |
| input | [ListEnvelopesRequest](/api-reference/endpoints/signplus/list-envelopes) | ❌        | The request body. |

**Return Type**

`ListEnvelopesResponse`

**Example Usage Code Snippet**

```csharp theme={null}
using Alohi.Signplus;
using Alohi.Signplus.Config;
using Alohi.Signplus.Models;

var config = new SignplusConfig{};

var client = new SignplusClient(config);

var tags = new List<string>() { "tags" };
var ids = new List<string>() { "ids" };
var statuses = new List<EnvelopeStatus>() { EnvelopeStatus.Draft };
var folderIds = new List<string>() { "folder_ids" };
var input = new ListEnvelopesRequest("name", tags, "comment", ids, statuses, folderIds, true, 5, 9, "uid", 9, 7, "after", "before", EnvelopeOrderField.CreationDate, true, true);

var response = await client.Signplus.ListEnvelopesAsync(input);

Console.WriteLine(response);
```

## GetEnvelopeAsync

Get envelope

* HTTP Method: `GET`
* Endpoint: `/envelope/{envelope_id}`

**Parameters**

| Name       | Type   | Required | Description |
| :--------- | :----- | :------- | :---------- |
| envelopeId | string | ✅        |             |

**Return Type**

`Envelope`

**Example Usage Code Snippet**

```csharp theme={null}
using Alohi.Signplus;
using Alohi.Signplus.Config;

var config = new SignplusConfig{};

var client = new SignplusClient(config);

var response = await client.Signplus.GetEnvelopeAsync("envelope_id");

Console.WriteLine(response);
```

## DeleteEnvelopeAsync

Delete envelope

* HTTP Method: `DELETE`
* Endpoint: `/envelope/{envelope_id}`

**Parameters**

| Name       | Type   | Required | Description |
| :--------- | :----- | :------- | :---------- |
| envelopeId | string | ✅        |             |

**Example Usage Code Snippet**

```csharp theme={null}
using Alohi.Signplus;
using Alohi.Signplus.Config;

var config = new SignplusConfig{};

var client = new SignplusClient(config);

await client.Signplus.DeleteEnvelopeAsync("envelope_id");
```

## DownloadEnvelopeSignedDocumentsAsync

Download signed documents for an envelope

* HTTP Method: `GET`
* Endpoint: `/envelope/{envelope_id}/signed_documents`

**Parameters**

| Name                    | Type   | Required | Description                                                             |
| :---------------------- | :----- | :------- | :---------------------------------------------------------------------- |
| envelopeId              | string | ✅        | ID of the envelope                                                      |
| certificateOfCompletion | bool   | ❌        | Whether to include the certificate of completion in the downloaded file |

**Return Type**

`byte[]`

**Example Usage Code Snippet**

```csharp theme={null}
using Alohi.Signplus;
using Alohi.Signplus.Config;

var config = new SignplusConfig{};

var client = new SignplusClient(config);

var response = await client.Signplus.DownloadEnvelopeSignedDocumentsAsync("envelope_id", true);

Console.WriteLine(response);
```

## DownloadEnvelopeCertificateAsync

Download certificate of completion for an envelope

* HTTP Method: `GET`
* Endpoint: `/envelope/{envelope_id}/certificate`

**Parameters**

| Name       | Type   | Required | Description        |
| :--------- | :----- | :------- | :----------------- |
| envelopeId | string | ✅        | ID of the envelope |

**Return Type**

`byte[]`

**Example Usage Code Snippet**

```csharp theme={null}
using Alohi.Signplus;
using Alohi.Signplus.Config;

var config = new SignplusConfig{};

var client = new SignplusClient(config);

var response = await client.Signplus.DownloadEnvelopeCertificateAsync("envelope_id");

Console.WriteLine(response);
```

## GetEnvelopeDocumentAsync

Get envelope document

* HTTP Method: `GET`
* Endpoint: `/envelope/{envelope_id}/document/{document_id}`

**Parameters**

| Name       | Type   | Required | Description |
| :--------- | :----- | :------- | :---------- |
| envelopeId | string | ✅        |             |
| documentId | string | ✅        |             |

**Return Type**

`Document`

**Example Usage Code Snippet**

```csharp theme={null}
using Alohi.Signplus;
using Alohi.Signplus.Config;

var config = new SignplusConfig{};

var client = new SignplusClient(config);

var response = await client.Signplus.GetEnvelopeDocumentAsync("envelope_id", "document_id");

Console.WriteLine(response);
```

## GetEnvelopeDocumentsAsync

Get envelope documents

* HTTP Method: `GET`
* Endpoint: `/envelope/{envelope_id}/documents`

**Parameters**

| Name       | Type   | Required | Description |
| :--------- | :----- | :------- | :---------- |
| envelopeId | string | ✅        |             |

**Return Type**

`ListEnvelopeDocumentsResponse`

**Example Usage Code Snippet**

```csharp theme={null}
using Alohi.Signplus;
using Alohi.Signplus.Config;

var config = new SignplusConfig{};

var client = new SignplusClient(config);

var response = await client.Signplus.GetEnvelopeDocumentsAsync("envelope_id");

Console.WriteLine(response);
```

## AddEnvelopeDocumentAsync

Add envelope document

* HTTP Method: `POST`
* Endpoint: `/envelope/{envelope_id}/document`

**Parameters**

| Name       | Type                       | Required | Description       |
| :--------- | :------------------------- | :------- | :---------------- |
| input      | AddEnvelopeDocumentRequest | ✅        | The request body. |
| envelopeId | string                     | ✅        |                   |

**Return Type**

`Document`

**Example Usage Code Snippet**

```csharp theme={null}
using Alohi.Signplus;
using Alohi.Signplus.Config;
using Alohi.Signplus.Models;

var config = new SignplusConfig{};

var client = new SignplusClient(config);

var input = new AddEnvelopeDocumentRequest(new byte[] {});

var response = await client.Signplus.AddEnvelopeDocumentAsync(input, "envelope_id");

Console.WriteLine(response);
```

## SetEnvelopeDynamicFieldsAsync

Set envelope dynamic fields

* HTTP Method: `PUT`
* Endpoint: `/envelope/{envelope_id}/dynamic_fields`

**Parameters**

| Name       | Type                            | Required | Description       |
| :--------- | :------------------------------ | :------- | :---------------- |
| input      | SetEnvelopeDynamicFieldsRequest | ✅        | The request body. |
| envelopeId | string                          | ✅        |                   |

**Return Type**

`Envelope`

**Example Usage Code Snippet**

```csharp theme={null}
using Alohi.Signplus;
using Alohi.Signplus.Config;
using Alohi.Signplus.Models;

var config = new SignplusConfig{};

var client = new SignplusClient(config);

var dynamicFieldsItem = new DynamicField("name", "value");
var dynamicFields = new List<DynamicField>() { dynamicFieldsItem };
var input = new SetEnvelopeDynamicFieldsRequest(dynamicFields);

var response = await client.Signplus.SetEnvelopeDynamicFieldsAsync(input, "envelope_id");

Console.WriteLine(response);
```

## AddEnvelopeSigningStepsAsync

Add envelope signing steps

* HTTP Method: `POST`
* Endpoint: `/envelope/{envelope_id}/signing_steps`

**Parameters**

| Name       | Type                           | Required | Description       |
| :--------- | :----------------------------- | :------- | :---------------- |
| input      | AddEnvelopeSigningStepsRequest | ✅        | The request body. |
| envelopeId | string                         | ✅        |                   |

**Return Type**

`Envelope`

**Example Usage Code Snippet**

```csharp theme={null}
using Alohi.Signplus;
using Alohi.Signplus.Config;
using Alohi.Signplus.Models;

var config = new SignplusConfig{};

var client = new SignplusClient(config);

var verification = new RecipientVerification(RecipientVerificationType.Sms, "value");
var recipientsItem = new Recipient("name", "email", RecipientRole.Signer, "id", "uid", verification);
var recipients = new List<Recipient>() { recipientsItem };
var signingStepsItem = new SigningStep(recipients);
var signingSteps = new List<SigningStep>() { signingStepsItem };
var input = new AddEnvelopeSigningStepsRequest(signingSteps);

var response = await client.Signplus.AddEnvelopeSigningStepsAsync(input, "envelope_id");

Console.WriteLine(response);
```

## SetEnvelopeAttachmentsSettingsAsync

Set envelope attachment settings

* HTTP Method: `PUT`
* Endpoint: `/envelope/{envelope_id}/attachments/settings`

**Parameters**

| Name       | Type                                  | Required | Description       |
| :--------- | :------------------------------------ | :------- | :---------------- |
| input      | SetEnvelopeAttachmentsSettingsRequest | ✅        | The request body. |
| envelopeId | string                                | ✅        |                   |

**Return Type**

`EnvelopeAttachments`

**Example Usage Code Snippet**

```csharp theme={null}
using Alohi.Signplus;
using Alohi.Signplus.Config;
using Alohi.Signplus.Models;

var config = new SignplusConfig{};

var client = new SignplusClient(config);

var settings = new AttachmentSettings(false);
var input = new SetEnvelopeAttachmentsSettingsRequest(settings);

var response = await client.Signplus.SetEnvelopeAttachmentsSettingsAsync(input, "envelope_id");

Console.WriteLine(response);
```

## SetEnvelopeAttachmentsPlaceholdersAsync

Placeholders to be set, completely replacing the existing ones.

* HTTP Method: `PUT`
* Endpoint: `/envelope/{envelope_id}/attachments/placeholders`

**Parameters**

| Name       | Type                                      | Required | Description       |
| :--------- | :---------------------------------------- | :------- | :---------------- |
| input      | SetEnvelopeAttachmentsPlaceholdersRequest | ✅        | The request body. |
| envelopeId | string                                    | ✅        |                   |

**Return Type**

`EnvelopeAttachments`

**Example Usage Code Snippet**

```csharp theme={null}
using Alohi.Signplus;
using Alohi.Signplus.Config;
using Alohi.Signplus.Models;

var config = new SignplusConfig{};

var client = new SignplusClient(config);

var placeholdersItem = new AttachmentPlaceholderRequest("recipient_id", "name", false, true, "id", "hint");
var placeholders = new List<AttachmentPlaceholderRequest>() { placeholdersItem };
var input = new SetEnvelopeAttachmentsPlaceholdersRequest(placeholders);

var response = await client.Signplus.SetEnvelopeAttachmentsPlaceholdersAsync(input, "envelope_id");

Console.WriteLine(response);
```

## GetAttachmentFileAsync

Get envelope attachment file

* HTTP Method: `GET`
* Endpoint: `/envelope/{envelope_id}/attachments/{file_id}`

**Parameters**

| Name       | Type   | Required | Description |
| :--------- | :----- | :------- | :---------- |
| envelopeId | string | ✅        |             |
| fileId     | string | ✅        |             |

**Return Type**

`byte[]`

**Example Usage Code Snippet**

```csharp theme={null}
using Alohi.Signplus;
using Alohi.Signplus.Config;

var config = new SignplusConfig{};

var client = new SignplusClient(config);

var response = await client.Signplus.GetAttachmentFileAsync("envelope_id", "file_id");

Console.WriteLine(response);
```

## SendEnvelopeAsync

Send envelope for signature

* HTTP Method: `POST`
* Endpoint: `/envelope/{envelope_id}/send`

**Parameters**

| Name       | Type   | Required | Description |
| :--------- | :----- | :------- | :---------- |
| envelopeId | string | ✅        |             |

**Return Type**

`Envelope`

**Example Usage Code Snippet**

```csharp theme={null}
using Alohi.Signplus;
using Alohi.Signplus.Config;

var config = new SignplusConfig{};

var client = new SignplusClient(config);

var response = await client.Signplus.SendEnvelopeAsync("envelope_id");

Console.WriteLine(response);
```

## DuplicateEnvelopeAsync

Duplicate envelope

* HTTP Method: `POST`
* Endpoint: `/envelope/{envelope_id}/duplicate`

**Parameters**

| Name       | Type   | Required | Description |
| :--------- | :----- | :------- | :---------- |
| envelopeId | string | ✅        |             |

**Return Type**

`Envelope`

**Example Usage Code Snippet**

```csharp theme={null}
using Alohi.Signplus;
using Alohi.Signplus.Config;

var config = new SignplusConfig{};

var client = new SignplusClient(config);

var response = await client.Signplus.DuplicateEnvelopeAsync("envelope_id");

Console.WriteLine(response);
```

## VoidEnvelopeAsync

Void envelope

* HTTP Method: `PUT`
* Endpoint: `/envelope/{envelope_id}/void`

**Parameters**

| Name       | Type   | Required | Description |
| :--------- | :----- | :------- | :---------- |
| envelopeId | string | ✅        |             |

**Return Type**

`Envelope`

**Example Usage Code Snippet**

```csharp theme={null}
using Alohi.Signplus;
using Alohi.Signplus.Config;

var config = new SignplusConfig{};

var client = new SignplusClient(config);

var response = await client.Signplus.VoidEnvelopeAsync("envelope_id");

Console.WriteLine(response);
```

## RenameEnvelopeAsync

Rename envelope

* HTTP Method: `PUT`
* Endpoint: `/envelope/{envelope_id}/rename`

**Parameters**

| Name       | Type                  | Required | Description       |
| :--------- | :-------------------- | :------- | :---------------- |
| input      | RenameEnvelopeRequest | ✅        | The request body. |
| envelopeId | string                | ✅        |                   |

**Return Type**

`Envelope`

**Example Usage Code Snippet**

```csharp theme={null}
using Alohi.Signplus;
using Alohi.Signplus.Config;
using Alohi.Signplus.Models;

var config = new SignplusConfig{};

var client = new SignplusClient(config);

var input = new RenameEnvelopeRequest("name");

var response = await client.Signplus.RenameEnvelopeAsync(input, "envelope_id");

Console.WriteLine(response);
```

## SetEnvelopeCommentAsync

Set envelope comment

* HTTP Method: `PUT`
* Endpoint: `/envelope/{envelope_id}/set_comment`

**Parameters**

| Name       | Type                      | Required | Description       |
| :--------- | :------------------------ | :------- | :---------------- |
| input      | SetEnvelopeCommentRequest | ✅        | The request body. |
| envelopeId | string                    | ✅        |                   |

**Return Type**

`Envelope`

**Example Usage Code Snippet**

```csharp theme={null}
using Alohi.Signplus;
using Alohi.Signplus.Config;
using Alohi.Signplus.Models;

var config = new SignplusConfig{};

var client = new SignplusClient(config);

var input = new SetEnvelopeCommentRequest("comment");

var response = await client.Signplus.SetEnvelopeCommentAsync(input, "envelope_id");

Console.WriteLine(response);
```

## SetEnvelopeNotificationAsync

Set envelope notification

* HTTP Method: `PUT`
* Endpoint: `/envelope/{envelope_id}/set_notification`

**Parameters**

| Name       | Type                 | Required | Description       |
| :--------- | :------------------- | :------- | :---------------- |
| input      | EnvelopeNotification | ✅        | The request body. |
| envelopeId | string               | ✅        |                   |

**Return Type**

`Envelope`

**Example Usage Code Snippet**

```csharp theme={null}
using Alohi.Signplus;
using Alohi.Signplus.Config;
using Alohi.Signplus.Models;

var config = new SignplusConfig{};

var client = new SignplusClient(config);

var input = new EnvelopeNotification("subject", "message", 1);

var response = await client.Signplus.SetEnvelopeNotificationAsync(input, "envelope_id");

Console.WriteLine(response);
```

## SetEnvelopeExpirationDateAsync

Set envelope expiration date

* HTTP Method: `PUT`
* Endpoint: `/envelope/{envelope_id}/set_expiration_date`

**Parameters**

| Name       | Type                         | Required | Description       |
| :--------- | :--------------------------- | :------- | :---------------- |
| input      | SetEnvelopeExpirationRequest | ✅        | The request body. |
| envelopeId | string                       | ✅        |                   |

**Return Type**

`Envelope`

**Example Usage Code Snippet**

```csharp theme={null}
using Alohi.Signplus;
using Alohi.Signplus.Config;
using Alohi.Signplus.Models;

var config = new SignplusConfig{};

var client = new SignplusClient(config);

var input = new SetEnvelopeExpirationRequest(0);

var response = await client.Signplus.SetEnvelopeExpirationDateAsync(input, "envelope_id");

Console.WriteLine(response);
```

## SetEnvelopeLegalityLevelAsync

Set envelope legality level

* HTTP Method: `PUT`
* Endpoint: `/envelope/{envelope_id}/set_legality_level`

**Parameters**

| Name       | Type                            | Required | Description       |
| :--------- | :------------------------------ | :------- | :---------------- |
| input      | SetEnvelopeLegalityLevelRequest | ✅        | The request body. |
| envelopeId | string                          | ✅        |                   |

**Return Type**

`Envelope`

**Example Usage Code Snippet**

```csharp theme={null}
using Alohi.Signplus;
using Alohi.Signplus.Config;
using Alohi.Signplus.Models;

var config = new SignplusConfig{};

var client = new SignplusClient(config);

var input = new SetEnvelopeLegalityLevelRequest(EnvelopeLegalityLevel.Ses);

var response = await client.Signplus.SetEnvelopeLegalityLevelAsync(input, "envelope_id");

Console.WriteLine(response);
```

## GetEnvelopeAnnotationsAsync

Get envelope annotations

* HTTP Method: `GET`
* Endpoint: `/envelope/{envelope_id}/annotations`

**Parameters**

| Name       | Type   | Required | Description        |
| :--------- | :----- | :------- | :----------------- |
| envelopeId | string | ✅        | ID of the envelope |

**Return Type**

`List&lt;Annotation&gt;`

**Example Usage Code Snippet**

```csharp theme={null}
using Alohi.Signplus;
using Alohi.Signplus.Config;

var config = new SignplusConfig{};

var client = new SignplusClient(config);

var response = await client.Signplus.GetEnvelopeAnnotationsAsync("envelope_id");

Console.WriteLine(response);
```

## GetEnvelopeDocumentAnnotationsAsync

Get envelope document annotations

* HTTP Method: `GET`
* Endpoint: `/envelope/{envelope_id}/annotations/{document_id}`

**Parameters**

| Name       | Type   | Required | Description        |
| :--------- | :----- | :------- | :----------------- |
| envelopeId | string | ✅        | ID of the envelope |
| documentId | string | ✅        | ID of document     |

**Return Type**

`ListEnvelopeDocumentAnnotationsResponse`

**Example Usage Code Snippet**

```csharp theme={null}
using Alohi.Signplus;
using Alohi.Signplus.Config;

var config = new SignplusConfig{};

var client = new SignplusClient(config);

var response = await client.Signplus.GetEnvelopeDocumentAnnotationsAsync("envelope_id", "document_id");

Console.WriteLine(response);
```

## AddEnvelopeAnnotationAsync

Add envelope annotation

* HTTP Method: `POST`
* Endpoint: `/envelope/{envelope_id}/annotation`

**Parameters**

| Name       | Type                 | Required | Description        |
| :--------- | :------------------- | :------- | :----------------- |
| input      | AddAnnotationRequest | ✅        | The request body.  |
| envelopeId | string               | ✅        | ID of the envelope |

**Return Type**

`Annotation`

**Example Usage Code Snippet**

```csharp theme={null}
using Alohi.Signplus;
using Alohi.Signplus.Config;
using Alohi.Signplus.Models;

var config = new SignplusConfig{};

var client = new SignplusClient(config);

var signature = new AnnotationSignature("id");
var initials = new AnnotationInitials("id");
var font = new AnnotationFont(AnnotationFontFamily.Unknown, true, true);
var text = new AnnotationText(5.96, 8.73, "value", "tooltip", "dynamic_field_name", font);
var font = new AnnotationFont(AnnotationFontFamily.Unknown, true, true);
var datetime = new AnnotationDateTime(0.26, font, "color", true, "timezone", 1, AnnotationDateTimeFormat.DmyNumericSlash);
var checkbox = new AnnotationCheckbox(true, AnnotationCheckboxStyle.CircleCheck);
var input = new AddAnnotationRequest("document_id", 2, 1.99, 8.2, 4.89, 9.43, AnnotationType.Text, "recipient_id", false, signature, initials, text, datetime, checkbox);

var response = await client.Signplus.AddEnvelopeAnnotationAsync(input, "envelope_id");

Console.WriteLine(response);
```

## DeleteEnvelopeAnnotationAsync

Delete envelope annotation

* HTTP Method: `DELETE`
* Endpoint: `/envelope/{envelope_id}/annotation/{annotation_id}`

**Parameters**

| Name         | Type   | Required | Description                    |
| :----------- | :----- | :------- | :----------------------------- |
| envelopeId   | string | ✅        | ID of the envelope             |
| annotationId | string | ✅        | ID of the annotation to delete |

**Example Usage Code Snippet**

```csharp theme={null}
using Alohi.Signplus;
using Alohi.Signplus.Config;

var config = new SignplusConfig{};

var client = new SignplusClient(config);

await client.Signplus.DeleteEnvelopeAnnotationAsync("envelope_id", "annotation_id");
```

## CreateTemplateAsync

Create new template

* HTTP Method: `POST`
* Endpoint: `/template`

**Parameters**

| Name  | Type                                                                           | Required | Description       |
| :---- | :----------------------------------------------------------------------------- | :------- | :---------------- |
| input | [CreateTemplateRequest](/api-reference/endpoints/signplus/create-new-template) | ✅        | The request body. |

**Return Type**

`Template`

**Example Usage Code Snippet**

```csharp theme={null}
using Alohi.Signplus;
using Alohi.Signplus.Config;
using Alohi.Signplus.Models;

var config = new SignplusConfig{};

var client = new SignplusClient(config);

var input = new CreateTemplateRequest("name");

var response = await client.Signplus.CreateTemplateAsync(input);

Console.WriteLine(response);
```

## ListTemplatesAsync

List templates

* HTTP Method: `POST`
* Endpoint: `/templates`

**Parameters**

| Name  | Type                                                                     | Required | Description       |
| :---- | :----------------------------------------------------------------------- | :------- | :---------------- |
| input | [ListTemplatesRequest](/api-reference/endpoints/signplus/list-templates) | ❌        | The request body. |

**Return Type**

`ListTemplatesResponse`

**Example Usage Code Snippet**

```csharp theme={null}
using Alohi.Signplus;
using Alohi.Signplus.Config;
using Alohi.Signplus.Models;

var config = new SignplusConfig{};

var client = new SignplusClient(config);

var tags = new List<string>() { "tags" };
var ids = new List<string>() { "ids" };
var input = new ListTemplatesRequest("name", tags, ids, 1, 6, "after", "before", TemplateOrderField.TemplateId, false);

var response = await client.Signplus.ListTemplatesAsync(input);

Console.WriteLine(response);
```

## GetTemplateAsync

Get template

* HTTP Method: `GET`
* Endpoint: `/template/{template_id}`

**Parameters**

| Name       | Type   | Required | Description |
| :--------- | :----- | :------- | :---------- |
| templateId | string | ✅        |             |

**Return Type**

`Template`

**Example Usage Code Snippet**

```csharp theme={null}
using Alohi.Signplus;
using Alohi.Signplus.Config;

var config = new SignplusConfig{};

var client = new SignplusClient(config);

var response = await client.Signplus.GetTemplateAsync("template_id");

Console.WriteLine(response);
```

## DeleteTemplateAsync

Delete template

* HTTP Method: `DELETE`
* Endpoint: `/template/{template_id}`

**Parameters**

| Name       | Type   | Required | Description |
| :--------- | :----- | :------- | :---------- |
| templateId | string | ✅        |             |

**Example Usage Code Snippet**

```csharp theme={null}
using Alohi.Signplus;
using Alohi.Signplus.Config;

var config = new SignplusConfig{};

var client = new SignplusClient(config);

await client.Signplus.DeleteTemplateAsync("template_id");
```

## DuplicateTemplateAsync

Duplicate template

* HTTP Method: `POST`
* Endpoint: `/template/{template_id}/duplicate`

**Parameters**

| Name       | Type   | Required | Description |
| :--------- | :----- | :------- | :---------- |
| templateId | string | ✅        |             |

**Return Type**

`Template`

**Example Usage Code Snippet**

```csharp theme={null}
using Alohi.Signplus;
using Alohi.Signplus.Config;

var config = new SignplusConfig{};

var client = new SignplusClient(config);

var response = await client.Signplus.DuplicateTemplateAsync("template_id");

Console.WriteLine(response);
```

## AddTemplateDocumentAsync

Add template document

* HTTP Method: `POST`
* Endpoint: `/template/{template_id}/document`

**Parameters**

| Name       | Type                       | Required | Description       |
| :--------- | :------------------------- | :------- | :---------------- |
| input      | AddTemplateDocumentRequest | ✅        | The request body. |
| templateId | string                     | ✅        |                   |

**Return Type**

`Document`

**Example Usage Code Snippet**

```csharp theme={null}
using Alohi.Signplus;
using Alohi.Signplus.Config;
using Alohi.Signplus.Models;

var config = new SignplusConfig{};

var client = new SignplusClient(config);

var input = new AddTemplateDocumentRequest(new byte[] {});

var response = await client.Signplus.AddTemplateDocumentAsync(input, "template_id");

Console.WriteLine(response);
```

## GetTemplateDocumentAsync

Get template document

* HTTP Method: `GET`
* Endpoint: `/template/{template_id}/document/{document_id}`

**Parameters**

| Name       | Type   | Required | Description |
| :--------- | :----- | :------- | :---------- |
| templateId | string | ✅        |             |
| documentId | string | ✅        |             |

**Return Type**

`Document`

**Example Usage Code Snippet**

```csharp theme={null}
using Alohi.Signplus;
using Alohi.Signplus.Config;

var config = new SignplusConfig{};

var client = new SignplusClient(config);

var response = await client.Signplus.GetTemplateDocumentAsync("template_id", "document_id");

Console.WriteLine(response);
```

## GetTemplateDocumentsAsync

Get template documents

* HTTP Method: `GET`
* Endpoint: `/template/{template_id}/documents`

**Parameters**

| Name       | Type   | Required | Description |
| :--------- | :----- | :------- | :---------- |
| templateId | string | ✅        |             |

**Return Type**

`ListTemplateDocumentsResponse`

**Example Usage Code Snippet**

```csharp theme={null}
using Alohi.Signplus;
using Alohi.Signplus.Config;

var config = new SignplusConfig{};

var client = new SignplusClient(config);

var response = await client.Signplus.GetTemplateDocumentsAsync("template_id");

Console.WriteLine(response);
```

## AddTemplateSigningStepsAsync

Add template signing steps

* HTTP Method: `POST`
* Endpoint: `/template/{template_id}/signing_steps`

**Parameters**

| Name       | Type                           | Required | Description       |
| :--------- | :----------------------------- | :------- | :---------------- |
| input      | AddTemplateSigningStepsRequest | ✅        | The request body. |
| templateId | string                         | ✅        |                   |

**Return Type**

`Template`

**Example Usage Code Snippet**

```csharp theme={null}
using Alohi.Signplus;
using Alohi.Signplus.Config;
using Alohi.Signplus.Models;

var config = new SignplusConfig{};

var client = new SignplusClient(config);

var recipientsItem = new TemplateRecipient("id", "uid", "name", "email", TemplateRecipientRole.Signer);
var recipients = new List<TemplateRecipient>() { recipientsItem };
var signingStepsItem = new TemplateSigningStep(recipients);
var signingSteps = new List<TemplateSigningStep>() { signingStepsItem };
var input = new AddTemplateSigningStepsRequest(signingSteps);

var response = await client.Signplus.AddTemplateSigningStepsAsync(input, "template_id");

Console.WriteLine(response);
```

## RenameTemplateAsync

Rename template

* HTTP Method: `PUT`
* Endpoint: `/template/{template_id}/rename`

**Parameters**

| Name       | Type                  | Required | Description       |
| :--------- | :-------------------- | :------- | :---------------- |
| input      | RenameTemplateRequest | ✅        | The request body. |
| templateId | string                | ✅        |                   |

**Return Type**

`Template`

**Example Usage Code Snippet**

```csharp theme={null}
using Alohi.Signplus;
using Alohi.Signplus.Config;
using Alohi.Signplus.Models;

var config = new SignplusConfig{};

var client = new SignplusClient(config);

var input = new RenameTemplateRequest("name");

var response = await client.Signplus.RenameTemplateAsync(input, "template_id");

Console.WriteLine(response);
```

## SetTemplateCommentAsync

Set template comment

* HTTP Method: `PUT`
* Endpoint: `/template/{template_id}/set_comment`

**Parameters**

| Name       | Type                      | Required | Description       |
| :--------- | :------------------------ | :------- | :---------------- |
| input      | SetTemplateCommentRequest | ✅        | The request body. |
| templateId | string                    | ✅        |                   |

**Return Type**

`Template`

**Example Usage Code Snippet**

```csharp theme={null}
using Alohi.Signplus;
using Alohi.Signplus.Config;
using Alohi.Signplus.Models;

var config = new SignplusConfig{};

var client = new SignplusClient(config);

var input = new SetTemplateCommentRequest("comment");

var response = await client.Signplus.SetTemplateCommentAsync(input, "template_id");

Console.WriteLine(response);
```

## SetTemplateNotificationAsync

Set template notification

* HTTP Method: `PUT`
* Endpoint: `/template/{template_id}/set_notification`

**Parameters**

| Name       | Type                 | Required | Description       |
| :--------- | :------------------- | :------- | :---------------- |
| input      | EnvelopeNotification | ✅        | The request body. |
| templateId | string               | ✅        |                   |

**Return Type**

`Template`

**Example Usage Code Snippet**

```csharp theme={null}
using Alohi.Signplus;
using Alohi.Signplus.Config;
using Alohi.Signplus.Models;

var config = new SignplusConfig{};

var client = new SignplusClient(config);

var input = new EnvelopeNotification("subject", "message", 1);

var response = await client.Signplus.SetTemplateNotificationAsync(input, "template_id");

Console.WriteLine(response);
```

## GetTemplateAnnotationsAsync

Get template annotations

* HTTP Method: `GET`
* Endpoint: `/template/{template_id}/annotations`

**Parameters**

| Name       | Type   | Required | Description        |
| :--------- | :----- | :------- | :----------------- |
| templateId | string | ✅        | ID of the template |

**Return Type**

`ListTemplateAnnotationsResponse`

**Example Usage Code Snippet**

```csharp theme={null}
using Alohi.Signplus;
using Alohi.Signplus.Config;

var config = new SignplusConfig{};

var client = new SignplusClient(config);

var response = await client.Signplus.GetTemplateAnnotationsAsync("template_id");

Console.WriteLine(response);
```

## GetDocumentTemplateAnnotationsAsync

Get document template annotations

* HTTP Method: `GET`
* Endpoint: `/template/{template_id}/annotations/{document_id}`

**Parameters**

| Name       | Type   | Required | Description        |
| :--------- | :----- | :------- | :----------------- |
| templateId | string | ✅        | ID of the template |
| documentId | string | ✅        | ID of document     |

**Return Type**

`ListTemplateDocumentAnnotationsResponse`

**Example Usage Code Snippet**

```csharp theme={null}
using Alohi.Signplus;
using Alohi.Signplus.Config;

var config = new SignplusConfig{};

var client = new SignplusClient(config);

var response = await client.Signplus.GetDocumentTemplateAnnotationsAsync("template_id", "document_id");

Console.WriteLine(response);
```

## AddTemplateAnnotationAsync

Add template annotation

* HTTP Method: `POST`
* Endpoint: `/template/{template_id}/annotation`

**Parameters**

| Name       | Type                 | Required | Description        |
| :--------- | :------------------- | :------- | :----------------- |
| input      | AddAnnotationRequest | ✅        | The request body.  |
| templateId | string               | ✅        | ID of the template |

**Return Type**

`Annotation`

**Example Usage Code Snippet**

```csharp theme={null}
using Alohi.Signplus;
using Alohi.Signplus.Config;
using Alohi.Signplus.Models;

var config = new SignplusConfig{};

var client = new SignplusClient(config);

var signature = new AnnotationSignature("id");
var initials = new AnnotationInitials("id");
var font = new AnnotationFont(AnnotationFontFamily.Unknown, true, true);
var text = new AnnotationText(5.96, 8.73, "value", "tooltip", "dynamic_field_name", font);
var font = new AnnotationFont(AnnotationFontFamily.Unknown, true, true);
var datetime = new AnnotationDateTime(0.26, font, "color", true, "timezone", 1, AnnotationDateTimeFormat.DmyNumericSlash);
var checkbox = new AnnotationCheckbox(true, AnnotationCheckboxStyle.CircleCheck);
var input = new AddAnnotationRequest("document_id", 2, 1.99, 8.2, 4.89, 9.43, AnnotationType.Text, "recipient_id", false, signature, initials, text, datetime, checkbox);

var response = await client.Signplus.AddTemplateAnnotationAsync(input, "template_id");

Console.WriteLine(response);
```

## DeleteTemplateAnnotationAsync

Delete template annotation

* HTTP Method: `DELETE`
* Endpoint: `/template/{template_id}/annotation/{annotation_id}`

**Parameters**

| Name         | Type   | Required | Description                    |
| :----------- | :----- | :------- | :----------------------------- |
| templateId   | string | ✅        | ID of the template             |
| annotationId | string | ✅        | ID of the annotation to delete |

**Example Usage Code Snippet**

```csharp theme={null}
using Alohi.Signplus;
using Alohi.Signplus.Config;

var config = new SignplusConfig{};

var client = new SignplusClient(config);

await client.Signplus.DeleteTemplateAnnotationAsync("template_id", "annotation_id");
```

## SetTemplateAttachmentsSettingsAsync

Set template attachment settings

* HTTP Method: `PUT`
* Endpoint: `/template/{template_id}/attachments/settings`

**Parameters**

| Name       | Type                                  | Required | Description       |
| :--------- | :------------------------------------ | :------- | :---------------- |
| input      | SetEnvelopeAttachmentsSettingsRequest | ✅        | The request body. |
| templateId | string                                | ✅        |                   |

**Return Type**

`EnvelopeAttachments`

**Example Usage Code Snippet**

```csharp theme={null}
using Alohi.Signplus;
using Alohi.Signplus.Config;
using Alohi.Signplus.Models;

var config = new SignplusConfig{};

var client = new SignplusClient(config);

var settings = new AttachmentSettings(false);
var input = new SetEnvelopeAttachmentsSettingsRequest(settings);

var response = await client.Signplus.SetTemplateAttachmentsSettingsAsync(input, "template_id");

Console.WriteLine(response);
```

## SetTemplateAttachmentsPlaceholdersAsync

Placeholders to be set, completely replacing the existing ones.

* HTTP Method: `PUT`
* Endpoint: `/template/{template_id}/attachments/placeholders`

**Parameters**

| Name       | Type                                      | Required | Description       |
| :--------- | :---------------------------------------- | :------- | :---------------- |
| input      | SetEnvelopeAttachmentsPlaceholdersRequest | ✅        | The request body. |
| templateId | string                                    | ✅        |                   |

**Return Type**

`EnvelopeAttachments`

**Example Usage Code Snippet**

```csharp theme={null}
using Alohi.Signplus;
using Alohi.Signplus.Config;
using Alohi.Signplus.Models;

var config = new SignplusConfig{};

var client = new SignplusClient(config);

var placeholdersItem = new AttachmentPlaceholderRequest("recipient_id", "name", false, true, "id", "hint");
var placeholders = new List<AttachmentPlaceholderRequest>() { placeholdersItem };
var input = new SetEnvelopeAttachmentsPlaceholdersRequest(placeholders);

var response = await client.Signplus.SetTemplateAttachmentsPlaceholdersAsync(input, "template_id");

Console.WriteLine(response);
```

## CreateWebhookAsync

Create webhook

* HTTP Method: `POST`
* Endpoint: `/webhook`

**Parameters**

| Name  | Type                                                                     | Required | Description       |
| :---- | :----------------------------------------------------------------------- | :------- | :---------------- |
| input | [CreateWebhookRequest](/api-reference/endpoints/signplus/create-webhook) | ✅        | The request body. |

**Return Type**

`Webhook`

**Example Usage Code Snippet**

```csharp theme={null}
using Alohi.Signplus;
using Alohi.Signplus.Config;
using Alohi.Signplus.Models;

var config = new SignplusConfig{};

var client = new SignplusClient(config);

var input = new CreateWebhookRequest(WebhookEvent.EnvelopeExpired, "target");

var response = await client.Signplus.CreateWebhookAsync(input);

Console.WriteLine(response);
```

## ListWebhooksAsync

List webhooks

* HTTP Method: `POST`
* Endpoint: `/webhooks`

**Parameters**

| Name  | Type                                                                   | Required | Description       |
| :---- | :--------------------------------------------------------------------- | :------- | :---------------- |
| input | [ListWebhooksRequest](/api-reference/endpoints/signplus/list-webhooks) | ❌        | The request body. |

**Return Type**

`ListWebhooksResponse`

**Example Usage Code Snippet**

```csharp theme={null}
using Alohi.Signplus;
using Alohi.Signplus.Config;
using Alohi.Signplus.Models;

var config = new SignplusConfig{};

var client = new SignplusClient(config);

var input = new ListWebhooksRequest("webhook_id", WebhookEvent.EnvelopeExpired);

var response = await client.Signplus.ListWebhooksAsync(input);

Console.WriteLine(response);
```

## DeleteWebhookAsync

Delete webhook

* HTTP Method: `DELETE`
* Endpoint: `/webhook/{webhook_id}`

**Parameters**

| Name      | Type   | Required | Description |
| :-------- | :----- | :------- | :---------- |
| webhookId | string | ✅        |             |

**Example Usage Code Snippet**

```csharp theme={null}
using Alohi.Signplus;
using Alohi.Signplus.Config;

var config = new SignplusConfig{};

var client = new SignplusClient(config);

await client.Signplus.DeleteWebhookAsync("webhook_id");
```

# Models

# SetEnvelopeAttachmentsPlaceholdersRequest

**Properties**

| Name         | Type                                | Required | Description |
| :----------- | :---------------------------------- | :------- | :---------- |
| Placeholders | List\<AttachmentPlaceholderRequest> | ✅        |             |

# Document

**Properties**

| Name      | Type        | Required | Description                       |
| :-------- | :---------- | :------- | :-------------------------------- |
| Id        | string      | ❌        | Unique identifier of the document |
| Name      | string      | ❌        | Name of the document              |
| Filename  | string      | ❌        | Filename of the document          |
| PageCount | long        | ❌        | Number of pages in the document   |
| Pages     | List\<Page> | ❌        | List of pages in the document     |

# CreateEnvelopeRequest

**Properties**

| Name          | Type                  | Required | Description                                                                                                                                                               |
| :------------ | :-------------------- | :------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Name          | string                | ✅        | Name of the envelope                                                                                                                                                      |
| LegalityLevel | EnvelopeLegalityLevel | ✅        | Legal level of the envelope (SES is Simple Electronic Signature, QES\_EIDAS is Qualified Electronic Signature, QES\_ZERTES is Qualified Electronic Signature with Zertes) |
| ExpiresAt     | long                  | ❌        | Unix timestamp of the expiration date                                                                                                                                     |
| Comment       | string                | ❌        | Comment for the envelope                                                                                                                                                  |
| Sandbox       | bool                  | ❌        | Whether the envelope is created in sandbox mode                                                                                                                           |

# ListEnvelopesRequest

**Properties**

| Name           | Type                  | Required | Description                                       |
| :------------- | :-------------------- | :------- | :------------------------------------------------ |
| Name           | string                | ❌        | Name of the envelope                              |
| Tags           | List\<string>         | ❌        | List of tags                                      |
| Comment        | string                | ❌        | Comment of the envelope                           |
| Ids            | List\<string>         | ❌        | List of envelope IDs                              |
| Statuses       | List\<EnvelopeStatus> | ❌        | List of envelope statuses                         |
| FolderIds      | List\<string>         | ❌        | List of folder IDs                                |
| OnlyRootFolder | bool                  | ❌        | Whether to only list envelopes in the root folder |
| DateFrom       | long                  | ❌        | Unix timestamp of the start date                  |
| DateTo         | long                  | ❌        | Unix timestamp of the end date                    |
| Uid            | string                | ❌        | Unique identifier of the user                     |
| First          | long                  | ❌        |                                                   |
| Last           | long                  | ❌        |                                                   |
| After          | string                | ❌        |                                                   |
| Before         | string                | ❌        |                                                   |
| OrderField     | EnvelopeOrderField    | ❌        | Field to order envelopes by                       |
| Ascending      | bool                  | ❌        | Whether to order envelopes in ascending order     |
| IncludeTrash   | bool                  | ❌        | Whether to include envelopes in the trash         |

# AttachmentPlaceholder

**Properties**

| Name        | Type                             | Required | Description                                                |
| :---------- | :------------------------------- | :------- | :--------------------------------------------------------- |
| RecipientId | string                           | ❌        | ID of the recipient                                        |
| Id          | string                           | ❌        | ID of the attachment placeholder                           |
| Name        | string                           | ❌        | Name of the attachment placeholder                         |
| Hint        | string                           | ❌        | Hint of the attachment placeholder                         |
| Required    | bool                             | ❌        | Whether the attachment placeholder is required             |
| Multiple    | bool                             | ❌        | Whether the attachment placeholder can have multiple files |
| Files       | List\<AttachmentPlaceholderFile> | ❌        |                                                            |

# SetEnvelopeAttachmentsSettingsRequest

**Properties**

| Name     | Type               | Required | Description |
| :------- | :----------------- | :------- | :---------- |
| Settings | AttachmentSettings | ✅        |             |

# EnvelopeNotification

**Properties**

| Name             | Type   | Required | Description                       |
| :--------------- | :----- | :------- | :-------------------------------- |
| Subject          | string | ❌        | Subject of the notification       |
| Message          | string | ❌        | Message of the notification       |
| ReminderInterval | long   | ❌        | Interval in days to send reminder |

# ListTemplatesRequest

**Properties**

| Name       | Type               | Required | Description                                   |
| :--------- | :----------------- | :------- | :-------------------------------------------- |
| Name       | string             | ❌        | Name of the template                          |
| Tags       | List\<string>      | ❌        | List of tag templates                         |
| Ids        | List\<string>      | ❌        | List of templates IDs                         |
| First      | long               | ❌        |                                               |
| Last       | long               | ❌        |                                               |
| After      | string             | ❌        |                                               |
| Before     | string             | ❌        |                                               |
| OrderField | TemplateOrderField | ❌        | Field to order templates by                   |
| Ascending  | bool               | ❌        | Whether to order templates in ascending order |

# SetTemplateCommentRequest

**Properties**

| Name    | Type   | Required | Description              |
| :------ | :----- | :------- | :----------------------- |
| Comment | string | ✅        | Comment for the template |

# Template

**Properties**

| Name            | Type                       | Required | Description                                                                                                                                                               |
| :-------------- | :------------------------- | :------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Id              | string                     | ❌        | Unique identifier of the template                                                                                                                                         |
| Name            | string                     | ❌        | Name of the template                                                                                                                                                      |
| Comment         | string                     | ❌        | Comment for the template                                                                                                                                                  |
| Pages           | long                       | ❌        | Total number of pages in the template                                                                                                                                     |
| LegalityLevel   | EnvelopeLegalityLevel      | ❌        | Legal level of the envelope (SES is Simple Electronic Signature, QES\_EIDAS is Qualified Electronic Signature, QES\_ZERTES is Qualified Electronic Signature with Zertes) |
| CreatedAt       | long                       | ❌        | Unix timestamp of the creation date                                                                                                                                       |
| UpdatedAt       | long                       | ❌        | Unix timestamp of the last modification date                                                                                                                              |
| ExpirationDelay | long                       | ❌        | Expiration delay added to the current time when an envelope is created from this template                                                                                 |
| NumRecipients   | long                       | ❌        | Number of recipients in the envelope                                                                                                                                      |
| SigningSteps    | List\<TemplateSigningStep> | ❌        |                                                                                                                                                                           |
| Documents       | List\<Document>            | ❌        |                                                                                                                                                                           |
| Notification    | EnvelopeNotification       | ❌        |                                                                                                                                                                           |
| DynamicFields   | List\<string>              | ❌        | List of dynamic fields                                                                                                                                                    |
| Attachments     | EnvelopeAttachments        | ❌        |                                                                                                                                                                           |

# RecipientVerificationType

Type of verification the recipient must complete before accessing the envelope. - `PASSCODE`: requires a code to be entered. - `SMS`: sends a code via SMS. - `ID_VERIFICATION`: prompts the recipient to complete an automated ID and selfie check.

**Properties**

| Name           | Type   | Required | Description        |
| :------------- | :----- | :------- | :----------------- |
| Sms            | string | ✅        | "SMS"              |
| Passcode       | string | ✅        | "PASSCODE"         |
| IdVerification | string | ✅        | "ID\_VERIFICATION" |

# AddEnvelopeSigningStepsRequest

**Properties**

| Name         | Type               | Required | Description           |
| :----------- | :----------------- | :------- | :-------------------- |
| SigningSteps | List\<SigningStep> | ❌        | List of signing steps |

# AnnotationFontFamily

Font family of the text

**Properties**

| Name    | Type   | Required | Description |
| :------ | :----- | :------- | :---------- |
| Unknown | string | ✅        | "UNKNOWN"   |
| Serif   | string | ✅        | "SERIF"     |
| Sans    | string | ✅        | "SANS"      |
| Mono    | string | ✅        | "MONO"      |

# AddTemplateSigningStepsRequest

**Properties**

| Name         | Type                       | Required | Description           |
| :----------- | :------------------------- | :------- | :-------------------- |
| SigningSteps | List\<TemplateSigningStep> | ✅        | List of signing steps |

# SetEnvelopeCommentRequest

**Properties**

| Name    | Type   | Required | Description              |
| :------ | :----- | :------- | :----------------------- |
| Comment | string | ✅        | Comment for the envelope |

# TemplateOrderField

Field to order templates by

**Properties**

| Name                     | Type   | Required | Description                    |
| :----------------------- | :----- | :------- | :----------------------------- |
| TemplateId               | string | ✅        | "TEMPLATE\_ID"                 |
| TemplateCreationDate     | string | ✅        | "TEMPLATE\_CREATION\_DATE"     |
| TemplateModificationDate | string | ✅        | "TEMPLATE\_MODIFICATION\_DATE" |
| TemplateName             | string | ✅        | "TEMPLATE\_NAME"               |

# EnvelopeOrderField

Field to order envelopes by

**Properties**

| Name               | Type   | Required | Description              |
| :----------------- | :----- | :------- | :----------------------- |
| CreationDate       | string | ✅        | "CREATION\_DATE"         |
| ModificationDate   | string | ✅        | "MODIFICATION\_DATE"     |
| Name               | string | ✅        | "NAME"                   |
| Status             | string | ✅        | "STATUS"                 |
| LastDocumentChange | string | ✅        | "LAST\_DOCUMENT\_CHANGE" |

# AddEnvelopeDocumentRequest

**Properties**

| Name | Type    | Required | Description                     |
| :--- | :------ | :------- | :------------------------------ |
| File | byte\[] | ❌        | File to upload in binary format |

# ListWebhooksRequest

**Properties**

| Name      | Type         | Required | Description          |
| :-------- | :----------- | :------- | :------------------- |
| WebhookId | string       | ❌        | ID of the webhook    |
| Event\_   | WebhookEvent | ❌        | Event of the webhook |

# SetEnvelopeLegalityLevelRequest

**Properties**

| Name          | Type                  | Required | Description                                                                                                                                                               |
| :------------ | :-------------------- | :------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| LegalityLevel | EnvelopeLegalityLevel | ❌        | Legal level of the envelope (SES is Simple Electronic Signature, QES\_EIDAS is Qualified Electronic Signature, QES\_ZERTES is Qualified Electronic Signature with Zertes) |

# AttachmentPlaceholderFile

**Properties**

| Name     | Type   | Required | Description               |
| :------- | :----- | :------- | :------------------------ |
| Id       | string | ❌        | ID of the file            |
| Name     | string | ❌        | Name of the file          |
| Size     | long   | ❌        | Size of the file in bytes |
| Mimetype | string | ❌        | MIME type of the file     |

# SetEnvelopeExpirationRequest

**Properties**

| Name      | Type | Required | Description                           |
| :-------- | :--- | :------- | :------------------------------------ |
| ExpiresAt | long | ✅        | Unix timestamp of the expiration date |

# AnnotationText

Text annotation (null if annotation is not a text)

**Properties**

| Name             | Type           | Required | Description                        |
| :--------------- | :------------- | :------- | :--------------------------------- |
| Size             | double         | ❌        | Font size of the text in pt        |
| Color            | double         | ❌        | Text color in 32bit representation |
| Value            | string         | ❌        | Text content of the annotation     |
| Tooltip          | string         | ❌        | Tooltip of the annotation          |
| DynamicFieldName | string         | ❌        | Name of the dynamic field          |
| Font             | AnnotationFont | ❌        |                                    |

# AnnotationCheckbox

Checkbox annotation (null if annotation is not a checkbox)

**Properties**

| Name      | Type                    | Required | Description                     |
| :-------- | :---------------------- | :------- | :------------------------------ |
| Checked\_ | bool                    | ❌        | Whether the checkbox is checked |
| Style     | AnnotationCheckboxStyle | ❌        | Style of the checkbox           |

# Envelope

**Properties**

| Name          | Type                  | Required | Description                                                                                                                                                               |
| :------------ | :-------------------- | :------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Id            | string                | ❌        | Unique identifier of the envelope                                                                                                                                         |
| Name          | string                | ❌        | Name of the envelope                                                                                                                                                      |
| Comment       | string                | ❌        | Comment for the envelope                                                                                                                                                  |
| Pages         | long                  | ❌        | Total number of pages in the envelope                                                                                                                                     |
| FlowType      | EnvelopeFlowType      | ❌        | Flow type of the envelope (REQUEST\_SIGNATURE is a request for signature, SIGN\_MYSELF is a self-signing flow)                                                            |
| LegalityLevel | EnvelopeLegalityLevel | ❌        | Legal level of the envelope (SES is Simple Electronic Signature, QES\_EIDAS is Qualified Electronic Signature, QES\_ZERTES is Qualified Electronic Signature with Zertes) |
| Status        | EnvelopeStatus        | ❌        | Status of the envelope                                                                                                                                                    |
| CreatedAt     | long                  | ❌        | Unix timestamp of the creation date                                                                                                                                       |
| UpdatedAt     | long                  | ❌        | Unix timestamp of the last modification date                                                                                                                              |
| ExpiresAt     | long                  | ❌        | Unix timestamp of the expiration date                                                                                                                                     |
| NumRecipients | long                  | ❌        | Number of recipients in the envelope                                                                                                                                      |
| IsDuplicable  | bool                  | ❌        | Whether the envelope can be duplicated                                                                                                                                    |
| SigningSteps  | List\<SigningStep>    | ❌        |                                                                                                                                                                           |
| Documents     | List\<Document>       | ❌        |                                                                                                                                                                           |
| Notification  | EnvelopeNotification  | ❌        |                                                                                                                                                                           |
| Attachments   | EnvelopeAttachments   | ❌        |                                                                                                                                                                           |

# AddTemplateDocumentRequest

**Properties**

| Name | Type    | Required | Description                     |
| :--- | :------ | :------- | :------------------------------ |
| File | byte\[] | ✅        | File to upload in binary format |

# TemplateRecipient

**Properties**

| Name  | Type                  | Required | Description                                                                                                                                                                   |
| :---- | :-------------------- | :------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Id    | string                | ❌        | Unique identifier of the recipient                                                                                                                                            |
| Uid   | string                | ❌        | Unique identifier of the user associated with the recipient                                                                                                                   |
| Name  | string                | ❌        | Name of the recipient                                                                                                                                                         |
| Email | string                | ❌        | Email of the recipient                                                                                                                                                        |
| Role  | TemplateRecipientRole | ❌        | Role of the recipient (SIGNER signs the document, RECEIVES\_COPY receives a copy of the document, IN\_PERSON\_SIGNER signs the document in person, SENDER sends the document) |

# AddAnnotationRequest

**Properties**

| Name        | Type                | Required | Description                                                                                     |
| :---------- | :------------------ | :------- | :---------------------------------------------------------------------------------------------- |
| DocumentId  | string              | ✅        | ID of the document                                                                              |
| Page        | long                | ✅        | Page number where the annotation is placed                                                      |
| X           | double              | ✅        | X coordinate of the annotation (in % of the page width from 0 to 100) from the top left corner  |
| Y           | double              | ✅        | Y coordinate of the annotation (in % of the page height from 0 to 100) from the top left corner |
| Width       | double              | ✅        | Width of the annotation (in % of the page width from 0 to 100)                                  |
| Height      | double              | ✅        | Height of the annotation (in % of the page height from 0 to 100)                                |
| Type\_      | AnnotationType      | ✅        | Type of the annotation                                                                          |
| RecipientId | string              | ❌        | ID of the recipient                                                                             |
| Required    | bool                | ❌        |                                                                                                 |
| Signature   | AnnotationSignature | ❌        | Signature annotation (null if annotation is not a signature)                                    |
| Initials    | AnnotationInitials  | ❌        | Initials annotation (null if annotation is not initials)                                        |
| Text        | AnnotationText      | ❌        | Text annotation (null if annotation is not a text)                                              |
| Datetime    | AnnotationDateTime  | ❌        | Date annotation (null if annotation is not a date)                                              |
| Checkbox    | AnnotationCheckbox  | ❌        | Checkbox annotation (null if annotation is not a checkbox)                                      |

# ListEnvelopeDocumentAnnotationsResponse

**Properties**

| Name        | Type              | Required | Description |
| :---------- | :---------------- | :------- | :---------- |
| Annotations | List\<Annotation> | ❌        |             |

# EnvelopeStatus

Status of the envelope

**Properties**

| Name       | Type   | Required | Description    |
| :--------- | :----- | :------- | :------------- |
| Draft      | string | ✅        | "DRAFT"        |
| InProgress | string | ✅        | "IN\_PROGRESS" |
| Completed  | string | ✅        | "COMPLETED"    |
| Expired    | string | ✅        | "EXPIRED"      |
| Declined   | string | ✅        | "DECLINED"     |
| Voided     | string | ✅        | "VOIDED"       |
| Pending    | string | ✅        | "PENDING"      |

# RecipientVerification

**Properties**

| Name   | Type                      | Required | Description                                                                                                                                                                                                                                          |
| :----- | :------------------------ | :------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Type\_ | RecipientVerificationType | ❌        | Type of verification the recipient must complete before accessing the envelope. - `PASSCODE`: requires a code to be entered. - `SMS`: sends a code via SMS. - `ID_VERIFICATION`: prompts the recipient to complete an automated ID and selfie check. |
| Value  | string                    | ❌        | Required for `PASSCODE` and `SMS` verification. - `PASSCODE`: code required by the recipient to sign the document. - `SMS`: recipient's phone number. - `ID_VERIFICATION`: leave empty.                                                              |

# AnnotationCheckboxStyle

Style of the checkbox

**Properties**

| Name        | Type   | Required | Description     |
| :---------- | :----- | :------- | :-------------- |
| CircleCheck | string | ✅        | "CIRCLE\_CHECK" |
| CircleFull  | string | ✅        | "CIRCLE\_FULL"  |
| SquareCheck | string | ✅        | "SQUARE\_CHECK" |
| SquareFull  | string | ✅        | "SQUARE\_FULL"  |
| CheckMark   | string | ✅        | "CHECK\_MARK"   |
| TimesSquare | string | ✅        | "TIMES\_SQUARE" |

# SigningStep

**Properties**

| Name       | Type             | Required | Description        |
| :--------- | :--------------- | :------- | :----------------- |
| Recipients | List\<Recipient> | ❌        | List of recipients |

# AnnotationDateTime

Date annotation (null if annotation is not a date)

**Properties**

| Name      | Type                     | Required | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| :-------- | :----------------------- | :------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Size      | double                   | ❌        | Font size of the text in pt                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| Font      | AnnotationFont           | ❌        |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| Color     | string                   | ❌        | Color of the text in hex format                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| AutoFill  | bool                     | ❌        | Whether the date should be automatically filled                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| Timezone  | string                   | ❌        | Timezone of the date                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| Timestamp | long                     | ❌        | Unix timestamp of the date                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| Format    | AnnotationDateTimeFormat | ❌        | Format of the date time (DMY\_NUMERIC\_SLASH is day/month/year with slashes, MDY\_NUMERIC\_SLASH is month/day/year with slashes, YMD\_NUMERIC\_SLASH is year/month/day with slashes, DMY\_NUMERIC\_DASH\_SHORT is day/month/year with dashes, DMY\_NUMERIC\_DASH is day/month/year with dashes, YMD\_NUMERIC\_DASH is year/month/day with dashes, MDY\_TEXT\_DASH\_SHORT is month/day/year with dashes, MDY\_TEXT\_SPACE\_SHORT is month/day/year with spaces, MDY\_TEXT\_SPACE is month/day/year with spaces) |

# AttachmentSettings

**Properties**

| Name                | Type | Required | Description                                         |
| :------------------ | :--- | :------- | :-------------------------------------------------- |
| VisibleToRecipients | bool | ❌        | Whether the attachment is visible to the recipients |

# CreateTemplateRequest

**Properties**

| Name | Type   | Required | Description |
| :--- | :----- | :------- | :---------- |
| Name | string | ✅        |             |

# ListTemplateDocumentsResponse

**Properties**

| Name      | Type            | Required | Description |
| :-------- | :-------------- | :------- | :---------- |
| Documents | List\<Document> | ❌        |             |

# AnnotationInitials

Initials annotation (null if annotation is not initials)

**Properties**

| Name | Type   | Required | Description                                  |
| :--- | :----- | :------- | :------------------------------------------- |
| Id   | string | ❌        | Unique identifier of the annotation initials |

# AnnotationFont

**Properties**

| Name   | Type                 | Required | Description                |
| :----- | :------------------- | :------- | :------------------------- |
| Family | AnnotationFontFamily | ❌        | Font family of the text    |
| Italic | bool                 | ❌        | Whether the text is italic |
| Bold   | bool                 | ❌        | Whether the text is bold   |

# AnnotationType

Type of the annotation

**Properties**

| Name      | Type   | Required | Description |
| :-------- | :----- | :------- | :---------- |
| Text      | string | ✅        | "TEXT"      |
| Signature | string | ✅        | "SIGNATURE" |
| Initials  | string | ✅        | "INITIALS"  |
| Checkbox  | string | ✅        | "CHECKBOX"  |
| Date      | string | ✅        | "DATE"      |

# Webhook

**Properties**

| Name    | Type         | Required | Description                      |
| :------ | :----------- | :------- | :------------------------------- |
| Id      | string       | ❌        | Unique identifier of the webhook |
| Event\_ | WebhookEvent | ❌        | Event of the webhook             |
| Target  | string       | ❌        | Target URL of the webhook        |

# RenameTemplateRequest

**Properties**

| Name | Type   | Required | Description          |
| :--- | :----- | :------- | :------------------- |
| Name | string | ✅        | Name of the template |

# ListTemplatesResponse

**Properties**

| Name            | Type            | Required | Description                      |
| :-------------- | :-------------- | :------- | :------------------------------- |
| HasNextPage     | bool            | ❌        | Whether there is a next page     |
| HasPreviousPage | bool            | ❌        | Whether there is a previous page |
| Templates       | List\<Template> | ❌        |                                  |

# EnvelopeAttachments

**Properties**

| Name       | Type                                      | Required | Description |
| :--------- | :---------------------------------------- | :------- | :---------- |
| Settings   | AttachmentSettings                        | ❌        |             |
| Recipients | List\<AttachmentPlaceholdersPerRecipient> | ❌        |             |

# RecipientRole

Role of the recipient (SIGNER signs the document, RECEIVES\_COPY receives a copy of the document, IN\_PERSON\_SIGNER signs the document in person, SENDER sends the document)

**Properties**

| Name           | Type   | Required | Description          |
| :------------- | :----- | :------- | :------------------- |
| Signer         | string | ✅        | "SIGNER"             |
| ReceivesCopy   | string | ✅        | "RECEIVES\_COPY"     |
| InPersonSigner | string | ✅        | "IN\_PERSON\_SIGNER" |

# Annotation

**Properties**

| Name        | Type                | Required | Description                                                                                     |
| :---------- | :------------------ | :------- | :---------------------------------------------------------------------------------------------- |
| Id          | string              | ❌        | Unique identifier of the annotation                                                             |
| RecipientId | string              | ❌        | ID of the recipient                                                                             |
| DocumentId  | string              | ❌        | ID of the document                                                                              |
| Page        | long                | ❌        | Page number where the annotation is placed                                                      |
| X           | double              | ❌        | X coordinate of the annotation (in % of the page width from 0 to 100) from the top left corner  |
| Y           | double              | ❌        | Y coordinate of the annotation (in % of the page height from 0 to 100) from the top left corner |
| Width       | double              | ❌        | Width of the annotation (in % of the page width from 0 to 100)                                  |
| Height      | double              | ❌        | Height of the annotation (in % of the page height from 0 to 100)                                |
| Required    | bool                | ❌        | Whether the annotation is required                                                              |
| Type\_      | AnnotationType      | ❌        | Type of the annotation                                                                          |
| Signature   | AnnotationSignature | ❌        | Signature annotation (null if annotation is not a signature)                                    |
| Initials    | AnnotationInitials  | ❌        | Initials annotation (null if annotation is not initials)                                        |
| Text        | AnnotationText      | ❌        | Text annotation (null if annotation is not a text)                                              |
| Datetime    | AnnotationDateTime  | ❌        | Date annotation (null if annotation is not a date)                                              |
| Checkbox    | AnnotationCheckbox  | ❌        | Checkbox annotation (null if annotation is not a checkbox)                                      |

# DynamicField

**Properties**

| Name  | Type   | Required | Description                |
| :---- | :----- | :------- | :------------------------- |
| Name  | string | ❌        | Name of the dynamic field  |
| Value | string | ❌        | Value of the dynamic field |

# AnnotationDateTimeFormat

Format of the date time (DMY\_NUMERIC\_SLASH is day/month/year with slashes, MDY\_NUMERIC\_SLASH is month/day/year with slashes, YMD\_NUMERIC\_SLASH is year/month/day with slashes, DMY\_NUMERIC\_DASH\_SHORT is day/month/year with dashes, DMY\_NUMERIC\_DASH is day/month/year with dashes, YMD\_NUMERIC\_DASH is year/month/day with dashes, MDY\_TEXT\_DASH\_SHORT is month/day/year with dashes, MDY\_TEXT\_SPACE\_SHORT is month/day/year with spaces, MDY\_TEXT\_SPACE is month/day/year with spaces)

**Properties**

| Name                | Type   | Required | Description                 |
| :------------------ | :----- | :------- | :-------------------------- |
| DmyNumericSlash     | string | ✅        | "DMY\_NUMERIC\_SLASH"       |
| MdyNumericSlash     | string | ✅        | "MDY\_NUMERIC\_SLASH"       |
| YmdNumericSlash     | string | ✅        | "YMD\_NUMERIC\_SLASH"       |
| DmyNumericDashShort | string | ✅        | "DMY\_NUMERIC\_DASH\_SHORT" |
| DmyNumericDash      | string | ✅        | "DMY\_NUMERIC\_DASH"        |
| YmdNumericDash      | string | ✅        | "YMD\_NUMERIC\_DASH"        |
| MdyTextDashShort    | string | ✅        | "MDY\_TEXT\_DASH\_SHORT"    |
| MdyTextSpaceShort   | string | ✅        | "MDY\_TEXT\_SPACE\_SHORT"   |
| MdyTextSpace        | string | ✅        | "MDY\_TEXT\_SPACE"          |

# EnvelopeFlowType

Flow type of the envelope (REQUEST\_SIGNATURE is a request for signature, SIGN\_MYSELF is a self-signing flow)

**Properties**

| Name             | Type   | Required | Description          |
| :--------------- | :----- | :------- | :------------------- |
| RequestSignature | string | ✅        | "REQUEST\_SIGNATURE" |
| SignMyself       | string | ✅        | "SIGN\_MYSELF"       |

# EnvelopeLegalityLevel

Legal level of the envelope (SES is Simple Electronic Signature, QES\_EIDAS is Qualified Electronic Signature, QES\_ZERTES is Qualified Electronic Signature with Zertes)

**Properties**

| Name      | Type   | Required | Description   |
| :-------- | :----- | :------- | :------------ |
| Ses       | string | ✅        | "SES"         |
| QesEidas  | string | ✅        | "QES\_EIDAS"  |
| QesZertes | string | ✅        | "QES\_ZERTES" |

# TemplateRecipientRole

Role of the recipient (SIGNER signs the document, RECEIVES\_COPY receives a copy of the document, IN\_PERSON\_SIGNER signs the document in person, SENDER sends the document)

**Properties**

| Name           | Type   | Required | Description          |
| :------------- | :----- | :------- | :------------------- |
| Signer         | string | ✅        | "SIGNER"             |
| ReceivesCopy   | string | ✅        | "RECEIVES\_COPY"     |
| InPersonSigner | string | ✅        | "IN\_PERSON\_SIGNER" |
| Sender         | string | ✅        | "SENDER"             |

# AttachmentPlaceholderRequest

**Properties**

| Name        | Type   | Required | Description                                    |
| :---------- | :----- | :------- | :--------------------------------------------- |
| RecipientId | string | ✅        | ID of the recipient                            |
| Name        | string | ✅        |                                                |
| Required    | bool   | ✅        | Whether the attachment placeholder is required |
| Multiple    | bool   | ✅        |                                                |
| Id          | string | ❌        | ID of the attachment placeholder               |
| Hint        | string | ❌        | Hint of the attachment placeholder             |

# SetEnvelopeDynamicFieldsRequest

**Properties**

| Name          | Type                | Required | Description            |
| :------------ | :------------------ | :------- | :--------------------- |
| DynamicFields | List\<DynamicField> | ✅        | List of dynamic fields |

# Page

**Properties**

| Name   | Type | Required | Description                  |
| :----- | :--- | :------- | :--------------------------- |
| Width  | long | ❌        | Width of the page in pixels  |
| Height | long | ❌        | Height of the page in pixels |

# TemplateSigningStep

**Properties**

| Name       | Type                     | Required | Description        |
| :--------- | :----------------------- | :------- | :----------------- |
| Recipients | List\<TemplateRecipient> | ❌        | List of recipients |

# AttachmentPlaceholdersPerRecipient

**Properties**

| Name          | Type                         | Required | Description           |
| :------------ | :--------------------------- | :------- | :-------------------- |
| RecipientId   | string                       | ❌        | ID of the recipient   |
| RecipientName | string                       | ❌        | Name of the recipient |
| Placeholders  | List\<AttachmentPlaceholder> | ❌        |                       |

# ListEnvelopesResponse

**Properties**

| Name            | Type            | Required | Description                      |
| :-------------- | :-------------- | :------- | :------------------------------- |
| HasNextPage     | bool            | ❌        | Whether there is a next page     |
| HasPreviousPage | bool            | ❌        | Whether there is a previous page |
| Envelopes       | List\<Envelope> | ❌        |                                  |

# Recipient

**Properties**

| Name         | Type                  | Required | Description                                                                                                                                                                   |
| :----------- | :-------------------- | :------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Name         | string                | ✅        | Name of the recipient                                                                                                                                                         |
| Email        | string                | ✅        | Email of the recipient                                                                                                                                                        |
| Role         | RecipientRole         | ✅        | Role of the recipient (SIGNER signs the document, RECEIVES\_COPY receives a copy of the document, IN\_PERSON\_SIGNER signs the document in person, SENDER sends the document) |
| Id           | string                | ❌        | Unique identifier of the recipient                                                                                                                                            |
| Uid          | string                | ❌        | Unique identifier of the user associated with the recipient                                                                                                                   |
| Verification | RecipientVerification | ❌        |                                                                                                                                                                               |

# WebhookEvent

Event of the webhook

**Properties**

| Name               | Type   | Required | Description              |
| :----------------- | :----- | :------- | :----------------------- |
| EnvelopeExpired    | string | ✅        | "ENVELOPE\_EXPIRED"      |
| EnvelopeDeclined   | string | ✅        | "ENVELOPE\_DECLINED"     |
| EnvelopeVoided     | string | ✅        | "ENVELOPE\_VOIDED"       |
| EnvelopeCompleted  | string | ✅        | "ENVELOPE\_COMPLETED"    |
| EnvelopeAuditTrail | string | ✅        | "ENVELOPE\_AUDIT\_TRAIL" |

# CreateWebhookRequest

**Properties**

| Name    | Type         | Required | Description               |
| :------ | :----------- | :------- | :------------------------ |
| Event\_ | WebhookEvent | ✅        | Event of the webhook      |
| Target  | string       | ✅        | URL of the webhook target |

# CreateEnvelopeFromTemplateRequest

**Properties**

| Name    | Type   | Required | Description                                     |
| :------ | :----- | :------- | :---------------------------------------------- |
| Name    | string | ✅        | Name of the envelope                            |
| Comment | string | ❌        | Comment for the envelope                        |
| Sandbox | bool   | ❌        | Whether the envelope is created in sandbox mode |

# ListTemplateAnnotationsResponse

**Properties**

| Name        | Type              | Required | Description |
| :---------- | :---------------- | :------- | :---------- |
| Annotations | List\<Annotation> | ❌        |             |

# RenameEnvelopeRequest

**Properties**

| Name | Type   | Required | Description          |
| :--- | :----- | :------- | :------------------- |
| Name | string | ❌        | Name of the envelope |

# ListTemplateDocumentAnnotationsResponse

**Properties**

| Name        | Type              | Required | Description |
| :---------- | :---------------- | :------- | :---------- |
| Annotations | List\<Annotation> | ❌        |             |

# ListEnvelopeDocumentsResponse

**Properties**

| Name      | Type            | Required | Description |
| :-------- | :-------------- | :------- | :---------- |
| Documents | List\<Document> | ❌        |             |

# ListWebhooksResponse

**Properties**

| Name     | Type           | Required | Description |
| :------- | :------------- | :------- | :---------- |
| Webhooks | List\<Webhook> | ❌        |             |

# AnnotationSignature

Signature annotation (null if annotation is not a signature)

**Properties**

| Name | Type   | Required | Description                                   |
| :--- | :----- | :------- | :-------------------------------------------- |
| Id   | string | ❌        | Unique identifier of the annotation signature |