diff --git a/.github/workflows/github-actions.yml b/.github/workflows/github-actions.yml
index a4f54be..1046c5f 100644
--- a/.github/workflows/github-actions.yml
+++ b/.github/workflows/github-actions.yml
@@ -19,6 +19,9 @@ jobs:
- name: Build SDK
run: ./run-build
+ env:
+ DOCKER_USERNAME: ${{secrets.DOCKER_USERNAME}}
+ DOCKER_TOKEN: ${{secrets.DOCKER_TOKEN}}
- name: Ensure no changes in Generated Code
run: ./bin/check-clean-git-status
diff --git a/README.md b/README.md
index 3fbc810..4991dc4 100644
--- a/README.md
+++ b/README.md
@@ -23,7 +23,7 @@ directory that corresponds to the file you want updated.
This C# SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 3.0.0
-- SDK version: 1.6.1
+- SDK version: 1.7.0
- Generator version: 7.8.0
- Build package: org.openapitools.codegen.languages.CSharpClientCodegen
@@ -141,6 +141,11 @@ Class | Method | HTTP request | Description
*BulkSendJobApi* | [**BulkSendJobList**](docs/BulkSendJobApi.md#bulksendjoblist) | **GET** /bulk_send_job/list | List Bulk Send Jobs
*EmbeddedApi* | [**EmbeddedEditUrl**](docs/EmbeddedApi.md#embeddedediturl) | **POST** /embedded/edit_url/{template_id} | Get Embedded Template Edit URL
*EmbeddedApi* | [**EmbeddedSignUrl**](docs/EmbeddedApi.md#embeddedsignurl) | **GET** /embedded/sign_url/{signature_id} | Get Embedded Sign URL
+*FaxApi* | [**FaxDelete**](docs/FaxApi.md#faxdelete) | **DELETE** /fax/{fax_id} | Delete Fax
+*FaxApi* | [**FaxFiles**](docs/FaxApi.md#faxfiles) | **GET** /fax/files/{fax_id} | List Fax Files
+*FaxApi* | [**FaxGet**](docs/FaxApi.md#faxget) | **GET** /fax/{fax_id} | Get Fax
+*FaxApi* | [**FaxList**](docs/FaxApi.md#faxlist) | **GET** /fax/list | Lists Faxes
+*FaxApi* | [**FaxSend**](docs/FaxApi.md#faxsend) | **POST** /fax/send | Send Fax
*FaxLineApi* | [**FaxLineAddUser**](docs/FaxLineApi.md#faxlineadduser) | **PUT** /fax_line/add_user | Add Fax Line User
*FaxLineApi* | [**FaxLineAreaCodeGet**](docs/FaxLineApi.md#faxlineareacodeget) | **GET** /fax_line/area_codes | Get Available Fax Line Area Codes
*FaxLineApi* | [**FaxLineCreate**](docs/FaxLineApi.md#faxlinecreate) | **POST** /fax_line/create | Purchase Fax Line
@@ -178,7 +183,7 @@ Class | Method | HTTP request | Description
*TeamApi* | [**TeamSubTeams**](docs/TeamApi.md#teamsubteams) | **GET** /team/sub_teams/{team_id} | List Sub Teams
*TeamApi* | [**TeamUpdate**](docs/TeamApi.md#teamupdate) | **PUT** /team | Update Team
*TemplateApi* | [**TemplateAddUser**](docs/TemplateApi.md#templateadduser) | **POST** /template/add_user/{template_id} | Add User to Template
-*TemplateApi* | [**TemplateCreate**](docs/TemplateApi.md#templatecreate) | **POST** /template/create | Create Template
+*TemplateApi* | [**TemplateCreate**](docs/TemplateApi.md#templatecreate) | **POST** /template/create | Create Template
*TemplateApi* | [**TemplateCreateEmbeddedDraft**](docs/TemplateApi.md#templatecreateembeddeddraft) | **POST** /template/create_embedded_draft | Create Embedded Template Draft
*TemplateApi* | [**TemplateDelete**](docs/TemplateApi.md#templatedelete) | **POST** /template/delete/{template_id} | Delete Template
*TemplateApi* | [**TemplateFiles**](docs/TemplateApi.md#templatefiles) | **GET** /template/files/{template_id} | Get Template Files
@@ -231,6 +236,7 @@ Class | Method | HTTP request | Description
- [Model.EventCallbackRequest](docs/EventCallbackRequest.md)
- [Model.EventCallbackRequestEvent](docs/EventCallbackRequestEvent.md)
- [Model.EventCallbackRequestEventMetadata](docs/EventCallbackRequestEventMetadata.md)
+ - [Model.FaxGetResponse](docs/FaxGetResponse.md)
- [Model.FaxLineAddUserRequest](docs/FaxLineAddUserRequest.md)
- [Model.FaxLineAreaCodeGetCountryEnum](docs/FaxLineAreaCodeGetCountryEnum.md)
- [Model.FaxLineAreaCodeGetProvinceEnum](docs/FaxLineAreaCodeGetProvinceEnum.md)
@@ -242,6 +248,10 @@ Class | Method | HTTP request | Description
- [Model.FaxLineRemoveUserRequest](docs/FaxLineRemoveUserRequest.md)
- [Model.FaxLineResponse](docs/FaxLineResponse.md)
- [Model.FaxLineResponseFaxLine](docs/FaxLineResponseFaxLine.md)
+ - [Model.FaxListResponse](docs/FaxListResponse.md)
+ - [Model.FaxResponse](docs/FaxResponse.md)
+ - [Model.FaxResponseTransmission](docs/FaxResponseTransmission.md)
+ - [Model.FaxSendRequest](docs/FaxSendRequest.md)
- [Model.FileResponse](docs/FileResponse.md)
- [Model.FileResponseDataUri](docs/FileResponseDataUri.md)
- [Model.ListInfoResponse](docs/ListInfoResponse.md)
diff --git a/VERSION b/VERSION
index 9c6d629..bd8bf88 100644
--- a/VERSION
+++ b/VERSION
@@ -1 +1 @@
-1.6.1
+1.7.0
diff --git a/docs/AccountResponseQuotas.md b/docs/AccountResponseQuotas.md
index 2e12ea8..8fc9dcf 100644
--- a/docs/AccountResponseQuotas.md
+++ b/docs/AccountResponseQuotas.md
@@ -5,7 +5,7 @@ Details concerning remaining monthly quotas.
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**ApiSignatureRequestsLeft** | **int?** | API signature requests remaining. | [optional] **DocumentsLeft** | **int?** | Signature requests remaining. | [optional] **TemplatesTotal** | **int?** | Total API templates allowed. | [optional] **TemplatesLeft** | **int?** | API templates remaining. | [optional] **SmsVerificationsLeft** | **int?** | SMS verifications remaining. | [optional] **NumFaxPagesLeft** | **int?** | Number of fax pages left | [optional]
+**ApiSignatureRequestsLeft** | **int?** | API signature requests remaining. | [optional] **DocumentsLeft** | **int?** | Signature requests remaining. | [optional] **TemplatesTotal** | **int?** | Total API templates allowed. | [optional] **TemplatesLeft** | **int?** | API templates remaining. | [optional] **SmsVerificationsLeft** | **int?** | SMS verifications remaining. | [optional] **NumFaxPagesLeft** | **int?** | Number of fax pages left | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
diff --git a/docs/FaxApi.md b/docs/FaxApi.md
new file mode 100644
index 0000000..303d4ef
--- /dev/null
+++ b/docs/FaxApi.md
@@ -0,0 +1,489 @@
+# Dropbox.Sign.Api.FaxApi
+
+All URIs are relative to *https://api.hellosign.com/v3*
+
+| Method | HTTP request | Description |
+|--------|--------------|-------------|
+| [**FaxDelete**](FaxApi.md#faxdelete) | **DELETE** /fax/{fax_id} | Delete Fax |
+| [**FaxFiles**](FaxApi.md#faxfiles) | **GET** /fax/files/{fax_id} | List Fax Files |
+| [**FaxGet**](FaxApi.md#faxget) | **GET** /fax/{fax_id} | Get Fax |
+| [**FaxList**](FaxApi.md#faxlist) | **GET** /fax/list | Lists Faxes |
+| [**FaxSend**](FaxApi.md#faxsend) | **POST** /fax/send | Send Fax |
+
+
+# **FaxDelete**
+> void FaxDelete (string faxId)
+
+Delete Fax
+
+Deletes the specified Fax from the system.
+
+### Example
+```csharp
+using System;
+using System.Collections.Generic;
+using System.IO;
+using Dropbox.Sign.Api;
+using Dropbox.Sign.Client;
+using Dropbox.Sign.Model;
+
+public class Example
+{
+ public static void Main()
+ {
+ var config = new Configuration();
+ config.Username = "YOUR_API_KEY";
+
+ var faxApi = new FaxApi(config);
+
+ try
+ {
+ faxApi.FaxDelete("fa5c8a0b0f492d768749333ad6fcc214c111e967");
+ }
+ catch (ApiException e)
+ {
+ Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message);
+ Console.WriteLine("Status Code: " + e.ErrorCode);
+ Console.WriteLine(e.StackTrace);
+ }
+ }
+}
+
+```
+
+#### Using the FaxDeleteWithHttpInfo variant
+This returns an ApiResponse object which contains the response data, status code and headers.
+
+```csharp
+try
+{
+ // Delete Fax
+ apiInstance.FaxDeleteWithHttpInfo(faxId);
+}
+catch (ApiException e)
+{
+ Debug.Print("Exception when calling FaxApi.FaxDeleteWithHttpInfo: " + e.Message);
+ Debug.Print("Status Code: " + e.ErrorCode);
+ Debug.Print(e.StackTrace);
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------|------|-------------|-------|
+| **faxId** | **string** | Fax ID | |
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **204** | successful operation | * X-RateLimit-Limit - * X-RateLimit-Remaining - * X-Ratelimit-Reset - |
+| **4XX** | failed_operation | - |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+
+# **FaxFiles**
+> System.IO.Stream FaxFiles (string faxId)
+
+List Fax Files
+
+Returns list of fax files
+
+### Example
+```csharp
+using System;
+using System.Collections.Generic;
+using System.IO;
+using Dropbox.Sign.Api;
+using Dropbox.Sign.Client;
+using Dropbox.Sign.Model;
+
+public class Example
+{
+ public static void Main()
+ {
+ var config = new Configuration();
+ config.Username = "YOUR_API_KEY";
+
+ var faxApi = new FaxApi(config);
+
+ var faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967";
+
+ try
+ {
+ var result = faxApi.FaxFiles(faxId);
+ var fileStream = File.Create("file_response.pdf");
+ result.Seek(0, SeekOrigin.Begin);
+ result.CopyTo(fileStream);
+ fileStream.Close();
+ }
+ catch (ApiException e)
+ {
+ Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message);
+ Console.WriteLine("Status Code: " + e.ErrorCode);
+ Console.WriteLine(e.StackTrace);
+ }
+ }
+}
+
+```
+
+#### Using the FaxFilesWithHttpInfo variant
+This returns an ApiResponse object which contains the response data, status code and headers.
+
+```csharp
+try
+{
+ // List Fax Files
+ ApiResponse response = apiInstance.FaxFilesWithHttpInfo(faxId);
+ Debug.Write("Status Code: " + response.StatusCode);
+ Debug.Write("Response Headers: " + response.Headers);
+ Debug.Write("Response Body: " + response.Data);
+}
+catch (ApiException e)
+{
+ Debug.Print("Exception when calling FaxApi.FaxFilesWithHttpInfo: " + e.Message);
+ Debug.Print("Status Code: " + e.ErrorCode);
+ Debug.Print(e.StackTrace);
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------|------|-------------|-------|
+| **faxId** | **string** | Fax ID | |
+
+### Return type
+
+**System.IO.Stream**
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/pdf, application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | successful operation | * X-RateLimit-Limit - * X-RateLimit-Remaining - * X-Ratelimit-Reset - |
+| **4XX** | failed_operation | - |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+
+# **FaxGet**
+> FaxGetResponse FaxGet (string faxId)
+
+Get Fax
+
+Returns information about fax
+
+### Example
+```csharp
+using System;
+
+using Dropbox.Sign.Api;
+using Dropbox.Sign.Client;
+using Dropbox.Sign.Model;
+
+public class Example
+{
+ public static void Main()
+ {
+ var config = new Configuration();
+ // Configure HTTP basic authorization: api_key
+ config.Username = "YOUR_API_KEY";
+
+ var faxApi = new FaxApi(config);
+
+ var faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967";
+
+ try
+ {
+ var result = faxApi.FaxGet(faxId);
+ Console.WriteLine(result);
+ }
+ catch (ApiException e)
+ {
+ Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message);
+ Console.WriteLine("Status Code: " + e.ErrorCode);
+ Console.WriteLine(e.StackTrace);
+ }
+ }
+}
+
+```
+
+#### Using the FaxGetWithHttpInfo variant
+This returns an ApiResponse object which contains the response data, status code and headers.
+
+```csharp
+try
+{
+ // Get Fax
+ ApiResponse response = apiInstance.FaxGetWithHttpInfo(faxId);
+ Debug.Write("Status Code: " + response.StatusCode);
+ Debug.Write("Response Headers: " + response.Headers);
+ Debug.Write("Response Body: " + response.Data);
+}
+catch (ApiException e)
+{
+ Debug.Print("Exception when calling FaxApi.FaxGetWithHttpInfo: " + e.Message);
+ Debug.Print("Status Code: " + e.ErrorCode);
+ Debug.Print(e.StackTrace);
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------|------|-------------|-------|
+| **faxId** | **string** | Fax ID | |
+
+### Return type
+
+[**FaxGetResponse**](FaxGetResponse.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | successful operation | * X-RateLimit-Limit - * X-RateLimit-Remaining - * X-Ratelimit-Reset - |
+| **4XX** | failed_operation | - |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+
+# **FaxList**
+> FaxListResponse FaxList (int? page = null, int? pageSize = null)
+
+Lists Faxes
+
+Returns properties of multiple faxes
+
+### Example
+```csharp
+using System;
+
+using Dropbox.Sign.Api;
+using Dropbox.Sign.Client;
+using Dropbox.Sign.Model;
+
+public class Example
+{
+ public static void Main()
+ {
+ var config = new Configuration();
+ // Configure HTTP basic authorization: api_key
+ config.Username = "YOUR_API_KEY";
+
+ var faxApi = new FaxApi(config);
+
+ var page = 1;
+ var pageSize = 2;
+
+ try
+ {
+ var result = faxApi.FaxList(page, pageSize);
+ Console.WriteLine(result);
+ }
+ catch (ApiException e)
+ {
+ Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message);
+ Console.WriteLine("Status Code: " + e.ErrorCode);
+ Console.WriteLine(e.StackTrace);
+ }
+ }
+}
+
+```
+
+#### Using the FaxListWithHttpInfo variant
+This returns an ApiResponse object which contains the response data, status code and headers.
+
+```csharp
+try
+{
+ // Lists Faxes
+ ApiResponse response = apiInstance.FaxListWithHttpInfo(page, pageSize);
+ Debug.Write("Status Code: " + response.StatusCode);
+ Debug.Write("Response Headers: " + response.Headers);
+ Debug.Write("Response Body: " + response.Data);
+}
+catch (ApiException e)
+{
+ Debug.Print("Exception when calling FaxApi.FaxListWithHttpInfo: " + e.Message);
+ Debug.Print("Status Code: " + e.ErrorCode);
+ Debug.Print(e.StackTrace);
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------|------|-------------|-------|
+| **page** | **int?** | Page | [optional] [default to 1] |
+| **pageSize** | **int?** | Page size | [optional] [default to 20] |
+
+### Return type
+
+[**FaxListResponse**](FaxListResponse.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | successful operation | * X-RateLimit-Limit - * X-RateLimit-Remaining - * X-Ratelimit-Reset - |
+| **4XX** | failed_operation | - |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+
+# **FaxSend**
+> FaxGetResponse FaxSend (FaxSendRequest faxSendRequest)
+
+Send Fax
+
+Action to prepare and send a fax
+
+### Example
+```csharp
+using System;
+using System.Collections.Generic;
+using System.IO;
+using Dropbox.Sign.Api;
+using Dropbox.Sign.Client;
+using Dropbox.Sign.Model;
+
+public class Example
+{
+ public static void Main()
+ {
+ var config = new Configuration();
+ config.Username = "YOUR_API_KEY";
+
+ var faxApi = new FaxApi(config);
+
+ var files = new List {
+ new FileStream(
+ "./example_fax.pdf",
+ FileMode.Open,
+ FileAccess.Read,
+ FileShare.Read
+ )
+ };
+
+ var data = new FaxSendRequest(
+ files: files,
+ testMode: true,
+ recipient: "16690000001",
+ sender: "16690000000",
+ coverPageTo: "Jill Fax",
+ coverPageMessage: "I'm sending you a fax!",
+ coverPageFrom: "Faxer Faxerson",
+ title: "This is what the fax is about!",
+ );
+
+ try
+ {
+ var result = faxApi.FaxSend(data);
+ Console.WriteLine(result);
+ }
+ catch (ApiException e)
+ {
+ Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message);
+ Console.WriteLine("Status Code: " + e.ErrorCode);
+ Console.WriteLine(e.StackTrace);
+ }
+ }
+}
+
+```
+
+#### Using the FaxSendWithHttpInfo variant
+This returns an ApiResponse object which contains the response data, status code and headers.
+
+```csharp
+try
+{
+ // Send Fax
+ ApiResponse response = apiInstance.FaxSendWithHttpInfo(faxSendRequest);
+ Debug.Write("Status Code: " + response.StatusCode);
+ Debug.Write("Response Headers: " + response.Headers);
+ Debug.Write("Response Body: " + response.Data);
+}
+catch (ApiException e)
+{
+ Debug.Print("Exception when calling FaxApi.FaxSendWithHttpInfo: " + e.Message);
+ Debug.Print("Status Code: " + e.ErrorCode);
+ Debug.Print(e.StackTrace);
+}
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+|------|------|-------------|-------|
+| **faxSendRequest** | [**FaxSendRequest**](FaxSendRequest.md) | | |
+
+### Return type
+
+[**FaxGetResponse**](FaxGetResponse.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, multipart/form-data
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | successful operation | * X-RateLimit-Limit - * X-RateLimit-Remaining - * X-Ratelimit-Reset - |
+| **4XX** | failed_operation | - |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
diff --git a/docs/FaxGetResponse.md b/docs/FaxGetResponse.md
new file mode 100644
index 0000000..42b82e1
--- /dev/null
+++ b/docs/FaxGetResponse.md
@@ -0,0 +1,10 @@
+# Dropbox.Sign.Model.FaxGetResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**Fax** | [**FaxResponse**](FaxResponse.md) | | **Warnings** | [**List<WarningResponse>**](WarningResponse.md) | A list of warnings. | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
diff --git a/docs/FaxListResponse.md b/docs/FaxListResponse.md
new file mode 100644
index 0000000..1cea114
--- /dev/null
+++ b/docs/FaxListResponse.md
@@ -0,0 +1,10 @@
+# Dropbox.Sign.Model.FaxListResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**Faxes** | [**List<FaxResponse>**](FaxResponse.md) | | **ListInfo** | [**ListInfoResponse**](ListInfoResponse.md) | |
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
diff --git a/docs/FaxResponse.md b/docs/FaxResponse.md
new file mode 100644
index 0000000..27a0614
--- /dev/null
+++ b/docs/FaxResponse.md
@@ -0,0 +1,10 @@
+# Dropbox.Sign.Model.FaxResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**FaxId** | **string** | Fax ID | **Title** | **string** | Fax Title | **OriginalTitle** | **string** | Fax Original Title | **Subject** | **string** | Fax Subject | **Message** | **string** | Fax Message | **Metadata** | **Dictionary<string, Object>** | Fax Metadata | **CreatedAt** | **int** | Fax Created At Timestamp | **Sender** | **string** | Fax Sender Email | **Transmissions** | [**List<FaxResponseTransmission>**](FaxResponseTransmission.md) | Fax Transmissions List | **FilesUrl** | **string** | Fax Files URL |
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
diff --git a/docs/FaxResponseTransmission.md b/docs/FaxResponseTransmission.md
new file mode 100644
index 0000000..c306b85
--- /dev/null
+++ b/docs/FaxResponseTransmission.md
@@ -0,0 +1,10 @@
+# Dropbox.Sign.Model.FaxResponseTransmission
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**Recipient** | **string** | Fax Transmission Recipient | **Sender** | **string** | Fax Transmission Sender | **StatusCode** | **string** | Fax Transmission Status Code | **SentAt** | **int** | Fax Transmission Sent Timestamp | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
diff --git a/docs/FaxSendRequest.md b/docs/FaxSendRequest.md
new file mode 100644
index 0000000..b02d7f0
--- /dev/null
+++ b/docs/FaxSendRequest.md
@@ -0,0 +1,10 @@
+# Dropbox.Sign.Model.FaxSendRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**Recipient** | **string** | Fax Send To Recipient | **Sender** | **string** | Fax Send From Sender (used only with fax number) | [optional] **Files** | **List<System.IO.Stream>** | Fax File to Send | [optional] **FileUrls** | **List<string>** | Fax File URL to Send | [optional] **TestMode** | **bool** | API Test Mode Setting | [optional] [default to false]**CoverPageTo** | **string** | Fax Cover Page for Recipient | [optional] **CoverPageFrom** | **string** | Fax Cover Page for Sender | [optional] **CoverPageMessage** | **string** | Fax Cover Page Message | [optional] **Title** | **string** | Fax Title | [optional]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
diff --git a/docs/OAuthApi.md b/docs/OAuthApi.md
index 5af9123..c80ee27 100644
--- a/docs/OAuthApi.md
+++ b/docs/OAuthApi.md
@@ -99,6 +99,7 @@ No authorization required
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | successful operation | * X-RateLimit-Limit - * X-RateLimit-Remaining - * X-Ratelimit-Reset - |
+| **4XX** | failed_operation | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
@@ -191,6 +192,7 @@ No authorization required
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | successful operation | * X-RateLimit-Limit - * X-RateLimit-Remaining - * X-Ratelimit-Reset - |
+| **4XX** | failed_operation | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
diff --git a/docs/OAuthTokenRefreshRequest.md b/docs/OAuthTokenRefreshRequest.md
index c9866d3..5e33e77 100644
--- a/docs/OAuthTokenRefreshRequest.md
+++ b/docs/OAuthTokenRefreshRequest.md
@@ -4,7 +4,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**GrantType** | **string** | When refreshing an existing token use `refresh_token`. | [default to "refresh_token"]**RefreshToken** | **string** | The token provided when you got the expired access token. |
+**GrantType** | **string** | When refreshing an existing token use `refresh_token`. | [default to "refresh_token"]**RefreshToken** | **string** | The token provided when you got the expired access token. | **ClientId** | **string** | The client ID for your API app. Mandatory from August 1st, 2025. Until then, required if the "Client Credentials Required" setting is enabled for token refresh; optional if disabled. | [optional] **ClientSecret** | **string** | The client secret for your API app. Mandatory from August 1st, 2025. Until then, required if the "Client Credentials Required" setting is enabled for token refresh; optional if disabled. | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
diff --git a/docs/SignatureRequestApi.md b/docs/SignatureRequestApi.md
index c411d0c..a507cc0 100644
--- a/docs/SignatureRequestApi.md
+++ b/docs/SignatureRequestApi.md
@@ -312,7 +312,7 @@ catch (ApiException e)
Cancel Incomplete Signature Request
-Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`.
+Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`.
### Example
```csharp
diff --git a/docs/SubWhiteLabelingOptions.md b/docs/SubWhiteLabelingOptions.md
index 930a345..1634a1a 100644
--- a/docs/SubWhiteLabelingOptions.md
+++ b/docs/SubWhiteLabelingOptions.md
@@ -5,7 +5,7 @@ An array of elements and values serialized to a string, to be used to customize
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**HeaderBackgroundColor** | **string** | | [optional] [default to "#1A1A1A"]**LegalVersion** | **string** | | [optional] [default to LegalVersionEnum.Terms1]**LinkColor** | **string** | | [optional] [default to "#00B3E6"]**PageBackgroundColor** | **string** | | [optional] [default to "#F7F8F9"]**PrimaryButtonColor** | **string** | | [optional] [default to "#00B3E6"]**PrimaryButtonColorHover** | **string** | | [optional] [default to "#00B3E6"]**PrimaryButtonTextColor** | **string** | | [optional] [default to "#FFFFFF"]**PrimaryButtonTextColorHover** | **string** | | [optional] [default to "#FFFFFF"]**SecondaryButtonColor** | **string** | | [optional] [default to "#FFFFFF"]**SecondaryButtonColorHover** | **string** | | [optional] [default to "#FFFFFF"]**SecondaryButtonTextColor** | **string** | | [optional] [default to "#00B3E6"]**SecondaryButtonTextColorHover** | **string** | | [optional] [default to "#00B3E6"]**TextColor1** | **string** | | [optional] [default to "#808080"]**TextColor2** | **string** | | [optional] [default to "#FFFFFF"]**ResetToDefault** | **bool** | Resets white labeling options to defaults. Only useful when updating an API App. | [optional]
+**HeaderBackgroundColor** | **string** | | [optional] [default to "#1a1a1a"]**LegalVersion** | **string** | | [optional] [default to LegalVersionEnum.Terms1]**LinkColor** | **string** | | [optional] [default to "#0061FE"]**PageBackgroundColor** | **string** | | [optional] [default to "#f7f8f9"]**PrimaryButtonColor** | **string** | | [optional] [default to "#0061FE"]**PrimaryButtonColorHover** | **string** | | [optional] [default to "#0061FE"]**PrimaryButtonTextColor** | **string** | | [optional] [default to "#ffffff"]**PrimaryButtonTextColorHover** | **string** | | [optional] [default to "#ffffff"]**SecondaryButtonColor** | **string** | | [optional] [default to "#ffffff"]**SecondaryButtonColorHover** | **string** | | [optional] [default to "#ffffff"]**SecondaryButtonTextColor** | **string** | | [optional] [default to "#0061FE"]**SecondaryButtonTextColorHover** | **string** | | [optional] [default to "#0061FE"]**TextColor1** | **string** | | [optional] [default to "#808080"]**TextColor2** | **string** | | [optional] [default to "#ffffff"]**ResetToDefault** | **bool** | Resets white labeling options to defaults. Only useful when updating an API App. | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
diff --git a/docs/TemplateApi.md b/docs/TemplateApi.md
index d7f4c3b..c51decd 100644
--- a/docs/TemplateApi.md
+++ b/docs/TemplateApi.md
@@ -5,7 +5,7 @@ All URIs are relative to *https://api.hellosign.com/v3*
| Method | HTTP request | Description |
|--------|--------------|-------------|
| [**TemplateAddUser**](TemplateApi.md#templateadduser) | **POST** /template/add_user/{template_id} | Add User to Template |
-| [**TemplateCreate**](TemplateApi.md#templatecreate) | **POST** /template/create | Create Template |
+| [**TemplateCreate**](TemplateApi.md#templatecreate) | **POST** /template/create | Create Template |
| [**TemplateCreateEmbeddedDraft**](TemplateApi.md#templatecreateembeddeddraft) | **POST** /template/create_embedded_draft | Create Embedded Template Draft |
| [**TemplateDelete**](TemplateApi.md#templatedelete) | **POST** /template/delete/{template_id} | Delete Template |
| [**TemplateFiles**](TemplateApi.md#templatefiles) | **GET** /template/files/{template_id} | Get Template Files |
@@ -120,7 +120,7 @@ catch (ApiException e)
# **TemplateCreate**
> TemplateCreateResponse TemplateCreate (TemplateCreateRequest templateCreateRequest)
-Create Template
+Create Template
Creates a template that can then be used.
@@ -214,7 +214,7 @@ This returns an ApiResponse object which contains the response data, status code
```csharp
try
{
- // Create Template
+ // Create Template
ApiResponse response = apiInstance.TemplateCreateWithHttpInfo(templateCreateRequest);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
diff --git a/docs/TemplateResponse.md b/docs/TemplateResponse.md
index ce17e37..ded2dee 100644
--- a/docs/TemplateResponse.md
+++ b/docs/TemplateResponse.md
@@ -5,7 +5,7 @@ Contains information about the templates you and your team have created.
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**TemplateId** | **string** | The id of the Template. | [optional] **Title** | **string** | The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | [optional] **Message** | **string** | The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | [optional] **UpdatedAt** | **int** | Time the template was last updated. | [optional] **IsEmbedded** | **bool?** | `true` if this template was created using an embedded flow, `false` if it was created on our website. | [optional] **IsCreator** | **bool?** | `true` if you are the owner of this template, `false` if it's been shared with you by a team member. | [optional] **CanEdit** | **bool?** | Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). | [optional] **IsLocked** | **bool?** | Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. | [optional] **Metadata** | **Object** | The metadata attached to the template. | [optional] **SignerRoles** | [**List<TemplateResponseSignerRole>**](TemplateResponseSignerRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | [optional] **CcRoles** | [**List<TemplateResponseCCRole>**](TemplateResponseCCRole.md) | An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. | [optional] **Documents** | [**List<TemplateResponseDocument>**](TemplateResponseDocument.md) | An array describing each document associated with this Template. Includes form field data for each document. | [optional] **CustomFields** | [**List<TemplateResponseDocumentCustomFieldBase>**](TemplateResponseDocumentCustomFieldBase.md) | Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | [optional] **NamedFormFields** | [**List<TemplateResponseDocumentFormFieldBase>**](TemplateResponseDocumentFormFieldBase.md) | Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | [optional] **Accounts** | [**List<TemplateResponseAccount>**](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | [optional]
+**TemplateId** | **string** | The id of the Template. | [optional] **Title** | **string** | The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | [optional] **Message** | **string** | The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | [optional] **UpdatedAt** | **int** | Time the template was last updated. | [optional] **IsEmbedded** | **bool?** | `true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template. | [optional] **IsCreator** | **bool** | `true` if you are the owner of this template, `false` if it's been shared with you by a team member. | [optional] **CanEdit** | **bool** | Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). | [optional] **IsLocked** | **bool** | Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. | [optional] **Metadata** | **Object** | The metadata attached to the template. | [optional] **SignerRoles** | [**List<TemplateResponseSignerRole>**](TemplateResponseSignerRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | [optional] **CcRoles** | [**List<TemplateResponseCCRole>**](TemplateResponseCCRole.md) | An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. | [optional] **Documents** | [**List<TemplateResponseDocument>**](TemplateResponseDocument.md) | An array describing each document associated with this Template. Includes form field data for each document. | [optional] **CustomFields** | [**List<TemplateResponseDocumentCustomFieldBase>**](TemplateResponseDocumentCustomFieldBase.md) | Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | [optional] **NamedFormFields** | [**List<TemplateResponseDocumentFormFieldBase>**](TemplateResponseDocumentFormFieldBase.md) | Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | [optional] **Accounts** | [**List<TemplateResponseAccount>**](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | [optional] **Attachments** | [**List<SignatureRequestResponseAttachment>**](SignatureRequestResponseAttachment.md) | Signer attachments. | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
diff --git a/docs/TemplateResponseDocumentFormFieldBase.md b/docs/TemplateResponseDocumentFormFieldBase.md
index 0e941c7..191f73c 100644
--- a/docs/TemplateResponseDocumentFormFieldBase.md
+++ b/docs/TemplateResponseDocumentFormFieldBase.md
@@ -5,7 +5,7 @@ An array of Form Field objects containing the name and type of each named field.
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**Type** | **string** | | **ApiId** | **string** | A unique id for the form field. | [optional] **Name** | **string** | The name of the form field. | [optional] **Signer** | **string** | The signer of the Form Field. | [optional] **X** | **int** | The horizontal offset in pixels for this form field. | [optional] **Y** | **int** | The vertical offset in pixels for this form field. | [optional] **Width** | **int** | The width in pixels of this form field. | [optional] **Height** | **int** | The height in pixels of this form field. | [optional] **Required** | **bool** | Boolean showing whether or not this field is required. | [optional] **Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | [optional]
+**Type** | **string** | | **ApiId** | **string** | A unique id for the form field. | [optional] **Name** | **string** | The name of the form field. | [optional] **Signer** | **string** | The signer of the Form Field. | [optional] **X** | **int** | The horizontal offset in pixels for this form field. | [optional] **Y** | **int** | The vertical offset in pixels for this form field. | [optional] **Width** | **int** | The width in pixels of this form field. | [optional] **Height** | **int** | The height in pixels of this form field. | [optional] **Required** | **bool** | Boolean showing whether or not this field is required. | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
diff --git a/docs/TemplateResponseDocumentFormFieldCheckbox.md b/docs/TemplateResponseDocumentFormFieldCheckbox.md
index 45636fa..4a94b37 100644
--- a/docs/TemplateResponseDocumentFormFieldCheckbox.md
+++ b/docs/TemplateResponseDocumentFormFieldCheckbox.md
@@ -13,8 +13,7 @@ Name | Type | Description | Notes
**Width** | **int** | The width in pixels of this form field. | [optional]
**Height** | **int** | The height in pixels of this form field. | [optional]
**Required** | **bool** | Boolean showing whether or not this field is required. | [optional]
-**Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | [optional]
-**Type** | **string** | The type of this form field. See [field types](/api/reference/constants/#field-types).
* Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to "checkbox"]
+**Type** | **string** | The type of this form field. See [field types](/api/reference/constants/#field-types).
* Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to "checkbox"]**Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
diff --git a/docs/TemplateResponseDocumentFormFieldDateSigned.md b/docs/TemplateResponseDocumentFormFieldDateSigned.md
index 6bf5b02..7356475 100644
--- a/docs/TemplateResponseDocumentFormFieldDateSigned.md
+++ b/docs/TemplateResponseDocumentFormFieldDateSigned.md
@@ -13,8 +13,7 @@ Name | Type | Description | Notes
**Width** | **int** | The width in pixels of this form field. | [optional]
**Height** | **int** | The height in pixels of this form field. | [optional]
**Required** | **bool** | Boolean showing whether or not this field is required. | [optional]
-**Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | [optional]
-**Type** | **string** | The type of this form field. See [field types](/api/reference/constants/#field-types).
* Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to "date_signed"]
+**Type** | **string** | The type of this form field. See [field types](/api/reference/constants/#field-types).
* Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to "date_signed"]**Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
diff --git a/docs/TemplateResponseDocumentFormFieldDropdown.md b/docs/TemplateResponseDocumentFormFieldDropdown.md
index fa94587..62b9123 100644
--- a/docs/TemplateResponseDocumentFormFieldDropdown.md
+++ b/docs/TemplateResponseDocumentFormFieldDropdown.md
@@ -13,8 +13,7 @@ Name | Type | Description | Notes
**Width** | **int** | The width in pixels of this form field. | [optional]
**Height** | **int** | The height in pixels of this form field. | [optional]
**Required** | **bool** | Boolean showing whether or not this field is required. | [optional]
-**Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | [optional]
-**Type** | **string** | The type of this form field. See [field types](/api/reference/constants/#field-types).
* Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to "dropdown"]
+**Type** | **string** | The type of this form field. See [field types](/api/reference/constants/#field-types).
* Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to "dropdown"]**Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
diff --git a/docs/TemplateResponseDocumentFormFieldHyperlink.md b/docs/TemplateResponseDocumentFormFieldHyperlink.md
index c5dc34e..51222f5 100644
--- a/docs/TemplateResponseDocumentFormFieldHyperlink.md
+++ b/docs/TemplateResponseDocumentFormFieldHyperlink.md
@@ -13,8 +13,7 @@ Name | Type | Description | Notes
**Width** | **int** | The width in pixels of this form field. | [optional]
**Height** | **int** | The height in pixels of this form field. | [optional]
**Required** | **bool** | Boolean showing whether or not this field is required. | [optional]
-**Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | [optional]
-**Type** | **string** | The type of this form field. See [field types](/api/reference/constants/#field-types).
* Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to "hyperlink"]**AvgTextLength** | [**TemplateResponseFieldAvgTextLength**](TemplateResponseFieldAvgTextLength.md) | | [optional] **IsMultiline** | **bool** | Whether this form field is multiline text. | [optional] **OriginalFontSize** | **int** | Original font size used in this form field's text. | [optional] **FontFamily** | **string** | Font family used in this form field's text. | [optional]
+**Type** | **string** | The type of this form field. See [field types](/api/reference/constants/#field-types).
* Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to "hyperlink"]**AvgTextLength** | [**TemplateResponseFieldAvgTextLength**](TemplateResponseFieldAvgTextLength.md) | | [optional] **IsMultiline** | **bool** | Whether this form field is multiline text. | [optional] **OriginalFontSize** | **int** | Original font size used in this form field's text. | [optional] **FontFamily** | **string** | Font family used in this form field's text. | [optional] **Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
diff --git a/docs/TemplateResponseDocumentFormFieldInitials.md b/docs/TemplateResponseDocumentFormFieldInitials.md
index ada79ec..d519b49 100644
--- a/docs/TemplateResponseDocumentFormFieldInitials.md
+++ b/docs/TemplateResponseDocumentFormFieldInitials.md
@@ -13,8 +13,7 @@ Name | Type | Description | Notes
**Width** | **int** | The width in pixels of this form field. | [optional]
**Height** | **int** | The height in pixels of this form field. | [optional]
**Required** | **bool** | Boolean showing whether or not this field is required. | [optional]
-**Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | [optional]
-**Type** | **string** | The type of this form field. See [field types](/api/reference/constants/#field-types).
* Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to "initials"]
+**Type** | **string** | The type of this form field. See [field types](/api/reference/constants/#field-types).
* Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to "initials"]**Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
diff --git a/docs/TemplateResponseDocumentFormFieldRadio.md b/docs/TemplateResponseDocumentFormFieldRadio.md
index abc332c..52f8772 100644
--- a/docs/TemplateResponseDocumentFormFieldRadio.md
+++ b/docs/TemplateResponseDocumentFormFieldRadio.md
@@ -13,8 +13,7 @@ Name | Type | Description | Notes
**Width** | **int** | The width in pixels of this form field. | [optional]
**Height** | **int** | The height in pixels of this form field. | [optional]
**Required** | **bool** | Boolean showing whether or not this field is required. | [optional]
-**Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | [optional]
-**Type** | **string** | The type of this form field. See [field types](/api/reference/constants/#field-types).
* Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to "radio"]
+**Type** | **string** | The type of this form field. See [field types](/api/reference/constants/#field-types).
* Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to "radio"]**Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
diff --git a/docs/TemplateResponseDocumentFormFieldSignature.md b/docs/TemplateResponseDocumentFormFieldSignature.md
index 429769c..f173e61 100644
--- a/docs/TemplateResponseDocumentFormFieldSignature.md
+++ b/docs/TemplateResponseDocumentFormFieldSignature.md
@@ -13,8 +13,7 @@ Name | Type | Description | Notes
**Width** | **int** | The width in pixels of this form field. | [optional]
**Height** | **int** | The height in pixels of this form field. | [optional]
**Required** | **bool** | Boolean showing whether or not this field is required. | [optional]
-**Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | [optional]
-**Type** | **string** | The type of this form field. See [field types](/api/reference/constants/#field-types).
* Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to "signature"]
+**Type** | **string** | The type of this form field. See [field types](/api/reference/constants/#field-types).
* Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to "signature"]**Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
diff --git a/docs/TemplateResponseDocumentFormFieldText.md b/docs/TemplateResponseDocumentFormFieldText.md
index 9bcc478..368fec8 100644
--- a/docs/TemplateResponseDocumentFormFieldText.md
+++ b/docs/TemplateResponseDocumentFormFieldText.md
@@ -13,8 +13,7 @@ Name | Type | Description | Notes
**Width** | **int** | The width in pixels of this form field. | [optional]
**Height** | **int** | The height in pixels of this form field. | [optional]
**Required** | **bool** | Boolean showing whether or not this field is required. | [optional]
-**Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | [optional]
-**Type** | **string** | The type of this form field. See [field types](/api/reference/constants/#field-types).
* Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to "text"]**AvgTextLength** | [**TemplateResponseFieldAvgTextLength**](TemplateResponseFieldAvgTextLength.md) | | [optional] **IsMultiline** | **bool** | Whether this form field is multiline text. | [optional] **OriginalFontSize** | **int** | Original font size used in this form field's text. | [optional] **FontFamily** | **string** | Font family used in this form field's text. | [optional] **ValidationType** | **string** | Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values. | [optional]
+**Type** | **string** | The type of this form field. See [field types](/api/reference/constants/#field-types).
* Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to "text"]**AvgTextLength** | [**TemplateResponseFieldAvgTextLength**](TemplateResponseFieldAvgTextLength.md) | | [optional] **IsMultiline** | **bool** | Whether this form field is multiline text. | [optional] **OriginalFontSize** | **int** | Original font size used in this form field's text. | [optional] **FontFamily** | **string** | Font family used in this form field's text. | [optional] **ValidationType** | **string** | Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values. | [optional] **Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
diff --git a/examples/FaxDelete.cs b/examples/FaxDelete.cs
new file mode 100644
index 0000000..88a6ed0
--- /dev/null
+++ b/examples/FaxDelete.cs
@@ -0,0 +1,28 @@
+using System;
+using System.Collections.Generic;
+using System.IO;
+using Dropbox.Sign.Api;
+using Dropbox.Sign.Client;
+using Dropbox.Sign.Model;
+
+public class Example
+{
+ public static void Main()
+ {
+ var config = new Configuration();
+ config.Username = "YOUR_API_KEY";
+
+ var faxApi = new FaxApi(config);
+
+ try
+ {
+ faxApi.FaxDelete("fa5c8a0b0f492d768749333ad6fcc214c111e967");
+ }
+ catch (ApiException e)
+ {
+ Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message);
+ Console.WriteLine("Status Code: " + e.ErrorCode);
+ Console.WriteLine(e.StackTrace);
+ }
+ }
+}
diff --git a/examples/FaxFiles.cs b/examples/FaxFiles.cs
new file mode 100644
index 0000000..fbaf416
--- /dev/null
+++ b/examples/FaxFiles.cs
@@ -0,0 +1,34 @@
+using System;
+using System.Collections.Generic;
+using System.IO;
+using Dropbox.Sign.Api;
+using Dropbox.Sign.Client;
+using Dropbox.Sign.Model;
+
+public class Example
+{
+ public static void Main()
+ {
+ var config = new Configuration();
+ config.Username = "YOUR_API_KEY";
+
+ var faxApi = new FaxApi(config);
+
+ var faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967";
+
+ try
+ {
+ var result = faxApi.FaxFiles(faxId);
+ var fileStream = File.Create("file_response.pdf");
+ result.Seek(0, SeekOrigin.Begin);
+ result.CopyTo(fileStream);
+ fileStream.Close();
+ }
+ catch (ApiException e)
+ {
+ Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message);
+ Console.WriteLine("Status Code: " + e.ErrorCode);
+ Console.WriteLine(e.StackTrace);
+ }
+ }
+}
diff --git a/examples/FaxGet.cs b/examples/FaxGet.cs
new file mode 100644
index 0000000..6396e0c
--- /dev/null
+++ b/examples/FaxGet.cs
@@ -0,0 +1,31 @@
+using System;
+
+using Dropbox.Sign.Api;
+using Dropbox.Sign.Client;
+using Dropbox.Sign.Model;
+
+public class Example
+{
+ public static void Main()
+ {
+ var config = new Configuration();
+ // Configure HTTP basic authorization: api_key
+ config.Username = "YOUR_API_KEY";
+
+ var faxApi = new FaxApi(config);
+
+ var faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967";
+
+ try
+ {
+ var result = faxApi.FaxGet(faxId);
+ Console.WriteLine(result);
+ }
+ catch (ApiException e)
+ {
+ Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message);
+ Console.WriteLine("Status Code: " + e.ErrorCode);
+ Console.WriteLine(e.StackTrace);
+ }
+ }
+}
diff --git a/examples/FaxList.cs b/examples/FaxList.cs
new file mode 100644
index 0000000..f87d9b8
--- /dev/null
+++ b/examples/FaxList.cs
@@ -0,0 +1,32 @@
+using System;
+
+using Dropbox.Sign.Api;
+using Dropbox.Sign.Client;
+using Dropbox.Sign.Model;
+
+public class Example
+{
+ public static void Main()
+ {
+ var config = new Configuration();
+ // Configure HTTP basic authorization: api_key
+ config.Username = "YOUR_API_KEY";
+
+ var faxApi = new FaxApi(config);
+
+ var page = 1;
+ var pageSize = 2;
+
+ try
+ {
+ var result = faxApi.FaxList(page, pageSize);
+ Console.WriteLine(result);
+ }
+ catch (ApiException e)
+ {
+ Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message);
+ Console.WriteLine("Status Code: " + e.ErrorCode);
+ Console.WriteLine(e.StackTrace);
+ }
+ }
+}
diff --git a/examples/FaxSend.cs b/examples/FaxSend.cs
new file mode 100644
index 0000000..8e72a4f
--- /dev/null
+++ b/examples/FaxSend.cs
@@ -0,0 +1,49 @@
+using System;
+using System.Collections.Generic;
+using System.IO;
+using Dropbox.Sign.Api;
+using Dropbox.Sign.Client;
+using Dropbox.Sign.Model;
+
+public class Example
+{
+ public static void Main()
+ {
+ var config = new Configuration();
+ config.Username = "YOUR_API_KEY";
+
+ var faxApi = new FaxApi(config);
+
+ var files = new List {
+ new FileStream(
+ "./example_fax.pdf",
+ FileMode.Open,
+ FileAccess.Read,
+ FileShare.Read
+ )
+ };
+
+ var data = new FaxSendRequest(
+ files: files,
+ testMode: true,
+ recipient: "16690000001",
+ sender: "16690000000",
+ coverPageTo: "Jill Fax",
+ coverPageMessage: "I'm sending you a fax!",
+ coverPageFrom: "Faxer Faxerson",
+ title: "This is what the fax is about!",
+ );
+
+ try
+ {
+ var result = faxApi.FaxSend(data);
+ Console.WriteLine(result);
+ }
+ catch (ApiException e)
+ {
+ Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message);
+ Console.WriteLine("Status Code: " + e.ErrorCode);
+ Console.WriteLine(e.StackTrace);
+ }
+ }
+}
diff --git a/openapi-config.yaml b/openapi-config.yaml
index be16c6f..b3dd5d6 100644
--- a/openapi-config.yaml
+++ b/openapi-config.yaml
@@ -6,7 +6,7 @@ additionalProperties:
packageCompany: Dropbox Sign API Team
packageCopyright: Dropbox 2024
packageDescription: Client library for using the Dropbox Sign API
- packageVersion: 1.6.1
+ packageVersion: 1.7.0
packageTitle: Dropbox Sign .Net SDK
sortModelPropertiesByRequiredFlag: true
optionalEmitDefaultValues: true
diff --git a/openapi-sdk.yaml b/openapi-sdk.yaml
index c7189fd..fe81aca 100644
--- a/openapi-sdk.yaml
+++ b/openapi-sdk.yaml
@@ -1409,6 +1409,304 @@ paths:
seo:
title: 'Get Embedded Sign URL | iFrame | Dropbox Sign for Developers'
description: 'The Dropbox Sign API allows you to build custom integrations. To find out how to retrieve an embedded iFrame object containing a signature url, click here.'
+ '/fax/{fax_id}':
+ get:
+ tags:
+ - Fax
+ summary: 'Get Fax'
+ description: 'Returns information about fax'
+ operationId: faxGet
+ parameters:
+ -
+ name: fax_id
+ in: path
+ description: 'Fax ID'
+ required: true
+ schema:
+ type: string
+ example: fa5c8a0b0f492d768749333ad6fcc214c111e967
+ responses:
+ 200:
+ description: 'successful operation'
+ headers:
+ X-RateLimit-Limit:
+ $ref: '#/components/headers/X-RateLimit-Limit'
+ X-RateLimit-Remaining:
+ $ref: '#/components/headers/X-RateLimit-Remaining'
+ X-Ratelimit-Reset:
+ $ref: '#/components/headers/X-Ratelimit-Reset'
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/FaxGetResponse'
+ examples:
+ default_example:
+ $ref: '#/components/examples/FaxGetResponseExample'
+ 4XX:
+ description: failed_operation
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ examples:
+ 400_example:
+ $ref: '#/components/examples/Error400ResponseExample'
+ 401_example:
+ $ref: '#/components/examples/Error401ResponseExample'
+ 402_example:
+ $ref: '#/components/examples/Error402ResponseExample'
+ 403_example:
+ $ref: '#/components/examples/Error403ResponseExample'
+ 404_example:
+ $ref: '#/components/examples/Error404ResponseExample'
+ 429_example:
+ $ref: '#/components/examples/Error429ResponseExample'
+ 4XX_example:
+ $ref: '#/components/examples/Error4XXResponseExample'
+ security:
+ -
+ api_key: []
+ x-codeSamples:
+ -
+ lang: PHP
+ label: PHP
+ source:
+ $ref: examples/FaxGet.php
+ -
+ lang: 'C#'
+ label: 'C#'
+ source:
+ $ref: examples/FaxGet.cs
+ -
+ lang: JavaScript
+ label: JavaScript
+ source:
+ $ref: examples/FaxGet.js
+ -
+ lang: TypeScript
+ label: TypeScript
+ source:
+ $ref: examples/FaxGet.ts
+ -
+ lang: Java
+ label: Java
+ source:
+ $ref: examples/FaxGet.java
+ -
+ lang: Ruby
+ label: Ruby
+ source:
+ $ref: examples/FaxGet.rb
+ -
+ lang: Python
+ label: Python
+ source:
+ $ref: examples/FaxGet.py
+ -
+ lang: cURL
+ label: cURL
+ source:
+ $ref: examples/FaxGet.sh
+ x-meta:
+ seo:
+ title: 'Get Fax | API Documentation | Dropbox Fax for Developers'
+ description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to retrieve a fax, click here.'
+ delete:
+ tags:
+ - Fax
+ summary: 'Delete Fax'
+ description: 'Deletes the specified Fax from the system.'
+ operationId: faxDelete
+ parameters:
+ -
+ name: fax_id
+ in: path
+ description: 'Fax ID'
+ required: true
+ schema:
+ type: string
+ example: fa5c8a0b0f492d768749333ad6fcc214c111e967
+ responses:
+ 204:
+ description: 'successful operation'
+ headers:
+ X-RateLimit-Limit:
+ $ref: '#/components/headers/X-RateLimit-Limit'
+ X-RateLimit-Remaining:
+ $ref: '#/components/headers/X-RateLimit-Remaining'
+ X-Ratelimit-Reset:
+ $ref: '#/components/headers/X-Ratelimit-Reset'
+ 4XX:
+ description: failed_operation
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ examples:
+ 400_example:
+ $ref: '#/components/examples/Error400ResponseExample'
+ 401_example:
+ $ref: '#/components/examples/Error401ResponseExample'
+ 402_example:
+ $ref: '#/components/examples/Error402ResponseExample'
+ 403_example:
+ $ref: '#/components/examples/Error403ResponseExample'
+ 404_example:
+ $ref: '#/components/examples/Error404ResponseExample'
+ 429_example:
+ $ref: '#/components/examples/Error429ResponseExample'
+ 4XX_example:
+ $ref: '#/components/examples/Error4XXResponseExample'
+ security:
+ -
+ api_key: []
+ x-codeSamples:
+ -
+ lang: PHP
+ label: PHP
+ source:
+ $ref: examples/FaxDelete.php
+ -
+ lang: 'C#'
+ label: 'C#'
+ source:
+ $ref: examples/FaxDelete.cs
+ -
+ lang: JavaScript
+ label: JavaScript
+ source:
+ $ref: examples/FaxDelete.js
+ -
+ lang: TypeScript
+ label: TypeScript
+ source:
+ $ref: examples/FaxDelete.ts
+ -
+ lang: Java
+ label: Java
+ source:
+ $ref: examples/FaxDelete.java
+ -
+ lang: Ruby
+ label: Ruby
+ source:
+ $ref: examples/FaxDelete.rb
+ -
+ lang: Python
+ label: Python
+ source:
+ $ref: examples/FaxDelete.py
+ -
+ lang: cURL
+ label: cURL
+ source:
+ $ref: examples/FaxDelete.sh
+ x-meta:
+ seo:
+ title: 'Delete Fax | API Documentation | Dropbox Fax for Developers'
+ description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to delete a fax, click here.'
+ '/fax/files/{fax_id}':
+ get:
+ tags:
+ - Fax
+ summary: 'List Fax Files'
+ description: 'Returns list of fax files'
+ operationId: faxFiles
+ parameters:
+ -
+ name: fax_id
+ in: path
+ description: 'Fax ID'
+ required: true
+ schema:
+ type: string
+ example: fa5c8a0b0f492d768749333ad6fcc214c111e967
+ responses:
+ 200:
+ description: 'successful operation'
+ headers:
+ X-RateLimit-Limit:
+ $ref: '#/components/headers/X-RateLimit-Limit'
+ X-RateLimit-Remaining:
+ $ref: '#/components/headers/X-RateLimit-Remaining'
+ X-Ratelimit-Reset:
+ $ref: '#/components/headers/X-Ratelimit-Reset'
+ content:
+ application/pdf:
+ schema:
+ type: string
+ format: binary
+ 4XX:
+ description: failed_operation
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ examples:
+ 400_example:
+ $ref: '#/components/examples/Error400ResponseExample'
+ 401_example:
+ $ref: '#/components/examples/Error401ResponseExample'
+ 402_example:
+ $ref: '#/components/examples/Error402ResponseExample'
+ 403_example:
+ $ref: '#/components/examples/Error403ResponseExample'
+ 404_example:
+ $ref: '#/components/examples/Error404ResponseExample'
+ 410_example:
+ $ref: '#/components/examples/Error410ResponseExample'
+ 429_example:
+ $ref: '#/components/examples/Error429ResponseExample'
+ 4XX_example:
+ $ref: '#/components/examples/Error4XXResponseExample'
+ security:
+ -
+ api_key: []
+ x-codeSamples:
+ -
+ lang: PHP
+ label: PHP
+ source:
+ $ref: examples/FaxFiles.php
+ -
+ lang: 'C#'
+ label: 'C#'
+ source:
+ $ref: examples/FaxFiles.cs
+ -
+ lang: JavaScript
+ label: JavaScript
+ source:
+ $ref: examples/FaxFiles.js
+ -
+ lang: TypeScript
+ label: TypeScript
+ source:
+ $ref: examples/FaxFiles.ts
+ -
+ lang: Java
+ label: Java
+ source:
+ $ref: examples/FaxFiles.java
+ -
+ lang: Ruby
+ label: Ruby
+ source:
+ $ref: examples/FaxFiles.rb
+ -
+ lang: Python
+ label: Python
+ source:
+ $ref: examples/FaxFiles.py
+ -
+ lang: cURL
+ label: cURL
+ source:
+ $ref: examples/FaxFiles.sh
+ x-meta:
+ seo:
+ title: 'Fax Files | API Documentation | Dropbox Fax for Developers'
+ description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to list fax files, click here.'
/fax_line/add_user:
put:
tags:
@@ -1977,31 +2275,243 @@ paths:
lang: Python
label: Python
source:
- $ref: examples/FaxLineDelete.py
+ $ref: examples/FaxLineDelete.py
+ -
+ lang: cURL
+ label: cURL
+ source:
+ $ref: examples/FaxLineDelete.sh
+ x-meta:
+ seo:
+ title: 'Delete Fax Line | API Documentation | Dropbox Fax for Developers'
+ description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to delete a fax line, click here.'
+ /fax_line/list:
+ get:
+ tags:
+ - 'Fax Line'
+ summary: 'List Fax Lines'
+ description: 'Returns the properties and settings of multiple Fax Lines.'
+ operationId: faxLineList
+ parameters:
+ -
+ name: account_id
+ in: query
+ description: 'Account ID'
+ schema:
+ type: string
+ example: ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97
+ -
+ name: page
+ in: query
+ description: Page
+ schema:
+ type: integer
+ default: 1
+ example: 1
+ -
+ name: page_size
+ in: query
+ description: 'Page size'
+ schema:
+ type: integer
+ default: 20
+ example: 20
+ -
+ name: show_team_lines
+ in: query
+ description: 'Show team lines'
+ schema:
+ type: boolean
+ responses:
+ 200:
+ description: 'successful operation'
+ headers:
+ X-RateLimit-Limit:
+ $ref: '#/components/headers/X-RateLimit-Limit'
+ X-RateLimit-Remaining:
+ $ref: '#/components/headers/X-RateLimit-Remaining'
+ X-Ratelimit-Reset:
+ $ref: '#/components/headers/X-Ratelimit-Reset'
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/FaxLineListResponse'
+ examples:
+ default_example:
+ $ref: '#/components/examples/FaxLineListResponseExample'
+ 4XX:
+ description: failed_operation
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ examples:
+ 400_example:
+ $ref: '#/components/examples/Error400ResponseExample'
+ 401_example:
+ $ref: '#/components/examples/Error401ResponseExample'
+ 402_example:
+ $ref: '#/components/examples/Error402ResponseExample'
+ 403_example:
+ $ref: '#/components/examples/Error403ResponseExample'
+ 4XX_example:
+ $ref: '#/components/examples/Error4XXResponseExample'
+ security:
+ -
+ api_key: []
+ x-codeSamples:
+ -
+ lang: PHP
+ label: PHP
+ source:
+ $ref: examples/FaxLineList.php
+ -
+ lang: 'C#'
+ label: 'C#'
+ source:
+ $ref: examples/FaxLineList.cs
+ -
+ lang: JavaScript
+ label: JavaScript
+ source:
+ $ref: examples/FaxLineList.js
+ -
+ lang: TypeScript
+ label: TypeScript
+ source:
+ $ref: examples/FaxLineList.ts
+ -
+ lang: Java
+ label: Java
+ source:
+ $ref: examples/FaxLineList.java
+ -
+ lang: Ruby
+ label: Ruby
+ source:
+ $ref: examples/FaxLineList.rb
+ -
+ lang: Python
+ label: Python
+ source:
+ $ref: examples/FaxLineList.py
+ -
+ lang: cURL
+ label: cURL
+ source:
+ $ref: examples/FaxLineList.sh
+ x-meta:
+ seo:
+ title: 'List Fax Lines | API Documentation | Dropbox Fax for Developers'
+ description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to list your fax lines, click here.'
+ /fax_line/remove_user:
+ put:
+ tags:
+ - 'Fax Line'
+ summary: 'Remove Fax Line Access'
+ description: 'Removes a user''s access to the specified Fax Line.'
+ operationId: faxLineRemoveUser
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/FaxLineRemoveUserRequest'
+ examples:
+ default_example:
+ $ref: '#/components/examples/FaxLineRemoveUserRequestExample'
+ responses:
+ 200:
+ description: 'successful operation'
+ headers:
+ X-RateLimit-Limit:
+ $ref: '#/components/headers/X-RateLimit-Limit'
+ X-RateLimit-Remaining:
+ $ref: '#/components/headers/X-RateLimit-Remaining'
+ X-Ratelimit-Reset:
+ $ref: '#/components/headers/X-Ratelimit-Reset'
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/FaxLineResponse'
+ examples:
+ default_example:
+ $ref: '#/components/examples/FaxLineResponseExample'
+ 4XX:
+ description: failed_operation
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ examples:
+ 400_example:
+ $ref: '#/components/examples/Error400ResponseExample'
+ 401_example:
+ $ref: '#/components/examples/Error401ResponseExample'
+ 402_example:
+ $ref: '#/components/examples/Error402ResponseExample'
+ 403_example:
+ $ref: '#/components/examples/Error403ResponseExample'
+ 404_example:
+ $ref: '#/components/examples/Error404ResponseExample'
+ 4XX_example:
+ $ref: '#/components/examples/Error4XXResponseExample'
+ security:
+ -
+ api_key: []
+ x-codeSamples:
+ -
+ lang: PHP
+ label: PHP
+ source:
+ $ref: examples/FaxLineRemoveUser.php
+ -
+ lang: 'C#'
+ label: 'C#'
+ source:
+ $ref: examples/FaxLineRemoveUser.cs
+ -
+ lang: JavaScript
+ label: JavaScript
+ source:
+ $ref: examples/FaxLineRemoveUser.js
+ -
+ lang: TypeScript
+ label: TypeScript
+ source:
+ $ref: examples/FaxLineRemoveUser.ts
+ -
+ lang: Java
+ label: Java
+ source:
+ $ref: examples/FaxLineRemoveUser.java
+ -
+ lang: Ruby
+ label: Ruby
+ source:
+ $ref: examples/FaxLineRemoveUser.rb
+ -
+ lang: Python
+ label: Python
+ source:
+ $ref: examples/FaxLineRemoveUser.py
-
lang: cURL
label: cURL
source:
- $ref: examples/FaxLineDelete.sh
+ $ref: examples/FaxLineRemoveUser.sh
x-meta:
seo:
- title: 'Delete Fax Line | API Documentation | Dropbox Fax for Developers'
- description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to delete a fax line, click here.'
- /fax_line/list:
+ title: 'Fax Line Remove User | API Documentation | Dropbox Fax for Developers'
+ description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to remove a user from an existing fax line, click here.'
+ /fax/list:
get:
tags:
- - 'Fax Line'
- summary: 'List Fax Lines'
- description: 'Returns the properties and settings of multiple Fax Lines.'
- operationId: faxLineList
+ - Fax
+ summary: 'Lists Faxes'
+ description: 'Returns properties of multiple faxes'
+ operationId: faxList
parameters:
- -
- name: account_id
- in: query
- description: 'Account ID'
- schema:
- type: string
- example: ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97
-
name: page
in: query
@@ -2009,6 +2519,7 @@ paths:
schema:
type: integer
default: 1
+ minimum: 1
example: 1
-
name: page_size
@@ -2017,13 +2528,9 @@ paths:
schema:
type: integer
default: 20
+ maximum: 100
+ minimum: 1
example: 20
- -
- name: show_team_lines
- in: query
- description: 'Show team lines'
- schema:
- type: boolean
responses:
200:
description: 'successful operation'
@@ -2037,10 +2544,10 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/FaxLineListResponse'
+ $ref: '#/components/schemas/FaxListResponse'
examples:
default_example:
- $ref: '#/components/examples/FaxLineListResponseExample'
+ $ref: '#/components/examples/FaxListResponseExample'
4XX:
description: failed_operation
content:
@@ -2066,62 +2573,65 @@ paths:
lang: PHP
label: PHP
source:
- $ref: examples/FaxLineList.php
+ $ref: examples/FaxList.php
-
lang: 'C#'
label: 'C#'
source:
- $ref: examples/FaxLineList.cs
+ $ref: examples/FaxList.cs
-
lang: JavaScript
label: JavaScript
source:
- $ref: examples/FaxLineList.js
+ $ref: examples/FaxList.js
-
lang: TypeScript
label: TypeScript
source:
- $ref: examples/FaxLineList.ts
+ $ref: examples/FaxList.ts
-
lang: Java
label: Java
source:
- $ref: examples/FaxLineList.java
+ $ref: examples/FaxList.java
-
lang: Ruby
label: Ruby
source:
- $ref: examples/FaxLineList.rb
+ $ref: examples/FaxList.rb
-
lang: Python
label: Python
source:
- $ref: examples/FaxLineList.py
+ $ref: examples/FaxList.py
-
lang: cURL
label: cURL
source:
- $ref: examples/FaxLineList.sh
+ $ref: examples/FaxList.sh
x-meta:
seo:
- title: 'List Fax Lines | API Documentation | Dropbox Fax for Developers'
- description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to list your fax lines, click here.'
- /fax_line/remove_user:
- put:
+ title: 'List Faxes | API Documentation | Dropbox Fax for Developers'
+ description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to list your faxes, click here.'
+ /fax/send:
+ post:
tags:
- - 'Fax Line'
- summary: 'Remove Fax Line Access'
- description: 'Removes a user''s access to the specified Fax Line.'
- operationId: faxLineRemoveUser
+ - Fax
+ summary: 'Send Fax'
+ description: 'Action to prepare and send a fax'
+ operationId: faxSend
requestBody:
required: true
content:
application/json:
schema:
- $ref: '#/components/schemas/FaxLineRemoveUserRequest'
+ $ref: '#/components/schemas/FaxSendRequest'
examples:
default_example:
- $ref: '#/components/examples/FaxLineRemoveUserRequestExample'
+ $ref: '#/components/examples/FaxSendRequestExample'
+ multipart/form-data:
+ schema:
+ $ref: '#/components/schemas/FaxSendRequest'
responses:
200:
description: 'successful operation'
@@ -2135,10 +2645,10 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/FaxLineResponse'
+ $ref: '#/components/schemas/FaxGetResponse'
examples:
default_example:
- $ref: '#/components/examples/FaxLineResponseExample'
+ $ref: '#/components/examples/FaxGetResponseExample'
4XX:
description: failed_operation
content:
@@ -2156,6 +2666,8 @@ paths:
$ref: '#/components/examples/Error403ResponseExample'
404_example:
$ref: '#/components/examples/Error404ResponseExample'
+ 429_example:
+ $ref: '#/components/examples/Error429ResponseExample'
4XX_example:
$ref: '#/components/examples/Error4XXResponseExample'
security:
@@ -2166,46 +2678,46 @@ paths:
lang: PHP
label: PHP
source:
- $ref: examples/FaxLineRemoveUser.php
+ $ref: examples/FaxSend.php
-
lang: 'C#'
label: 'C#'
source:
- $ref: examples/FaxLineRemoveUser.cs
+ $ref: examples/FaxSend.cs
-
lang: JavaScript
label: JavaScript
source:
- $ref: examples/FaxLineRemoveUser.js
+ $ref: examples/FaxSend.js
-
lang: TypeScript
label: TypeScript
source:
- $ref: examples/FaxLineRemoveUser.ts
+ $ref: examples/FaxSend.ts
-
lang: Java
label: Java
source:
- $ref: examples/FaxLineRemoveUser.java
+ $ref: examples/FaxSend.java
-
lang: Ruby
label: Ruby
source:
- $ref: examples/FaxLineRemoveUser.rb
+ $ref: examples/FaxSend.rb
-
lang: Python
label: Python
source:
- $ref: examples/FaxLineRemoveUser.py
+ $ref: examples/FaxSend.py
-
lang: cURL
label: cURL
source:
- $ref: examples/FaxLineRemoveUser.sh
+ $ref: examples/FaxSend.sh
x-meta:
seo:
- title: 'Fax Line Remove User | API Documentation | Dropbox Fax for Developers'
- description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to remove a user from an existing fax line, click here.'
+ title: 'Send Fax| API Documentation | Dropbox Fax for Developers'
+ description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to send a fax, click here.'
/oauth/token:
post:
tags:
@@ -2239,6 +2751,23 @@ paths:
examples:
default_example:
$ref: '#/components/examples/OAuthTokenGenerateResponseExample'
+ 4XX:
+ description: failed_operation
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ examples:
+ 400_example:
+ $ref: '#/components/examples/Error400ResponseExample'
+ 401_example:
+ $ref: '#/components/examples/Error401ResponseExample'
+ 402_example:
+ $ref: '#/components/examples/Error402ResponseExample'
+ 403_example:
+ $ref: '#/components/examples/Error403ResponseExample'
+ 4XX_example:
+ $ref: '#/components/examples/Error4XXResponseExample'
security: []
servers:
-
@@ -2322,6 +2851,23 @@ paths:
examples:
default_example:
$ref: '#/components/examples/OAuthTokenRefreshResponseExample'
+ 4XX:
+ description: failed_operation
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ examples:
+ 400_example:
+ $ref: '#/components/examples/Error400ResponseExample'
+ 401_example:
+ $ref: '#/components/examples/Error401ResponseExample'
+ 402_example:
+ $ref: '#/components/examples/Error402ResponseExample'
+ 403_example:
+ $ref: '#/components/examples/Error403ResponseExample'
+ 4XX_example:
+ $ref: '#/components/examples/Error4XXResponseExample'
security: []
servers:
-
@@ -2703,7 +3249,7 @@ paths:
The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued.
- This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary.
+ This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary.
To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled.
@@ -4617,7 +5163,7 @@ paths:
403_example:
$ref: '#/components/examples/Error403ResponseExample'
404_example:
- $ref: '#/components/examples/TeamDoesNotExistResponseExample'
+ $ref: '#/components/examples/Error404ResponseExample'
4XX_example:
$ref: '#/components/examples/Error4XXResponseExample'
security:
@@ -5440,7 +5986,7 @@ paths:
post:
tags:
- Template
- summary: 'Create Template'
+ summary: 'Create Template'
description: 'Creates a template that can then be used.'
operationId: templateCreate
requestBody:
@@ -7345,6 +7891,50 @@ components:
type: string
format: email
type: object
+ FaxSendRequest:
+ required:
+ - recipient
+ properties:
+ recipient:
+ description: 'Fax Send To Recipient'
+ type: string
+ example: recipient@example.com
+ sender:
+ description: 'Fax Send From Sender (used only with fax number)'
+ type: string
+ example: sender@example.com
+ files:
+ description: 'Fax File to Send'
+ type: array
+ items:
+ type: string
+ format: binary
+ file_urls:
+ description: 'Fax File URL to Send'
+ type: array
+ items:
+ type: string
+ test_mode:
+ description: 'API Test Mode Setting'
+ type: boolean
+ default: false
+ cover_page_to:
+ description: 'Fax Cover Page for Recipient'
+ type: string
+ example: 'Recipient Name'
+ cover_page_from:
+ description: 'Fax Cover Page for Sender'
+ type: string
+ example: 'Sender Name'
+ cover_page_message:
+ description: 'Fax Cover Page Message'
+ type: string
+ example: 'Please find the attached documents.'
+ title:
+ description: 'Fax Title'
+ type: string
+ example: 'Fax Title'
+ type: object
OAuthTokenGenerateRequest:
required:
- client_id
@@ -7382,6 +7972,12 @@ components:
refresh_token:
description: 'The token provided when you got the expired access token.'
type: string
+ client_id:
+ description: 'The client ID for your API app. Mandatory from August 1st, 2025. Until then, required if the "Client Credentials Required" setting is enabled for token refresh; optional if disabled.'
+ type: string
+ client_secret:
+ description: 'The client secret for your API app. Mandatory from August 1st, 2025. Until then, required if the "Client Credentials Required" setting is enabled for token refresh; optional if disabled.'
+ type: string
type: object
ReportCreateRequest:
required:
@@ -9091,7 +9687,7 @@ components:
properties:
header_background_color:
type: string
- default: '#1A1A1A'
+ default: '#1a1a1a'
legal_version:
type: string
default: terms1
@@ -9100,40 +9696,40 @@ components:
- terms2
link_color:
type: string
- default: '#00B3E6'
+ default: '#0061FE'
page_background_color:
type: string
- default: '#F7F8F9'
+ default: '#f7f8f9'
primary_button_color:
type: string
- default: '#00B3E6'
+ default: '#0061FE'
primary_button_color_hover:
type: string
- default: '#00B3E6'
+ default: '#0061FE'
primary_button_text_color:
type: string
- default: '#FFFFFF'
+ default: '#ffffff'
primary_button_text_color_hover:
type: string
- default: '#FFFFFF'
+ default: '#ffffff'
secondary_button_color:
type: string
- default: '#FFFFFF'
+ default: '#ffffff'
secondary_button_color_hover:
type: string
- default: '#FFFFFF'
+ default: '#ffffff'
secondary_button_text_color:
type: string
- default: '#00B3E6'
+ default: '#0061FE'
secondary_button_text_color_hover:
type: string
- default: '#00B3E6'
+ default: '#0061FE'
text_color1:
type: string
default: '#808080'
text_color2:
type: string
- default: '#FFFFFF'
+ default: '#ffffff'
reset_to_default:
description: 'Resets white labeling options to defaults. Only useful when updating an API App.'
type: boolean
@@ -10211,6 +10807,19 @@ components:
error:
$ref: '#/components/schemas/ErrorResponseError'
type: object
+ FaxGetResponse:
+ required:
+ - fax
+ properties:
+ fax:
+ $ref: '#/components/schemas/FaxResponse'
+ warnings:
+ description: 'A list of warnings.'
+ type: array
+ items:
+ $ref: '#/components/schemas/WarningResponse'
+ type: object
+ x-internal-class: true
FaxLineResponse:
required:
- fax_line
@@ -10246,6 +10855,19 @@ components:
$ref: '#/components/schemas/WarningResponse'
type: object
x-internal-class: true
+ FaxListResponse:
+ required:
+ - faxes
+ - list_info
+ properties:
+ faxes:
+ type: array
+ items:
+ $ref: '#/components/schemas/FaxResponse'
+ list_info:
+ $ref: '#/components/schemas/ListInfoResponse'
+ type: object
+ x-internal-class: true
FileResponse:
required:
- file_url
@@ -10388,7 +11010,7 @@ components:
type: integer
nullable: true
sms_verifications_left:
- description: 'SMS verifications remaining.'
+ description: 'SMS verifications remaining.'
type: integer
nullable: true
num_fax_pages_left:
@@ -10456,6 +11078,7 @@ components:
secret:
description: 'The app''s OAuth secret, or null if the app does not belong to user.'
type: string
+ nullable: true
scopes:
description: 'Array of OAuth scopes used by the app.'
type: array
@@ -10589,6 +11212,54 @@ components:
description: 'Name of the error.'
type: string
type: object
+ FaxResponse:
+ required:
+ - fax_id
+ - title
+ - original_title
+ - subject
+ - message
+ - metadata
+ - created_at
+ - sender
+ - transmissions
+ - files_url
+ properties:
+ fax_id:
+ description: 'Fax ID'
+ type: string
+ title:
+ description: 'Fax Title'
+ type: string
+ original_title:
+ description: 'Fax Original Title'
+ type: string
+ subject:
+ description: 'Fax Subject'
+ type: string
+ message:
+ description: 'Fax Message'
+ type: string
+ metadata:
+ description: 'Fax Metadata'
+ type: object
+ additionalProperties: {}
+ created_at:
+ description: 'Fax Created At Timestamp'
+ type: integer
+ sender:
+ description: 'Fax Sender Email'
+ type: string
+ transmissions:
+ description: 'Fax Transmissions List'
+ type: array
+ items:
+ $ref: '#/components/schemas/FaxResponseTransmission'
+ files_url:
+ description: 'Fax Files URL'
+ type: string
+ type: object
+ x-internal-class: true
FaxLineResponseFaxLine:
properties:
number:
@@ -10606,6 +11277,35 @@ components:
$ref: '#/components/schemas/AccountResponse'
type: object
x-internal-class: true
+ FaxResponseTransmission:
+ required:
+ - recipient
+ - sender
+ - status_code
+ properties:
+ recipient:
+ description: 'Fax Transmission Recipient'
+ type: string
+ sender:
+ description: 'Fax Transmission Sender'
+ type: string
+ status_code:
+ description: 'Fax Transmission Status Code'
+ type: string
+ enum:
+ - success
+ - transmitting
+ - error_could_not_fax
+ - error_unknown
+ - error_busy
+ - error_no_answer
+ - error_disconnected
+ - error_bad_destination
+ sent_at:
+ description: 'Fax Transmission Sent Timestamp'
+ type: integer
+ type: object
+ x-internal-class: true
ListInfoResponse:
description: 'Contains pagination information about the data returned.'
properties:
@@ -11218,24 +11918,21 @@ components:
description: 'Time the template was last updated.'
type: integer
is_embedded:
- description: '`true` if this template was created using an embedded flow, `false` if it was created on our website.'
+ description: '`true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template.'
type: boolean
nullable: true
is_creator:
description: '`true` if you are the owner of this template, `false` if it''s been shared with you by a team member.'
type: boolean
- nullable: true
can_edit:
description: 'Indicates whether edit rights have been granted to you by the owner (always `true` if that''s you).'
type: boolean
- nullable: true
is_locked:
description: |-
Indicates whether the template is locked.
If `true`, then the template was created outside your quota and can only be used in `test_mode`.
If `false`, then the template is within your quota and can be used to create signature requests.
type: boolean
- nullable: true
metadata:
description: 'The metadata attached to the template.'
type: object
@@ -11273,7 +11970,11 @@ components:
type: array
items:
$ref: '#/components/schemas/TemplateResponseAccount'
- nullable: true
+ attachments:
+ description: 'Signer attachments.'
+ type: array
+ items:
+ $ref: '#/components/schemas/SignatureRequestResponseAttachment'
type: object
x-internal-class: true
TemplateResponseAccount:
@@ -11377,7 +12078,6 @@ components:
type: array
items:
$ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
- nullable: true
type: object
x-internal-class: true
TemplateResponseDocumentCustomFieldBase:
@@ -11529,10 +12229,6 @@ components:
required:
description: 'Boolean showing whether or not this field is required.'
type: boolean
- group:
- description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.'
- type: string
- nullable: true
type: object
discriminator:
propertyName: type
@@ -11549,12 +12245,12 @@ components:
x-base-class: true
TemplateResponseDocumentFormFieldCheckbox:
description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
+ required:
+ - type
allOf:
-
$ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
-
- required:
- - type
properties:
type:
description: |-
@@ -11570,6 +12266,10 @@ components:
* Initials Field uses `TemplateResponseDocumentFormFieldInitials`
type: string
default: checkbox
+ group:
+ description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.'
+ type: string
+ nullable: true
type: object
TemplateResponseDocumentFormFieldDateSigned:
description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
@@ -11579,8 +12279,6 @@ components:
-
$ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
-
- required:
- - type
properties:
type:
description: |-
@@ -11596,6 +12294,10 @@ components:
* Initials Field uses `TemplateResponseDocumentFormFieldInitials`
type: string
default: date_signed
+ group:
+ description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.'
+ type: string
+ nullable: true
type: object
TemplateResponseDocumentFormFieldDropdown:
description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
@@ -11605,8 +12307,6 @@ components:
-
$ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
-
- required:
- - type
properties:
type:
description: |-
@@ -11622,6 +12322,10 @@ components:
* Initials Field uses `TemplateResponseDocumentFormFieldInitials`
type: string
default: dropdown
+ group:
+ description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.'
+ type: string
+ nullable: true
type: object
TemplateResponseDocumentFormFieldHyperlink:
description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
@@ -11631,8 +12335,6 @@ components:
-
$ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
-
- required:
- - type
properties:
type:
description: |-
@@ -11659,6 +12361,10 @@ components:
fontFamily:
description: 'Font family used in this form field''s text.'
type: string
+ group:
+ description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.'
+ type: string
+ nullable: true
type: object
TemplateResponseDocumentFormFieldInitials:
description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
@@ -11668,8 +12374,6 @@ components:
-
$ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
-
- required:
- - type
properties:
type:
description: |-
@@ -11685,6 +12389,10 @@ components:
* Initials Field uses `TemplateResponseDocumentFormFieldInitials`
type: string
default: initials
+ group:
+ description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.'
+ type: string
+ nullable: true
type: object
TemplateResponseDocumentFormFieldRadio:
description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
@@ -11695,8 +12403,6 @@ components:
-
$ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
-
- required:
- - type
properties:
type:
description: |-
@@ -11712,6 +12418,9 @@ components:
* Initials Field uses `TemplateResponseDocumentFormFieldInitials`
type: string
default: radio
+ group:
+ description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.'
+ type: string
type: object
TemplateResponseDocumentFormFieldSignature:
description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
@@ -11721,8 +12430,6 @@ components:
-
$ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
-
- required:
- - type
properties:
type:
description: |-
@@ -11738,6 +12445,10 @@ components:
* Initials Field uses `TemplateResponseDocumentFormFieldInitials`
type: string
default: signature
+ group:
+ description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.'
+ type: string
+ nullable: true
type: object
TemplateResponseDocumentFormFieldText:
description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
@@ -11747,8 +12458,6 @@ components:
-
$ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
-
- required:
- - type
properties:
type:
description: |-
@@ -11790,6 +12499,10 @@ components:
- employer_identification_number
- custom_regex
nullable: true
+ group:
+ description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.'
+ type: string
+ nullable: true
type: object
TemplateResponseDocumentStaticFieldBase:
description: 'An array describing static overlay fields. **NOTE:** Only available for certain subscriptions.'
@@ -11849,8 +12562,6 @@ components:
-
$ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
-
- required:
- - type
properties:
type:
description: |-
@@ -11875,8 +12586,6 @@ components:
-
$ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
-
- required:
- - type
properties:
type:
description: |-
@@ -11901,8 +12610,6 @@ components:
-
$ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
-
- required:
- - type
properties:
type:
description: |-
@@ -11927,8 +12634,6 @@ components:
-
$ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
-
- required:
- - type
properties:
type:
description: |-
@@ -11953,8 +12658,6 @@ components:
-
$ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
-
- required:
- - type
properties:
type:
description: |-
@@ -11979,8 +12682,6 @@ components:
-
$ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
-
- required:
- - type
properties:
type:
description: |-
@@ -12005,8 +12706,6 @@ components:
-
$ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
-
- required:
- - type
properties:
type:
description: |-
@@ -12031,8 +12730,6 @@ components:
-
$ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
-
- required:
- - type
properties:
type:
description: |-
@@ -12418,6 +13115,10 @@ components:
summary: 'Default Example'
value:
$ref: examples/json/FaxLineRemoveUserRequestExample.json
+ FaxSendRequestExample:
+ summary: 'Default Example'
+ value:
+ $ref: examples/json/FaxSendRequestExample.json
OAuthTokenGenerateRequestExample:
summary: 'OAuth Token Generate Example'
value:
@@ -12662,6 +13363,10 @@ components:
summary: 'Error 4XX failed_operation'
value:
$ref: examples/json/Error4XXResponseExample.json
+ FaxGetResponseExample:
+ summary: 'Fax Response'
+ value:
+ $ref: examples/json/FaxGetResponseExample.json
FaxLineResponseExample:
summary: 'Sample Fax Line Response'
value:
@@ -12674,6 +13379,10 @@ components:
summary: 'Sample Fax Line List Response'
value:
$ref: examples/json/FaxLineListResponseExample.json
+ FaxListResponseExample:
+ summary: 'Returns the properties and settings of multiple Faxes.'
+ value:
+ $ref: examples/json/FaxListResponseExample.json
ReportCreateResponseExample:
summary: Report
value:
diff --git a/run-build b/run-build
index 808568a..8a2332a 100755
--- a/run-build
+++ b/run-build
@@ -7,6 +7,15 @@ set -e
DIR=$(cd `dirname $0` && pwd)
WORKING_DIR="/app/dotnet"
+if [[ -n "$GITHUB_ACTIONS" ]]; then
+ printf "\nLogging in to docker.com ...\n"
+ echo "${DOCKER_TOKEN}" | docker login -u "${DOCKER_USERNAME}" --password-stdin
+fi
+
+# cleanup
+rm -f "${DIR}/src/Dropbox.Sign/Api/"*.cs
+rm -f "${DIR}/src/Dropbox.Sign/Model/"*.cs
+
docker run --rm \
-v "${DIR}/:/local" \
openapitools/openapi-generator-cli:v7.8.0 generate \
diff --git a/src/Dropbox.Sign/Api/FaxApi.cs b/src/Dropbox.Sign/Api/FaxApi.cs
new file mode 100644
index 0000000..b9819df
--- /dev/null
+++ b/src/Dropbox.Sign/Api/FaxApi.cs
@@ -0,0 +1,1206 @@
+/*
+ * Dropbox Sign API
+ *
+ * Dropbox Sign v3 API
+ *
+ * The version of the OpenAPI document: 3.0.0
+ * Contact: apisupport@hellosign.com
+ * Generated by: https://github.com/openapitools/openapi-generator.git
+ */
+
+
+using System;
+using System.Collections.Generic;
+using System.Collections.ObjectModel;
+using System.Linq;
+using System.Net;
+using System.Net.Mime;
+using Dropbox.Sign.Client;
+using Dropbox.Sign.Model;
+
+namespace Dropbox.Sign.Api
+{
+
+ ///
+ /// Represents a collection of functions to interact with the API endpoints
+ ///
+ public interface IFaxApiSync : IApiAccessor
+ {
+ #region Synchronous Operations
+ ///
+ /// Delete Fax
+ ///
+ ///
+ /// Deletes the specified Fax from the system.
+ ///
+ /// Thrown when fails to make API call
+ /// Fax ID
+ /// Index associated with the operation.
+ ///
+ void FaxDelete(string faxId, int operationIndex = 0);
+
+ ///
+ /// Delete Fax
+ ///
+ ///
+ /// Deletes the specified Fax from the system.
+ ///
+ /// Thrown when fails to make API call
+ /// Fax ID
+ /// Index associated with the operation.
+ /// ApiResponse of Object(void)
+ ApiResponse